Skip to main content

Create Docusign Envelope request

POST 
/esignature/docusign/:documentId/envelopes

DocuSign create Docusign Envelope request; available as an Add-On Module

Request​

Path Parameters

    documentId stringrequired

    Document Identifier

Query Parameters

    siteId string

    Site Identifier

Body

required

    emailSubject string

    The subject line of the email message that is sent to all recipients

    environment DocusignEnvironment (string)required

    Docusign Environment

    Possible values: [PRODUCTION, DEVELOPMENT]

    signers

    object[]

    List of DocuSign Signers

  • Array [

    • name stringrequired

    Name of Signer

    email string

    Email of Signer

    clientUserId string

    Specifies unique identifier for signer

    recipientId string

    A reference used to map recipients to other objects, such as specific document tabs.

    routingOrder string

    Specifies the routing order of the recipient in the envelope.

    suppressEmails string

    When true, email notifications are suppressed for the recipient, and they must access envelopes and documents from their Docusign inbox.

    tabs

    object

    signHereTabs

    object[]

    A list of Sign Here tabs

  • Array [

    • anchorString string

    Specifies the string to find in the document and use as the basis for tab placement.

    anchorXOffset string

    Specifies the X axis location of the tab in anchorUnits relative to the anchorString.

    anchorYOffset string

    Specifies the Y axis location of the tab in anchorUnits relative to the anchorString.

    anchorIgnoreIfNotPresent string

    When true, this tab is ignored if the anchorString is not found in the document.

    anchorUnits string

    Specifies units of the anchorXOffset and anchorYOffset

    xPosition string

    This property indicates the horizontal offset of the object on the page

    yPosition string

    This property indicates the vertical offset of the object on the page

    pageNumber string

    Specifies the page number on which the tab is located

  • ]

  • ]

    • inpersonSigners

    object[]

    List of DocuSign Inperson Signers

  • Array [

    • hostEmail stringrequired

    The email of the signing host

    hostName stringrequired

    The name of the signing host

    signerName stringrequired

    The full legal name of a signer

    signerEmail string

    The in-person signer's email address

    recipientId string

    A reference used to map recipients to other objects, such as specific document tabs.

    routingOrder string

    Specifies the routing order of the recipient in the envelope.

    suppressEmails string

    When true, email notifications are suppressed for the recipient, and they must access envelopes and documents from their Docusign inbox.

    tabs

    object

    signHereTabs

    object[]

    A list of Sign Here tabs

  • Array [

    • anchorString string

    Specifies the string to find in the document and use as the basis for tab placement.

    anchorXOffset string

    Specifies the X axis location of the tab in anchorUnits relative to the anchorString.

    anchorYOffset string

    Specifies the Y axis location of the tab in anchorUnits relative to the anchorString.

    anchorIgnoreIfNotPresent string

    When true, this tab is ignored if the anchorString is not found in the document.

    anchorUnits string

    Specifies units of the anchorXOffset and anchorYOffset

    xPosition string

    This property indicates the horizontal offset of the object on the page

    yPosition string

    This property indicates the vertical offset of the object on the page

    pageNumber string

    Specifies the page number on which the tab is located

  • ]

  • ]

    • notification

    DocusignNotification

    useAccountDefaults string

    When true, the account default notification settings are used for the envelope, overriding the reminders and expirations settings. When false, the reminders and expirations settings specified in this request are used. The default value is false.

    expirations

    DocusignNotificationExpirations

    expireAfter string

    An integer that sets the number of days the envelope is active. For this value to be used, expireEnabled must be explicitly set to true.

    expireEnabled string

    When true, the envelope expires in the number of days set by expireAfter.

    expireWarn string

    An integer that specifying the number of days before the envelope expires that an expiration warning email is sent to the recipient.

    reminders

    DocusignNotificationReminders

    reminderDelay string

    An integer specifying the number of days after the recipient receives the envelope that reminder emails are sent to the recipient.

    reminderEnabled string

    When true, reminders are enabled. The default value is false.

    reminderFrequency string

    An integer specifying the interval in days between reminder emails.

Responses​

200 OK

Response Headers

  • Access-Control-Allow-Origin

    string

  • Access-Control-Allow-Methods

    string

  • Access-Control-Allow-Headers

    string

Schema

    envelopeId string

    Docusign Envelope Identifier

Loading...