Sign in

v1

latestOpenAPI 3.0.22026-07-146168117.0 KB
Papersign Documents

This endpoint sends a document. Please note that this feature is exclusively available as part of the Papersign API.

post/papersign/documents/{id}/send

Path parameters

idstring required

The ID of the Papersign document.

Request body

expirationstring date-time

The expiration date of the document. Must be at least 30 minutes in the future.

invite_messagestring

The message to include in the invitation email.

from_user_emailstring email

The email address of a User on your teams account to send the document from. The User's name and email will appear on the notification email.

document_recipient_emailsstring[]

Example request

{
  "expiration": "2020-12-31T23:59:59Z",
  "invite_message": "Please sign this document.",
  "from_user_email": "example@paperform.co",
  "document_recipient_emails": [
    "signer@example.com"
  ],
  "automatic_reminders": {
    "first_after_days": 3,
    "follow_up_every_days": 3
  },
  "signers": [
    {
      "key": "akdj17",
      "name": "Jack Smith",
      "email": "signer@example.com",
      "phone": "123 456 7899",
      "job_title": "Account Manager",
      "company": "Explosive Startup",
      "custom_attributes": [
        {
          "key": "Relationship",
          "label": "Relationship to the company",
          "value": "CEO"
        }
      ]
    }
  ],
  "variables": [
    {
      "key": "adk123",
      "name": "Variable 1",
      "value": "value 1"
    }
  ],
  "copy": true
}

Response

Successfully sent a document

status'ok'

Example response

{
  "results": {
    "document": {
      "id": "5d40fdaf174b4c0007043072",
      "name": "My Document",
      "status": "completed",
      "folder": {
        "id": 9999,
        "name": "My Document",
        "parent_id": 9999,
        "space_id": 8888
      },
      "space": {
        "id": 9999,
        "name": "My Space",
        "root_folder_id": 9999,
        "allow_team_access": true
      },
      "signers": [
        {
          "key": "akdj17",
          "name": "Jack Smith",
          "email": "signer@example.com",
          "phone": "123 456 7899",
          "job_title": "Account Manager",
          "company": "Explosive Startup",
          "custom_attributes": [
            {
              "key": "Relationship",
              "label": "Relationship to the company",
              "value": "CEO"
            }
          ]
        }
      ],
      "variables": [
        {
          "key": "adk123",
          "name": "Variable 1",
          "value": "value 1"
        }
      ],
      "created_at_utc": "2019-04-14T09:00:00.000Z",
      "updated_at_utc": "2019-04-14T09:00:00.000Z",
      "sent_at_utc": "2019-04-14T09:00:00.000Z",
      "completed_at_utc": "2019-04-14T09:00:00.000Z",
      "source": {
        "type": "paperform_submission",
        "paperform_form_id": "iwl6j5lh",
        "paperform_submission_id": "6a18dfcdcc9dc182fc0031cc"
      }
    }
  }
}