Adobe Sign

Adobe is the most trusted digital document sign service in the world. With Adobe Sign, you can transform manual processes into all-digital experiences. Incorporate Adobe Sign functionality into your favorite applications to create, send and monitor the status of agreements.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure China regions
Power Automate Standard All Power Automate regions except the following:
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
Power Apps Standard All Power Apps regions except the following:
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
Contact
Name Adobe Sign Support
URL https://helpx.adobe.com/contact/enterprise-support.dc.html#sign
Email support@echosign.zendesk.com
Connector Metadata
Publisher Adobe Inc.
Website https://acrobat.adobe.com/us/en/sign.html
Privacy policy https://www.adobe.com/privacy/policy.html
Categories Website

To use Adobe Sign connector, please create a new trial account using this link. You will have all the necessary entitlements to use the connector.

If you still have problems creating a connection, please reach out to support@echosign.zendesk.com.

Throttling Limits

Name Calls Renewal Period
API calls per connection10060 seconds

Actions

Create a library template from a document URL

This operation creates a template in Adobe Sign library from a document URL. Use this template for sending agreements

Create a library template from a document URL

This operation creates a template in Adobe Sign library from a document URL. Use this template for sending agreements

Create a library template from an uploaded document

This operation creates a template in Adobe Sign library from an uploaded document. Use this template for sending agreements.

Create a library template from an uploaded document

This operation creates a template in Adobe Sign library from an uploaded document. Use this template for sending agreements.

Create an agreement from a document URL and send for signature

This operation creates an agreement from a document uploaded in Adobe Sign and sends it for signature.

Create an agreement from a document URL and send for signature

This operation creates an agreement from a document uploaded in Adobe Sign and sends it for signature.

Create an agreement from a library template and send for signature

This operation creates an agreement from a template stored in the user's Adobe Sign library and sends it for signature.

Create an agreement from a library template and send for signature

This operation creates an agreement from a template stored in the user's Adobe Sign library and sends it for signature.

Create an agreement from an uploaded document and send for signature

This operation creates an agreement from a document uploaded in Adobe Sign and sends it for signature.

Create an agreement from an uploaded document and send for signature

This operation creates an agreement from a document uploaded in Adobe Sign and sends it for signature.

Get a document from an agreement

This operation fetches the file stream of a specific document of the agreement.

Get a document from an agreement [DEPRECATED]

This action has been deprecated. Please use Get a document from an agreement instead.

This operation fetches the file stream of a specific document of the agreement.

Get a list of all agreements

This operation fetches the list of all agreements of the user.

Get a list of all agreements

This operation fetches the list of all agreements of the user.

Get a list of all library templates

This operation fetches the list of all documents stored as templates in the Adobe Sign library of the user.

Get a list of all library templates

This operation fetches the list of all documents stored as templates in the Adobe Sign library of the user.

Get a list of all the document IDs from an agreement

This operation fetches the IDs of all documents and supporting documents of an agreement.

Get a list of all the document IDs from an agreement [DEPRECATED]

This action has been deprecated. Please use Get a list of all the document IDs from an agreement instead.

This operation fetches the IDs of all documents and supporting documents of an agreement.

Get a PDF of a signed agreement

This operation fetches the PDF file stream of the combined or signed agreement. Note that the file stream should be stored with a filename ending in .pdf file extension.

Get a PDF of a signed agreement [DEPRECATED]

This action has been deprecated. Please use Get a PDF of a signed agreement instead.

This operation fetches the PDF file stream of the combined or signed agreement. Note that the file stream should be stored with a filename ending in .pdf file extension.

Get form field data of agreement

Retrieves data entered into the interactive form fields of the agreement.

Get form field data of agreement

Retrieves data entered into the interactive form fields of the agreement.

Get the status of an agreement

This operation fetches all the current information of an agreement, like status.

Get the status of an agreement [DEPRECATED]

This action has been deprecated. Please use Get the status of an agreement instead.

This operation fetches all the current information of an agreement, like status.

Retrieve the Signing URL

This operation retrieves the URL for the e-sign page for the current signer(s) of an agreement.

Upload a document and get a document ID

This operation uploads a document in your Adobe Sign account and returns a document ID for it. This document is temporarily stored in Adobe Sign and the document ID can be used for further operations like creating an agreement.

Upload a document and get a document ID

This operation uploads a document in your Adobe Sign account and returns a document ID for it. This document is temporarily stored in Adobe Sign and the document ID can be used for further operations like creating an agreement.

Create a library template from a document URL

This operation creates a template in Adobe Sign library from a document URL. Use this template for sending agreements

Parameters

Name Key Required Type Description
Template Name
name True string

Agreement Name used to identify the template

Template Type
Template Type string

Agreement Name used to identify the template

Sharing Mode
sharingMode True string

Specifies who should have access to this library document

Location
url True string

A publicly accessible URL for retrieving the raw file content

Name
name True string

The original system file name of the document being sent

Mime Type
mimeType True string

The mime type of the referenced file, e.g. application/pdf

Template State
state True string

State of the library document.

Returns

A JSON object describing the library template

Create a library template from a document URL

This operation creates a template in Adobe Sign library from a document URL. Use this template for sending agreements

Parameters

Name Key Required Type Description
Template Name
name True string

Agreement Name used to identify the template

Template Type
libraryTemplateTypes True string

A list of one or more library template types

Share with
librarySharingMode True string

Specifies who should have access to this library document

URL
url True string

A publicly accessible URL for retrieving the document

Name
name True string

The name of the referenced document, with extension

URL (2)
url string

A publicly accessible URL for retrieving the document

Name (2)
name string

The name of the referenced document, with extension

URL (3)
url string

A publicly accessible URL for retrieving the document

Name (3)
name string

The name of the referenced document, with extension

URL (4)
url string

A publicly accessible URL for retrieving the document

Name (4)
name string

The name of the referenced document, with extension

URL (5)
url string

A publicly accessible URL for retrieving the document

Name (5)
name string

The name of the referenced document, with extension

URL (6)
url string

A publicly accessible URL for retrieving the document

Name (6)
name string

The name of the referenced document, with extension

URL (7)
url string

A publicly accessible URL for retrieving the document

Name (7)
name string

The name of the referenced document, with extension

URL (8)
url string

A publicly accessible URL for retrieving the document

Name (8)
name string

The name of the referenced document, with extension

URL (9)
url string

A publicly accessible URL for retrieving the document

Name (9)
name string

The name of the referenced document, with extension

URL (10)
url string

A publicly accessible URL for retrieving the document

Name (10)
name string

The name of the referenced document, with extension

Returns

A JSON object describing the library template

Create a library template from an uploaded document

This operation creates a template in Adobe Sign library from an uploaded document. Use this template for sending agreements.

Parameters

Name Key Required Type Description
Template Name
name True string

Agreement Name used to identify the template

Template Type
Template Type string

Agreement Name used to identify the template

Sharing Mode
sharingMode True string

Specifies who should have access to this library document

ID
transientDocumentId True string

The document id received by uploading a transient document

Template State
state True string

State of the library document.

Returns

A JSON object describing the library template

Create a library template from an uploaded document

This operation creates a template in Adobe Sign library from an uploaded document. Use this template for sending agreements.

Parameters

Name Key Required Type Description
Template Name
name True string

Agreement Name used to identify the template

Template Type
libraryTemplateTypes True string

A list of one or more library template types

Share with
librarySharingMode True string

Specifies who should have access to this library document

Document ID
transientDocumentId True string

The document ID received by uploading a document

Document ID (2)
transientDocumentId string

The document ID received by uploading a document

Document ID (3)
transientDocumentId string

The document ID received by uploading a document

Document ID (4)
transientDocumentId string

The document ID received by uploading a document

Document ID (5)
transientDocumentId string

The document ID received by uploading a document

Document ID (6)
transientDocumentId string

The document ID received by uploading a document

Document ID (7)
transientDocumentId string

The document ID received by uploading a document

Document ID (8)
transientDocumentId string

The document ID received by uploading a document

Document ID (9)
transientDocumentId string

The document ID received by uploading a document

Document ID (10)
transientDocumentId string

The document ID received by uploading a document

Returns

A JSON object describing the library template

Create an agreement from a document URL and send for signature

This operation creates an agreement from a document uploaded in Adobe Sign and sends it for signature.

Parameters

Name Key Required Type Description
Agreement Name
name True string

The name of the agreement

Location
url True string

A publicly accessible URL for retrieving the raw file content

Name
name True string

The original system file name of the document being sent

Mime Type
mimeType True string

The mime type of the referenced file, e.g. application/pdf

Signature Type
signatureType True string

Specifies the Signature type that was requested - E-signature or Written

Email
email True string

The email of the participant

Order
order True integer

Index starting with 1, indicating position at which signing group needs to sign.

Role
role True string

The current roles of the participant set (signer, approver etc).

Message
message string

An optional message to the recipients requesting their action

Days to Deadline
daysUntilSigningDeadline integer

The number of days that remain before the document expires

Reminder Frequency
reminderFrequency string

How often do you want to send reminders ?

Document Password
openPassword string

The password that should be used to encrypt the signed agreement PDF

- Name
fieldName string

The name of the field

- Value
defaultValue string

The default value of the field

Redirect Delay
redirectDelay string

The delay (in seconds) before the user is taken to the success page.

Redirect URL
redirectUrl string

URL to redirect after completing the signing process, e.g. https://adobe.com

Returns

A JSON that contains the ID of the newly created agreement

Create an agreement from a document URL and send for signature

This operation creates an agreement from a document uploaded in Adobe Sign and sends it for signature.

Parameters

Name Key Required Type Description
Agreement Name
name True string

The name of the agreement

URL
url True string

A publicly accessible URL for retrieving the document

Name
name True string

The name of the referenced document, with extension

Signature Type
signatureType True string

The type of signature you would like to request - E-signature or Written

Recipient Email
email True string

Email of the recipient

Recipient Signing Order
signingOrder True integer

Index starting with 1, that tells the order in which this recipient signs

Recipient Role
recipientSetRole True string

Specify the role of recipient

Message
message string

An optional message to the recipients requesting their action

Days to Deadline
daysUntilSigningDeadline integer

The number of days that remain before the document expires

Reminder Frequency
reminderFrequency string

How often do you want to send reminders?

Document Password
openPassword string

The password that should be used to encrypt the signed agreement PDF

URL (2)
url string

A publicly accessible URL for retrieving the document

Name (2)
name string

The name of the referenced document, with extension

URL (3)
url string

A publicly accessible URL for retrieving the document

Name (3)
name string

The name of the referenced document, with extension

URL (4)
url string

A publicly accessible URL for retrieving the document

Name (4)
name string

The name of the referenced document, with extension

URL (5)
url string

A publicly accessible URL for retrieving the document

Name (5)
name string

The name of the referenced document, with extension

URL (6)
url string

A publicly accessible URL for retrieving the document

Name (6)
name string

The name of the referenced document, with extension

URL (7)
url string

A publicly accessible URL for retrieving the document

Name (7)
name string

The name of the referenced document, with extension

URL (8)
url string

A publicly accessible URL for retrieving the document

Name (8)
name string

The name of the referenced document, with extension

URL (9)
url string

A publicly accessible URL for retrieving the document

Name (9)
name string

The name of the referenced document, with extension

URL (10)
url string

A publicly accessible URL for retrieving the document

Name (10)
name string

The name of the referenced document, with extension

Recipient Email (2)
email True string

Email of the recipient

Recipient Signing Order (2)
signingOrder True integer

Index starting with 1, that tells the order in which this recipient signs

Recipient Role (2)
recipientSetRole True string

Specify the role of recipient

Recipient Email (3)
email True string

Email of the recipient

Recipient Signing Order (3)
signingOrder True integer

Index starting with 1, that tells the order in which this recipient signs

Recipient Role (3)
recipientSetRole True string

Specify the role of recipient

Recipient Email (4)
email True string

Email of the recipient

Recipient Signing Order (4)
signingOrder True integer

Index starting with 1, that tells the order in which this recipient signs

Recipient Role (4)
recipientSetRole True string

Specify the role of recipient

Recipient Email (5)
email True string

Email of the recipient

Recipient Signing Order (5)
signingOrder True integer

Index starting with 1, that tells the order in which this recipient signs

Recipient Role (5)
recipientSetRole True string

Specify the role of recipient

Recipient Email (6)
email True string

Email of the recipient

Recipient Signing Order (6)
signingOrder True integer

Index starting with 1, that tells the order in which this recipient signs

Recipient Role (6)
recipientSetRole True string

Specify the role of recipient

Recipient Email (7)
email True string

Email of the recipient

Recipient Signing Order (7)
signingOrder True integer

Index starting with 1, that tells the order in which this recipient signs

Recipient Role (7)
recipientSetRole True string

Specify the role of recipient

Recipient Email (8)
email True string

Email of the recipient

Recipient Signing Order (8)
signingOrder True integer

Index starting with 1, that tells the order in which this recipient signs

Recipient Role (8)
recipientSetRole True string

Specify the role of recipient

Recipient Email (9)
email True string

Email of the recipient

Recipient Signing Order (9)
signingOrder True integer

Index starting with 1, that tells the order in which this recipient signs

Recipient Role (9)
recipientSetRole True string

Specify the role of recipient

Recipient Email (10)
email True string

Email of the recipient

Recipient Signing Order (10)
signingOrder True integer

Index starting with 1, that tells the order in which this recipient signs

Recipient Role (10)
recipientSetRole True string

Specify the role of recipient

Recipient Email (11)
email True string

Email of the recipient

Recipient Signing Order (11)
signingOrder True integer

Index starting with 1, that tells the order in which this recipient signs

Recipient Role (11)
recipientSetRole True string

Specify the role of recipient

Recipient Email (12)
email True string

Email of the recipient

Recipient Signing Order (12)
signingOrder True integer

Index starting with 1, that tells the order in which this recipient signs

Recipient Role (12)
recipientSetRole True string

Specify the role of recipient

Recipient Email (13)
email True string

Email of the recipient

Recipient Signing Order (13)
signingOrder True integer

Index starting with 1, that tells the order in which this recipient signs

Recipient Role (13)
recipientSetRole True string

Specify the role of recipient

Recipient Email (14)
email True string

Email of the recipient

Recipient Signing Order (14)
signingOrder True integer

Index starting with 1, that tells the order in which this recipient signs

Recipient Role (14)
recipientSetRole True string

Specify the role of recipient

Recipient Email (15)
email True string

Email of the recipient

Recipient Signing Order (15)
signingOrder True integer

Index starting with 1, that tells the order in which this recipient signs

Recipient Role (15)
recipientSetRole True string

Specify the role of recipient

Recipient Email (16)
email True string

Email of the recipient

Recipient Signing Order (16)
signingOrder True integer

Index starting with 1, that tells the order in which this recipient signs

Recipient Role (16)
recipientSetRole True string

Specify the role of recipient

Recipient Email (17)
email True string

Email of the recipient

Recipient Signing Order (17)
signingOrder True integer

Index starting with 1, that tells the order in which this recipient signs

Recipient Role (17)
recipientSetRole True string

Specify the role of recipient

Recipient Email (18)
email True string

Email of the recipient

Recipient Signing Order (18)
signingOrder True integer

Index starting with 1, that tells the order in which this recipient signs

Recipient Role (18)
recipientSetRole True string

Specify the role of recipient

Recipient Email (19)
email True string

Email of the recipient

Recipient Signing Order (19)
signingOrder True integer

Index starting with 1, that tells the order in which this recipient signs

Recipient Role (19)
recipientSetRole True string

Specify the role of recipient

Recipient Email (20)
email True string

Email of the recipient

Recipient Signing Order (20)
signingOrder True integer

Index starting with 1, that tells the order in which this recipient signs

Recipient Role (20)
recipientSetRole True string

Specify the role of recipient

Recipient Email (21)
email True string

Email of the recipient

Recipient Signing Order (21)
signingOrder True integer

Index starting with 1, that tells the order in which this recipient signs

Recipient Role (21)
recipientSetRole True string

Specify the role of recipient

Recipient Email (22)
email True string

Email of the recipient

Recipient Signing Order (22)
signingOrder True integer

Index starting with 1, that tells the order in which this recipient signs

Recipient Role (22)
recipientSetRole True string

Specify the role of recipient

Recipient Email (23)
email True string

Email of the recipient

Recipient Signing Order (23)
signingOrder True integer

Index starting with 1, that tells the order in which this recipient signs

Recipient Role (23)
recipientSetRole True string

Specify the role of recipient

Recipient Email (24)
email True string

Email of the recipient

Recipient Signing Order (24)
signingOrder True integer

Index starting with 1, that tells the order in which this recipient signs

Recipient Role (24)
recipientSetRole True string

Specify the role of recipient

Recipient Email (25)
email True string

Email of the recipient

Recipient Signing Order (25)
signingOrder True integer

Index starting with 1, that tells the order in which this recipient signs

Recipient Role (25)
recipientSetRole True string

Specify the role of recipient

Form Field Name (1)
fieldName string

The name of the field

Form Field Value (1)
defaultValue string

The default value of the field

Form Field Name (2)
fieldName string

The name of the field

Form Field Value (2)
defaultValue string

The default value of the field

Form Field Name (3)
fieldName string

The name of the field

Form Field Value (3)
defaultValue string

The default value of the field

Form Field Name (4)
fieldName string

The name of the field

Form Field Value (4)
defaultValue string

The default value of the field

Form Field Name (5)
fieldName string

The name of the field

Form Field Value (5)
defaultValue string

The default value of the field

Form Field Name (6)
fieldName string

The name of the field

Form Field Value (6)
defaultValue string

The default value of the field

Form Field Name (7)
fieldName string

The name of the field

Form Field Value (7)
defaultValue string

The default value of the field

Form Field Name (8)
fieldName string

The name of the field

Form Field Value (8)
defaultValue string

The default value of the field

Form Field Name (9)
fieldName string

The name of the field

Form Field Value (9)
defaultValue string

The default value of the field

Form Field Name (10)
fieldName string

The name of the field

Form Field Value (10)
defaultValue string

The default value of the field

Form Field Name (11)
fieldName string

The name of the field

Form Field Value (11)
defaultValue string

The default value of the field

Form Field Name (12)
fieldName string

The name of the field

Form Field Value (12)
defaultValue string

The default value of the field

Form Field Name (13)
fieldName string

The name of the field

Form Field Value (13)
defaultValue string

The default value of the field

Form Field Name (14)
fieldName string

The name of the field

Form Field Value (14)
defaultValue string

The default value of the field

Form Field Name (15)
fieldName string

The name of the field

Form Field Value (15)
defaultValue string

The default value of the field

Form Field Name (16)
fieldName string

The name of the field

Form Field Value (16)
defaultValue string

The default value of the field

Form Field Name (17)
fieldName string

The name of the field

Form Field Value (17)
defaultValue string

The default value of the field

Form Field Name (18)
fieldName string

The name of the field

Form Field Value (18)
defaultValue string

The default value of the field

Form Field Name (19)
fieldName string

The name of the field

Form Field Value (19)
defaultValue string

The default value of the field

Form Field Name (20)
fieldName string

The name of the field

Form Field Value (20)
defaultValue string

The default value of the field

Form Field Name (21)
fieldName string

The name of the field

Form Field Value (21)
defaultValue string

The default value of the field

Form Field Name (22)
fieldName string

The name of the field

Form Field Value (22)
defaultValue string

The default value of the field

Form Field Name (23)
fieldName string

The name of the field

Form Field Value (23)
defaultValue string

The default value of the field

Form Field Name (24)
fieldName string

The name of the field

Form Field Value (24)
defaultValue string

The default value of the field

Form Field Name (25)
fieldName string

The name of the field

Form Field Value (25)
defaultValue string

The default value of the field

Form Field Name (26)
fieldName string

The name of the field

Form Field Value (26)
defaultValue string

The default value of the field

Form Field Name (27)
fieldName string

The name of the field

Form Field Value (27)
defaultValue string

The default value of the field

Form Field Name (28)
fieldName string

The name of the field

Form Field Value (28)
defaultValue string

The default value of the field

Form Field Name (29)
fieldName string

The name of the field

Form Field Value (29)
defaultValue string

The default value of the field

Form Field Name (30)
fieldName string

The name of the field

Form Field Value (30)
defaultValue string

The default value of the field

Form Field Name (31)
fieldName string

The name of the field

Form Field Value (31)
defaultValue string

The default value of the field

Form Field Name (32)
fieldName string

The name of the field

Form Field Value (32)
defaultValue string

The default value of the field

Form Field Name (33)
fieldName string

The name of the field

Form Field Value (33)
defaultValue string

The default value of the field

Form Field Name (34)
fieldName string

The name of the field

Form Field Value (34)
defaultValue string

The default value of the field

Form Field Name (35)
fieldName string

The name of the field

Form Field Value (35)
defaultValue string

The default value of the field

Form Field Name (36)
fieldName string

The name of the field

Form Field Value (36)
defaultValue string

The default value of the field

Form Field Name (37)
fieldName string

The name of the field

Form Field Value (37)
defaultValue string

The default value of the field

Form Field Name (38)
fieldName string

The name of the field

Form Field Value (38)
defaultValue string

The default value of the field

Form Field Name (39)
fieldName string

The name of the field

Form Field Value (39)
defaultValue string

The default value of the field

Form Field Name (40)
fieldName string

The name of the field

Form Field Value (40)
defaultValue string

The default value of the field

Form Field Name (41)
fieldName string

The name of the field

Form Field Value (41)
defaultValue string

The default value of the field

Form Field Name (42)
fieldName string

The name of the field

Form Field Value (42)
defaultValue string

The default value of the field

Form Field Name (43)
fieldName string

The name of the field

Form Field Value (43)
defaultValue string

The default value of the field

Form Field Name (44)
fieldName string

The name of the field

Form Field Value (44)
defaultValue string

The default value of the field

Form Field Name (45)
fieldName string

The name of the field

Form Field Value (45)
defaultValue string

The default value of the field

Form Field Name (46)
fieldName string

The name of the field

Form Field Value (46)
defaultValue string

The default value of the field

Form Field Name (47)
fieldName string

The name of the field

Form Field Value (47)
defaultValue string

The default value of the field

Form Field Name (48)
fieldName string

The name of the field

Form Field Value (48)
defaultValue string

The default value of the field

Form Field Name (49)
fieldName string

The name of the field

Form Field Value (49)
defaultValue string

The default value of the field

Form Field Name (50)
fieldName string

The name of the field

Form Field Value (50)
defaultValue string

The default value of the field

Returns

A JSON that contains the ID of the newly created agreement

Create an agreement from a library template and send for signature

This operation creates an agreement from a template stored in the user's Adobe Sign library and sends it for signature.

Parameters

Name Key Required Type Description
Agreement Name
name True string

The name of the agreement

libraryDocumentId True string

Choose a document from the templates stored in your library

Signature Type
signatureType True string

The type of signature you would like to request - e-signature or written

Email
email True string

The email of the participant

Order
order True integer

Index starting with 1, indicating position at which signing group needs to sign.

Role
role True string

The current roles of the participant set (signer, approver etc).

Message
message string

An optional message to the recipients requesting their action

Days to Deadline
daysUntilSigningDeadline integer

The number of days that remain before the document expires

Reminder Frequency
reminderFrequency string

How often do you want to send reminders ?

Document Password
openPassword string

The password that should be used to encrypt the signed agreement PDF

- Name
fieldName string

The name of the field

- Value
defaultValue string

The default value of the field

Redirect Delay
redirectDelay string

The delay (in seconds) before the user is taken to the success page.

Redirect URL
redirectUrl string

URL to redirect after completing the signing process, e.g. https://adobe.com

Returns

A JSON that contains the ID of the newly created agreement

Create an agreement from a library template and send for signature

This operation creates an agreement from a template stored in the user's Adobe Sign library and sends it for signature.

Parameters

Name Key Required Type Description
Agreement Name
name True string

The name of the agreement

Document Library Template
libraryDocumentId True string

Choose a document from the templates stored in your library

Signature Type
signatureType True string

The type of signature you would like to request - E-signature or Written

Recipient Email
email True string

Email of the recipient

Recipient Signing Order
signingOrder True integer

Index starting with 1, that tells the order in which this recipient signs

Recipient Role
recipientSetRole True string

Specify the role of recipient

Message
message string

An optional message to the recipients requesting their action

Days to Deadline
daysUntilSigningDeadline integer

The number of days that remain before the document expires

Reminder Frequency
reminderFrequency string

How often do you want to send reminders?

Document Password
openPassword string

The password that should be used to encrypt the signed agreement PDF

Document Library Template (2)
libraryDocumentId string

Choose a document from the templates stored in your library

Document Library Template (3)
libraryDocumentId string

Choose a document from the templates stored in your library

Document Library Template (4)
libraryDocumentId string

Choose a document from the templates stored in your library

Document Library Template (5)
libraryDocumentId string

Choose a document from the templates stored in your library

Document Library Template (6)
libraryDocumentId string

Choose a document from the templates stored in your library

Document Library Template (7)
libraryDocumentId string

Choose a document from the templates stored in your library

Document Library Template (8)
libraryDocumentId string

Choose a document from the templates stored in your library

Document Library Template (9)
libraryDocumentId string

Choose a document from the templates stored in your library

Document Library Template (10)
libraryDocumentId string

Choose a document from the templates stored in your library

Recipient Email (2)
email True string

Email of the recipient

Recipient Signing Order (2)
signingOrder True integer

Index starting with 1, that tells the order in which this recipient signs

Recipient Role (2)
recipientSetRole True string

Specify the role of recipient

Recipient Email (3)
email True string

Email of the recipient

Recipient Signing Order (3)
signingOrder True integer

Index starting with 1, that tells the order in which this recipient signs

Recipient Role (3)
recipientSetRole True string

Specify the role of recipient

Recipient Email (4)
email True string

Email of the recipient

Recipient Signing Order (4)
signingOrder True integer

Index starting with 1, that tells the order in which this recipient signs

Recipient Role (4)
recipientSetRole True string

Specify the role of recipient

Recipient Email (5)
email True string

Email of the recipient

Recipient Signing Order (5)
signingOrder True integer

Index starting with 1, that tells the order in which this recipient signs

Recipient Role (5)
recipientSetRole True string

Specify the role of recipient

Recipient Email (6)
email True string

Email of the recipient

Recipient Signing Order (6)
signingOrder True integer

Index starting with 1, that tells the order in which this recipient signs

Recipient Role (6)
recipientSetRole True string

Specify the role of recipient

Recipient Email (7)
email True string

Email of the recipient

Recipient Signing Order (7)
signingOrder True integer

Index starting with 1, that tells the order in which this recipient signs

Recipient Role (7)
recipientSetRole True string

Specify the role of recipient

Recipient Email (8)
email True string

Email of the recipient

Recipient Signing Order (8)
signingOrder True integer

Index starting with 1, that tells the order in which this recipient signs

Recipient Role (8)
recipientSetRole True string

Specify the role of recipient

Recipient Email (9)
email True string

Email of the recipient

Recipient Signing Order (9)
signingOrder True integer

Index starting with 1, that tells the order in which this recipient signs

Recipient Role (9)
recipientSetRole True string

Specify the role of recipient

Recipient Email (10)
email True string

Email of the recipient

Recipient Signing Order (10)
signingOrder True integer

Index starting with 1, that tells the order in which this recipient signs

Recipient Role (10)
recipientSetRole True string

Specify the role of recipient

Recipient Email (11)
email True string

Email of the recipient

Recipient Signing Order (11)
signingOrder True integer

Index starting with 1, that tells the order in which this recipient signs

Recipient Role (11)
recipientSetRole True string

Specify the role of recipient

Recipient Email (12)
email True string

Email of the recipient

Recipient Signing Order (12)
signingOrder True integer

Index starting with 1, that tells the order in which this recipient signs

Recipient Role (12)
recipientSetRole True string

Specify the role of recipient

Recipient Email (13)
email True string

Email of the recipient

Recipient Signing Order (13)
signingOrder True integer

Index starting with 1, that tells the order in which this recipient signs

Recipient Role (13)
recipientSetRole True string

Specify the role of recipient

Recipient Email (14)
email True string

Email of the recipient

Recipient Signing Order (14)
signingOrder True integer

Index starting with 1, that tells the order in which this recipient signs

Recipient Role (14)
recipientSetRole True string

Specify the role of recipient

Recipient Email (15)
email True string

Email of the recipient

Recipient Signing Order (15)
signingOrder True integer

Index starting with 1, that tells the order in which this recipient signs

Recipient Role (15)
recipientSetRole True string

Specify the role of recipient

Recipient Email (16)
email True string

Email of the recipient

Recipient Signing Order (16)
signingOrder True integer

Index starting with 1, that tells the order in which this recipient signs

Recipient Role (16)
recipientSetRole True string

Specify the role of recipient

Recipient Email (17)
email True string

Email of the recipient

Recipient Signing Order (17)
signingOrder True integer

Index starting with 1, that tells the order in which this recipient signs

Recipient Role (17)
recipientSetRole True string

Specify the role of recipient

Recipient Email (18)
email True string

Email of the recipient

Recipient Signing Order (18)
signingOrder True integer

Index starting with 1, that tells the order in which this recipient signs

Recipient Role (18)
recipientSetRole True string

Specify the role of recipient

Recipient Email (19)
email True string

Email of the recipient

Recipient Signing Order (19)
signingOrder True integer

Index starting with 1, that tells the order in which this recipient signs

Recipient Role (19)
recipientSetRole True string

Specify the role of recipient

Recipient Email (20)
email True string

Email of the recipient

Recipient Signing Order (20)
signingOrder True integer

Index starting with 1, that tells the order in which this recipient signs

Recipient Role (20)
recipientSetRole True string

Specify the role of recipient

Recipient Email (21)
email True string

Email of the recipient

Recipient Signing Order (21)
signingOrder True integer

Index starting with 1, that tells the order in which this recipient signs

Recipient Role (21)
recipientSetRole True string

Specify the role of recipient

Recipient Email (22)
email True string

Email of the recipient

Recipient Signing Order (22)
signingOrder True integer

Index starting with 1, that tells the order in which this recipient signs

Recipient Role (22)
recipientSetRole True string

Specify the role of recipient

Recipient Email (23)
email True string

Email of the recipient

Recipient Signing Order (23)
signingOrder True integer

Index starting with 1, that tells the order in which this recipient signs

Recipient Role (23)
recipientSetRole True string

Specify the role of recipient

Recipient Email (24)
email True string

Email of the recipient

Recipient Signing Order (24)
signingOrder True integer

Index starting with 1, that tells the order in which this recipient signs

Recipient Role (24)
recipientSetRole True string

Specify the role of recipient

Recipient Email (25)
email True string

Email of the recipient

Recipient Signing Order (25)
signingOrder True integer

Index starting with 1, that tells the order in which this recipient signs

Recipient Role (25)
recipientSetRole True string

Specify the role of recipient

Form Field Name (1)
fieldName string

The name of the field

Form Field Value (1)
defaultValue string

The default value of the field

Form Field Name (2)
fieldName string

The name of the field

Form Field Value (2)
defaultValue string

The default value of the field

Form Field Name (3)
fieldName string

The name of the field

Form Field Value (3)
defaultValue string

The default value of the field

Form Field Name (4)
fieldName string

The name of the field

Form Field Value (4)
defaultValue string

The default value of the field

Form Field Name (5)
fieldName string

The name of the field

Form Field Value (5)
defaultValue string

The default value of the field

Form Field Name (6)
fieldName string

The name of the field

Form Field Value (6)
defaultValue string

The default value of the field

Form Field Name (7)
fieldName string

The name of the field

Form Field Value (7)
defaultValue string

The default value of the field

Form Field Name (8)
fieldName string

The name of the field

Form Field Value (8)
defaultValue string

The default value of the field

Form Field Name (9)
fieldName string

The name of the field

Form Field Value (9)
defaultValue string

The default value of the field

Form Field Name (10)
fieldName string

The name of the field

Form Field Value (10)
defaultValue string

The default value of the field

Form Field Name (11)
fieldName string

The name of the field

Form Field Value (11)
defaultValue string

The default value of the field

Form Field Name (12)
fieldName string

The name of the field

Form Field Value (12)
defaultValue string

The default value of the field

Form Field Name (13)
fieldName string

The name of the field

Form Field Value (13)
defaultValue string

The default value of the field

Form Field Name (14)
fieldName string

The name of the field

Form Field Value (14)
defaultValue string

The default value of the field

Form Field Name (15)
fieldName string

The name of the field

Form Field Value (15)
defaultValue string

The default value of the field

Form Field Name (16)
fieldName string

The name of the field

Form Field Value (16)
defaultValue string

The default value of the field

Form Field Name (17)
fieldName string

The name of the field

Form Field Value (17)
defaultValue string

The default value of the field

Form Field Name (18)
fieldName string

The name of the field

Form Field Value (18)
defaultValue string

The default value of the field

Form Field Name (19)
fieldName string

The name of the field

Form Field Value (19)
defaultValue string

The default value of the field

Form Field Name (20)
fieldName string

The name of the field

Form Field Value (20)
defaultValue string

The default value of the field

Form Field Name (21)
fieldName string

The name of the field

Form Field Value (21)
defaultValue string

The default value of the field

Form Field Name (22)
fieldName string

The name of the field

Form Field Value (22)
defaultValue string

The default value of the field

Form Field Name (23)
fieldName string

The name of the field

Form Field Value (23)
defaultValue string

The default value of the field

Form Field Name (24)
fieldName string

The name of the field

Form Field Value (24)
defaultValue string

The default value of the field

Form Field Name (25)
fieldName string

The name of the field

Form Field Value (25)
defaultValue string

The default value of the field

Form Field Name (26)
fieldName string

The name of the field

Form Field Value (26)
defaultValue string

The default value of the field

Form Field Name (27)
fieldName string

The name of the field

Form Field Value (27)
defaultValue string

The default value of the field

Form Field Name (28)
fieldName string

The name of the field

Form Field Value (28)
defaultValue string

The default value of the field

Form Field Name (29)
fieldName string

The name of the field

Form Field Value (29)
defaultValue string

The default value of the field

Form Field Name (30)
fieldName string

The name of the field

Form Field Value (30)
defaultValue string

The default value of the field

Form Field Name (31)
fieldName string

The name of the field

Form Field Value (31)
defaultValue string

The default value of the field

Form Field Name (32)
fieldName string

The name of the field

Form Field Value (32)
defaultValue string

The default value of the field

Form Field Name (33)
fieldName string

The name of the field

Form Field Value (33)
defaultValue string

The default value of the field

Form Field Name (34)
fieldName string

The name of the field

Form Field Value (34)
defaultValue string

The default value of the field

Form Field Name (35)
fieldName string

The name of the field

Form Field Value (35)
defaultValue string

The default value of the field

Form Field Name (36)
fieldName string

The name of the field

Form Field Value (36)
defaultValue string

The default value of the field

Form Field Name (37)
fieldName string

The name of the field

Form Field Value (37)
defaultValue string

The default value of the field

Form Field Name (38)
fieldName string

The name of the field

Form Field Value (38)
defaultValue string

The default value of the field

Form Field Name (39)
fieldName string

The name of the field

Form Field Value (39)
defaultValue string

The default value of the field

Form Field Name (40)
fieldName string

The name of the field

Form Field Value (40)
defaultValue string

The default value of the field

Form Field Name (41)
fieldName string

The name of the field

Form Field Value (41)
defaultValue string

The default value of the field

Form Field Name (42)
fieldName string

The name of the field

Form Field Value (42)
defaultValue string

The default value of the field

Form Field Name (43)
fieldName string

The name of the field

Form Field Value (43)
defaultValue string

The default value of the field

Form Field Name (44)
fieldName string

The name of the field

Form Field Value (44)
defaultValue string

The default value of the field

Form Field Name (45)
fieldName string

The name of the field

Form Field Value (45)
defaultValue string

The default value of the field

Form Field Name (46)
fieldName string

The name of the field

Form Field Value (46)
defaultValue string

The default value of the field

Form Field Name (47)
fieldName string

The name of the field

Form Field Value (47)
defaultValue string

The default value of the field

Form Field Name (48)
fieldName string

The name of the field

Form Field Value (48)
defaultValue string

The default value of the field

Form Field Name (49)
fieldName string

The name of the field

Form Field Value (49)
defaultValue string

The default value of the field

Form Field Name (50)
fieldName string

The name of the field

Form Field Value (50)
defaultValue string

The default value of the field

Returns

A JSON that contains the ID of the newly created agreement

Create an agreement from an uploaded document and send for signature

This operation creates an agreement from a document uploaded in Adobe Sign and sends it for signature.

Parameters

Name Key Required Type Description
Agreement Name
name True string

The name of the agreement

ID
transientDocumentId True string

The document id received by uploading a transient document

Signature Type
signatureType True string

The type of signature you would like to request - e-signature or written

Email
email True string

The email of the participant

Order
order True integer

Index starting with 1, indicating position at which signing group needs to sign.

Role
role True string

The current roles of the participant set (signer, approver etc).

Message
message string

An optional message to the recipients requesting their action

Days to Deadline
daysUntilSigningDeadline integer

The number of days that remain before the document expires

Reminder Frequency
reminderFrequency string

How often do you want to send reminders ?

Document Password
openPassword string

The password that should be used to encrypt the signed agreement PDF

- Name
fieldName string

The name of the field

- Value
defaultValue string

The default value of the field

Redirect Delay
redirectDelay string

The delay (in seconds) before the user is taken to the success page.

Redirect URL
redirectUrl string

URL to redirect after completing the signing process, e.g. https://adobe.com

Returns

A JSON that contains the ID of the newly created agreement

Create an agreement from an uploaded document and send for signature

This operation creates an agreement from a document uploaded in Adobe Sign and sends it for signature.

Parameters

Name Key Required Type Description
Agreement Name
name True string

The name of the agreement

Document ID
transientDocumentId True string

The document ID received by uploading a document

Signature Type
signatureType True string

The type of signature you would like to request - E-signature or Written

Recipient Email
email True string

Email of the recipient

Recipient Signing Order
signingOrder True integer

Index starting with 1, that tells the order in which this recipient signs

Recipient Role
recipientSetRole True string

Specify the role of recipient

Message
message string

An optional message to the recipients requesting their action

Days to Deadline
daysUntilSigningDeadline integer

The number of days that remain before the document expires

Reminder Frequency
reminderFrequency string

How often do you want to send reminders?

Document Password
openPassword string

The password that should be used to encrypt the signed agreement PDF

Document ID (2)
transientDocumentId string

The document ID received by uploading a document

Document ID (3)
transientDocumentId string

The document ID received by uploading a document

Document ID (4)
transientDocumentId string

The document ID received by uploading a document

Document ID (5)
transientDocumentId string

The document ID received by uploading a document

Document ID (6)
transientDocumentId string

The document ID received by uploading a document

Document ID (7)
transientDocumentId string

The document ID received by uploading a document

Document ID (8)
transientDocumentId string

The document ID received by uploading a document

Document ID (9)
transientDocumentId string

The document ID received by uploading a document

Document ID (10)
transientDocumentId string

The document ID received by uploading a document

Recipient Email (2)
email True string

Email of the recipient

Recipient Signing Order (2)
signingOrder True integer

Index starting with 1, that tells the order in which this recipient signs

Recipient Role (2)
recipientSetRole True string

Specify the role of recipient

Recipient Email (3)
email True string

Email of the recipient

Recipient Signing Order (3)
signingOrder True integer

Index starting with 1, that tells the order in which this recipient signs

Recipient Role (3)
recipientSetRole True string

Specify the role of recipient

Recipient Email (4)
email True string

Email of the recipient

Recipient Signing Order (4)
signingOrder True integer

Index starting with 1, that tells the order in which this recipient signs

Recipient Role (4)
recipientSetRole True string

Specify the role of recipient

Recipient Email (5)
email True string

Email of the recipient

Recipient Signing Order (5)
signingOrder True integer

Index starting with 1, that tells the order in which this recipient signs

Recipient Role (5)
recipientSetRole True string

Specify the role of recipient

Recipient Email (6)
email True string

Email of the recipient

Recipient Signing Order (6)
signingOrder True integer

Index starting with 1, that tells the order in which this recipient signs

Recipient Role (6)
recipientSetRole True string

Specify the role of recipient

Recipient Email (7)
email True string

Email of the recipient

Recipient Signing Order (7)
signingOrder True integer

Index starting with 1, that tells the order in which this recipient signs

Recipient Role (7)
recipientSetRole True string

Specify the role of recipient

Recipient Email (8)
email True string

Email of the recipient

Recipient Signing Order (8)
signingOrder True integer

Index starting with 1, that tells the order in which this recipient signs

Recipient Role (8)
recipientSetRole True string

Specify the role of recipient

Recipient Email (9)
email True string

Email of the recipient

Recipient Signing Order (9)
signingOrder True integer

Index starting with 1, that tells the order in which this recipient signs

Recipient Role (9)
recipientSetRole True string

Specify the role of recipient

Recipient Email (10)
email True string

Email of the recipient

Recipient Signing Order (10)
signingOrder True integer

Index starting with 1, that tells the order in which this recipient signs

Recipient Role (10)
recipientSetRole True string

Specify the role of recipient

Recipient Email (11)
email True string

Email of the recipient

Recipient Signing Order (11)
signingOrder True integer

Index starting with 1, that tells the order in which this recipient signs

Recipient Role (11)
recipientSetRole True string

Specify the role of recipient

Recipient Email (12)
email True string

Email of the recipient

Recipient Signing Order (12)
signingOrder True integer

Index starting with 1, that tells the order in which this recipient signs

Recipient Role (12)
recipientSetRole True string

Specify the role of recipient

Recipient Email (13)
email True string

Email of the recipient

Recipient Signing Order (13)
signingOrder True integer

Index starting with 1, that tells the order in which this recipient signs

Recipient Role (13)
recipientSetRole True string

Specify the role of recipient

Recipient Email (14)
email True string

Email of the recipient

Recipient Signing Order (14)
signingOrder True integer

Index starting with 1, that tells the order in which this recipient signs

Recipient Role (14)
recipientSetRole True string

Specify the role of recipient

Recipient Email (15)
email True string

Email of the recipient

Recipient Signing Order (15)
signingOrder True integer

Index starting with 1, that tells the order in which this recipient signs

Recipient Role (15)
recipientSetRole True string

Specify the role of recipient

Recipient Email (16)
email True string

Email of the recipient

Recipient Signing Order (16)
signingOrder True integer

Index starting with 1, that tells the order in which this recipient signs

Recipient Role (16)
recipientSetRole True string

Specify the role of recipient

Recipient Email (17)
email True string

Email of the recipient

Recipient Signing Order (17)
signingOrder True integer

Index starting with 1, that tells the order in which this recipient signs

Recipient Role (17)
recipientSetRole True string

Specify the role of recipient

Recipient Email (18)
email True string

Email of the recipient

Recipient Signing Order (18)
signingOrder True integer

Index starting with 1, that tells the order in which this recipient signs

Recipient Role (18)
recipientSetRole True string

Specify the role of recipient

Recipient Email (19)
email True string

Email of the recipient

Recipient Signing Order (19)
signingOrder True integer

Index starting with 1, that tells the order in which this recipient signs

Recipient Role (19)
recipientSetRole True string

Specify the role of recipient

Recipient Email (20)
email True string

Email of the recipient

Recipient Signing Order (20)
signingOrder True integer

Index starting with 1, that tells the order in which this recipient signs

Recipient Role (20)
recipientSetRole True string

Specify the role of recipient

Recipient Email (21)
email True string

Email of the recipient

Recipient Signing Order (21)
signingOrder True integer

Index starting with 1, that tells the order in which this recipient signs

Recipient Role (21)
recipientSetRole True string

Specify the role of recipient

Recipient Email (22)
email True string

Email of the recipient

Recipient Signing Order (22)
signingOrder True integer

Index starting with 1, that tells the order in which this recipient signs

Recipient Role (22)
recipientSetRole True string

Specify the role of recipient

Recipient Email (23)
email True string

Email of the recipient

Recipient Signing Order (23)
signingOrder True integer

Index starting with 1, that tells the order in which this recipient signs

Recipient Role (23)
recipientSetRole True string

Specify the role of recipient

Recipient Email (24)
email True string

Email of the recipient

Recipient Signing Order (24)
signingOrder True integer

Index starting with 1, that tells the order in which this recipient signs

Recipient Role (24)
recipientSetRole True string

Specify the role of recipient

Recipient Email (25)
email True string

Email of the recipient

Recipient Signing Order (25)
signingOrder True integer

Index starting with 1, that tells the order in which this recipient signs

Recipient Role (25)
recipientSetRole True string

Specify the role of recipient

Form Field Name (1)
fieldName string

The name of the field

Form Field Value (1)
defaultValue string

The default value of the field

Form Field Name (2)
fieldName string

The name of the field

Form Field Value (2)
defaultValue string

The default value of the field

Form Field Name (3)
fieldName string

The name of the field

Form Field Value (3)
defaultValue string

The default value of the field

Form Field Name (4)
fieldName string

The name of the field

Form Field Value (4)
defaultValue string

The default value of the field

Form Field Name (5)
fieldName string

The name of the field

Form Field Value (5)
defaultValue string

The default value of the field

Form Field Name (6)
fieldName string

The name of the field

Form Field Value (6)
defaultValue string

The default value of the field

Form Field Name (7)
fieldName string

The name of the field

Form Field Value (7)
defaultValue string

The default value of the field

Form Field Name (8)
fieldName string

The name of the field

Form Field Value (8)
defaultValue string

The default value of the field

Form Field Name (9)
fieldName string

The name of the field

Form Field Value (9)
defaultValue string

The default value of the field

Form Field Name (10)
fieldName string

The name of the field

Form Field Value (10)
defaultValue string

The default value of the field

Form Field Name (11)
fieldName string

The name of the field

Form Field Value (11)
defaultValue string

The default value of the field

Form Field Name (12)
fieldName string

The name of the field

Form Field Value (12)
defaultValue string

The default value of the field

Form Field Name (13)
fieldName string

The name of the field

Form Field Value (13)
defaultValue string

The default value of the field

Form Field Name (14)
fieldName string

The name of the field

Form Field Value (14)
defaultValue string

The default value of the field

Form Field Name (15)
fieldName string

The name of the field

Form Field Value (15)
defaultValue string

The default value of the field

Form Field Name (16)
fieldName string

The name of the field

Form Field Value (16)
defaultValue string

The default value of the field

Form Field Name (17)
fieldName string

The name of the field

Form Field Value (17)
defaultValue string

The default value of the field

Form Field Name (18)
fieldName string

The name of the field

Form Field Value (18)
defaultValue string

The default value of the field

Form Field Name (19)
fieldName string

The name of the field

Form Field Value (19)
defaultValue string

The default value of the field

Form Field Name (20)
fieldName string

The name of the field

Form Field Value (20)
defaultValue string

The default value of the field

Form Field Name (21)
fieldName string

The name of the field

Form Field Value (21)
defaultValue string

The default value of the field

Form Field Name (22)
fieldName string

The name of the field

Form Field Value (22)
defaultValue string

The default value of the field

Form Field Name (23)
fieldName string

The name of the field

Form Field Value (23)
defaultValue string

The default value of the field

Form Field Name (24)
fieldName string

The name of the field

Form Field Value (24)
defaultValue string

The default value of the field

Form Field Name (25)
fieldName string

The name of the field

Form Field Value (25)
defaultValue string

The default value of the field

Form Field Name (26)
fieldName string

The name of the field

Form Field Value (26)
defaultValue string

The default value of the field

Form Field Name (27)
fieldName string

The name of the field

Form Field Value (27)
defaultValue string

The default value of the field

Form Field Name (28)
fieldName string

The name of the field

Form Field Value (28)
defaultValue string

The default value of the field

Form Field Name (29)
fieldName string

The name of the field

Form Field Value (29)
defaultValue string

The default value of the field

Form Field Name (30)
fieldName string

The name of the field

Form Field Value (30)
defaultValue string

The default value of the field

Form Field Name (31)
fieldName string

The name of the field

Form Field Value (31)
defaultValue string

The default value of the field

Form Field Name (32)
fieldName string

The name of the field

Form Field Value (32)
defaultValue string

The default value of the field

Form Field Name (33)
fieldName string

The name of the field

Form Field Value (33)
defaultValue string

The default value of the field

Form Field Name (34)
fieldName string

The name of the field

Form Field Value (34)
defaultValue string

The default value of the field

Form Field Name (35)
fieldName string

The name of the field

Form Field Value (35)
defaultValue string

The default value of the field

Form Field Name (36)
fieldName string

The name of the field

Form Field Value (36)
defaultValue string

The default value of the field

Form Field Name (37)
fieldName string

The name of the field

Form Field Value (37)
defaultValue string

The default value of the field

Form Field Name (38)
fieldName string

The name of the field

Form Field Value (38)
defaultValue string

The default value of the field

Form Field Name (39)
fieldName string

The name of the field

Form Field Value (39)
defaultValue string

The default value of the field

Form Field Name (40)
fieldName string

The name of the field

Form Field Value (40)
defaultValue string

The default value of the field

Form Field Name (41)
fieldName string

The name of the field

Form Field Value (41)
defaultValue string

The default value of the field

Form Field Name (42)
fieldName string

The name of the field

Form Field Value (42)
defaultValue string

The default value of the field

Form Field Name (43)
fieldName string

The name of the field

Form Field Value (43)
defaultValue string

The default value of the field

Form Field Name (44)
fieldName string

The name of the field

Form Field Value (44)
defaultValue string

The default value of the field

Form Field Name (45)
fieldName string

The name of the field

Form Field Value (45)
defaultValue string

The default value of the field

Form Field Name (46)
fieldName string

The name of the field

Form Field Value (46)
defaultValue string

The default value of the field

Form Field Name (47)
fieldName string

The name of the field

Form Field Value (47)
defaultValue string

The default value of the field

Form Field Name (48)
fieldName string

The name of the field

Form Field Value (48)
defaultValue string

The default value of the field

Form Field Name (49)
fieldName string

The name of the field

Form Field Value (49)
defaultValue string

The default value of the field

Form Field Name (50)
fieldName string

The name of the field

Form Field Value (50)
defaultValue string

The default value of the field

Returns

A JSON that contains the ID of the newly created agreement

Get a document from an agreement

This operation fetches the file stream of a specific document of the agreement.

Parameters

Name Key Required Type Description
Agreement ID
agreementId True string

The agreement ID of the agreement whose document is needed

Document ID
documentId True string

The document ID of the specific document of the agreement

Returns

The file stream of the document

response
DocumentResponse

Get a document from an agreement [DEPRECATED]

This action has been deprecated. Please use Get a document from an agreement instead.

This operation fetches the file stream of a specific document of the agreement.

Parameters

Name Key Required Type Description
Agreement ID
agreementId True string

The agreement ID of the agreement whose document is needed

Document ID
documentId True string

The document ID of the specific document of the agreement

Returns

The file stream of the document

response
DocumentResponse

Get a list of all agreements

This operation fetches the list of all agreements of the user.

Returns

A JSON that contains the user agreement array object

Get a list of all agreements

This operation fetches the list of all agreements of the user.

Returns

A JSON that contains the user agreement array object

Get a list of all library templates

This operation fetches the list of all documents stored as templates in the Adobe Sign library of the user.

Returns

A JSON that contains the library template array object

Get a list of all library templates

This operation fetches the list of all documents stored as templates in the Adobe Sign library of the user.

Returns

A JSON that contains the library template array object

Get a list of all the document IDs from an agreement

This operation fetches the IDs of all documents and supporting documents of an agreement.

Parameters

Name Key Required Type Description
Agreement ID
agreementId True string

The agreement ID of the agreement whose documents are needed

Supporting documents - Content Type
supportingDocumentContentFormat string

Content type of the supporting documents of the agreement

Returns

A JSON that contains both the documents and supporting documents array objects

Get a list of all the document IDs from an agreement [DEPRECATED]

This action has been deprecated. Please use Get a list of all the document IDs from an agreement instead.

This operation fetches the IDs of all documents and supporting documents of an agreement.

Parameters

Name Key Required Type Description
Agreement ID
agreementId True string

The agreement ID of the agreement whose documents are needed

Supporting documents - Content Type
supportingDocumentContentFormat string

Content type of the supporting documents of the agreement

Returns

A JSON that contains both the documents and supporting documents array objects

Get a PDF of a signed agreement

This operation fetches the PDF file stream of the combined or signed agreement. Note that the file stream should be stored with a filename ending in .pdf file extension.

Parameters

Name Key Required Type Description
Agreement ID
agreementId True string

The agreement ID as provided by the action that creates the agreement

Attach Supporting Documents?
attachSupportingDocuments boolean

If true, attach supporting documents to the signed agreement PDF

Attach Audit Report?
attachAuditReport boolean

If true, attach an audit report to the signed agreement PDF

Returns

The file stream of the document

Get a PDF of a signed agreement [DEPRECATED]

This action has been deprecated. Please use Get a PDF of a signed agreement instead.

This operation fetches the PDF file stream of the combined or signed agreement. Note that the file stream should be stored with a filename ending in .pdf file extension.

Parameters

Name Key Required Type Description
Agreement ID
agreementId True string

The agreement ID as provided by the action that creates the agreement

Attach Supporting Documents?
attachSupportingDocuments boolean

If true, attach supporting documents to the signed agreement PDF

Attach Audit Report?
auditReport boolean

If true, attach an audit report to the signed agreement PDF

Returns

The file stream of the document

Get form field data of agreement

Retrieves data entered into the interactive form fields of the agreement.

Parameters

Name Key Required Type Description
Agreement ID
agreementId True string

The agreement ID of the agreement whose information is needed

Returns

response
file

Get form field data of agreement

Retrieves data entered into the interactive form fields of the agreement.

Parameters

Name Key Required Type Description
Agreement ID
agreementId True string

The agreement ID of the agreement whose information is needed

Returns

The content of the Form Data

Form Data Content
binary

Get the status of an agreement

This operation fetches all the current information of an agreement, like status.

Parameters

Name Key Required Type Description
Agreement ID
agreementId True string

The agreement ID of the agreement whose information is needed

Returns

Complete Agreement Details

Get the status of an agreement [DEPRECATED]

This action has been deprecated. Please use Get the status of an agreement instead.

This operation fetches all the current information of an agreement, like status.

Parameters

Name Key Required Type Description
Agreement ID
agreementId True string

The agreement ID of the agreement whose information is needed

Returns

The complete details about the agreement

Retrieve the Signing URL

This operation retrieves the URL for the e-sign page for the current signer(s) of an agreement.

Parameters

Name Key Required Type Description
Agreement ID
agreementId True string

The agreement ID as provided by the action that creates the agreement

Returns

Upload a document and get a document ID

This operation uploads a document in your Adobe Sign account and returns a document ID for it. This document is temporarily stored in Adobe Sign and the document ID can be used for further operations like creating an agreement.

Parameters

Name Key Required Type Description
File Name
File-Name True string

The name of the document to be uploaded, with extension

File Content
File True contentOnly

The file stream of the document to be uploaded

Returns

A JSON that contains the ID of the uploaded document

Upload a document and get a document ID

This operation uploads a document in your Adobe Sign account and returns a document ID for it. This document is temporarily stored in Adobe Sign and the document ID can be used for further operations like creating an agreement.

Parameters

Name Key Required Type Description
File Name
File-Name True string

The name of the document to be uploaded, with extension

File Content
File True contentOnly

The file stream of the document to be uploaded

Returns

A JSON that contains the ID of the uploaded document

Triggers

When a new agreement is created

Triggers a new flow when a new agreement is created.

When an agreement is sent to a participant

Triggers a new flow when an agreement is sent to a participant.

When an agreement workflow is completed successfully

Triggers a new flow when an agreement workflow is completed successfully

When an event occurs

Triggers a new flow when an event occurs. Covers all Agreement, Mega Sign and Widget events.

When the state of an agreement changes

Triggers a new flow when the status of an agreement changes. Covers most common Agreement events such as creation, completion, etc.

When a new agreement is created

Triggers a new flow when a new agreement is created.

Parameters

Name Key Required Type Description
Name
name True string

The name of the trigger

Scope
scope True string

The scope of the trigger

Include Agreement Info?
includeDetailedInfo boolean

Should detailed agreement info be sent in notification?

Include Agreement Participant Info?
includeParticipantsInfo boolean

Should agreement participant info be sent in notification?

Returns

When an agreement is sent to a participant

Triggers a new flow when an agreement is sent to a participant.

Parameters

Name Key Required Type Description
Name
name True string

The name of the trigger

Scope
scope True string

The scope of the trigger

Agreement Name/ID
resourceId string

Specify only when "Scope" is "A specific agreement". Select an agreement from the list or enter the agreement ID.

Include Agreement Info?
includeDetailedInfo boolean

Should detailed agreement info be sent in notification?

Include Agreement Participant Info?
includeParticipantsInfo boolean

Should agreement participant info be sent in notification?

Include Agreement Document Info?
includeDocumentsInfo boolean

Should agreement document info be sent in notification?

Returns

When an agreement workflow is completed successfully

Triggers a new flow when an agreement workflow is completed successfully

Parameters

Name Key Required Type Description
Name
name True string

The name of the trigger

Scope
scope True string

The scope of the trigger

Agreement Name/ID
resourceId string

Specify only when "Scope" is "A specific agreement". Select an agreement from the list or enter the agreement ID.

Include Agreement Info?
includeDetailedInfo boolean

Should detailed agreement info be sent in notification?

Include Agreement Participant Info?
includeParticipantsInfo boolean

Should agreement participant info be sent in notification?

Include Agreement Document Info?
includeDocumentsInfo boolean

Should agreement document info be sent in notification?

Include Agreement Signed Document Info?
includeSignedDocuments boolean

Should a final copy of signed document on agreement completion be sent in notification?

Returns

When an event occurs

Triggers a new flow when an event occurs. Covers all Agreement, Mega Sign and Widget events.

Parameters

Name Key Required Type Description
Name
name True string

The name of the trigger

Scope
scope True string

The scope of the trigger

Resource Type
resourceType string

Specify only when "Scope" is "A specific resource". Select the resource type for which the flow should be triggered.

Resource ID
resourceId string

Specify only when "Scope" is "A specific resource". Enter the agreement or mega sign or widget ID for which the flow should be triggered.

Events
webhookSubscriptionEvents string

The name of the trigger

Include Agreement Info?
includeDetailedInfo boolean

Should detailed agreement info be sent in notification?

Include Agreement Participant Info?
includeParticipantsInfo boolean

Should agreement participant info be sent in notification?

Include Agreement Document Info?
includeDocumentsInfo boolean

Should agreement document info be sent in notification?

Include Agreement Signed Document Info?
includeSignedDocuments boolean

Should a final copy of signed document on agreement completion be sent in notification?

Include MegaSign Info?
includeDetailedInfo boolean

Should detailed mega sign info be sent in notification?

Include Widget Info?
includeDetailedInfo boolean

Should detailed widget info be sent in notification?

Include Widget Participant Info?
includeParticipantsInfo boolean

Should widget participant info be sent in notification?

Include Widget Documents Info?
includeDocumentsInfo boolean

Should widget document info be sent in notification?

Returns

When the state of an agreement changes

Triggers a new flow when the status of an agreement changes. Covers most common Agreement events such as creation, completion, etc.

Parameters

Name Key Required Type Description
Name
name True string

The name of the trigger

Scope
scope True string

The scope of the trigger

Agreement Name/ID
resourceId string

Specify only when "Scope" is "A specific agreement". Select an agreement from the list or enter the agreement ID.

Events
webhookSubscriptionEvents string

The name of the trigger

Include Agreement Info?
includeDetailedInfo boolean

Should detailed agreement info be sent in notification?

Include Agreement Participant Info?
includeParticipantsInfo boolean

Should agreement participant info be sent in notification?

Include Agreement Document Info?
includeDocumentsInfo boolean

Should agreement document info be sent in notification?

Include Agreement Signed Document Info?
includeSignedDocuments boolean

Should a final copy of signed document be sent in notification of agreement completion?

Returns

Definitions

AgreementCreationResponse

A JSON that contains the ID of the newly created agreement

Name Path Type Description
Agreement ID
agreementId string

The unique ID of the agreement that can be used to query status and download signed documents

AgreementCreationResponseV6

A JSON that contains the ID of the newly created agreement

Name Path Type Description
Agreement ID
id string

The unique ID of the agreement that can be used to query status and download signed documents

AgreementDocuments

A JSON that contains both the documents and supporting documents array objects

Name Path Type Description
Documents
documents array of Document

A list of objects representing the documents

Supporting Documents
supportingDocuments array of SupportingDocument

A list of supporting documents. This is returned only if there are any supporting document in the agreement

AgreementDocumentsV6

A JSON that contains both the documents and supporting documents array objects

Name Path Type Description
Documents
documents array of DocumentV6

A list of objects representing the documents

Supporting Documents
supportingDocuments array of SupportingDocumentV6

A list of supporting documents. This is returned only if there are any supporting document in the agreement

AgreementInfo

The complete details about the agreement

Name Path Type Description
Agreement ID
agreementId string

A unique ID that can be used to uniquely identify the agreement

Events
events array of DocumentHistoryEvent

An ordered list of the events in the audit trail of this document

Expiration Date
expiration date

The date after which the agreement can no longer be signed

Latest Version ID
latestVersionId string

A unique ID which uniquely identifies the current version of the agreement

Message
message string

The message associated with the agreement that the sender has provided

Agreement Name
name string

The name of the agreement, specified by the sender

Next Participant Sets
nextParticipantSetInfos array of NextParticipantSetInfo

Information about who needs to act next for this agreement

Participant Sets
participantSetInfos array of ParticipantSetInfo

Information about all the participant sets of this document

Signature Type
signatureType string

Specifies the Signature type that was requested - E-signature or Written

Document Protection
securityOptions string

Security information about the document that specifies whether or not a password is required to view and sign it

Status
status string

The current status of the agreement

AgreementInfoV6

Complete Agreement Details

Name Path Type Description
Agreement ID
id string

A unique ID that can be used to uniquely identify the agreement

Created Date
createdDate date

Date when agreement was created

First Reminder Delay
firstReminderDelay integer

Integer which specifies the delay in hours before sending the first reminder.

Reminder Frequency
reminderFrequency string

How often do you want to send reminders?

Expiration Date
expiration date

The date after which the agreement can no longer be signed

Locale
locale string

The locale associated with this agreement - for example, en_US or fr_FR

Message
message string

The message associated with the agreement that the sender has provided

Agreement Name
name string

The name of the agreement, specified by the sender

Document Visibility?
documentVisibilityEnabled boolean

Is document visibility enabled?

Participant Sets
participantSetsInfo array of ParticipantSetInfoV6

Information about all the participant sets of this document

Signature Type
signatureType string

Specifies the Signature type that was requested - E-signature or Written

Security Options
securityOptions string

Security information about the document that specifies whether or not a password is required to view and sign it

Status
status string

The current status of the agreement

Sender Email
senderEmail string

The email of the sender

Workflow ID
workflowId string

The ID of custom workflow which defines the routing path of an agreement.

CCs
ccs array of CcInfo

A list of one or more CCs that will be copied in the agreement transaction.

CombinedDocumentResponse

The file stream of the document

The file stream of the document

File Content
binary

DisplayUserInfo

Name Path Type Description
Company
company string

Displays the name of the company of the user, if available

Email
email string

Displays the email of the user

Full Name
fullName string

Displays the full name of the user, if available.

DisplayUserSetInfo

Name Path Type Description
Display User Set Info
displayUserSetMemberInfos array of DisplayUserInfo

Displays the info about user set

Display User Set Name
displayUserSetName string

Document

The information about the document

Name Path Type Description
Document ID
documentId string

The unique ID of the document

Mime Type
mimeType string

The Mime type of the document

Name
name string

The name of the document

Num Pages
numPages integer

Number of pages in the document

DocumentV6

The information about the document

Name Path Type Description
Document ID
id string

The unique ID of the document

Mime Type
mimeType string

The Mime type of the document

Name
name string

The name of the document

Num Pages
numPages integer

Number of pages in the document

DocumentHistoryEvent

Name Path Type Description
Event Initiator
actingUserEmail string

Email address of the user that initiated the event

Event Date
date date

The date of the audit event

Event Description
description string

A description of the audit event

Participant Email
participantEmail string

Email address of the user that initiated the event

Event Type
type string

Type of agreement event

DocumentLibraryItem

Name Path Type Description
Library Template Id
libraryDocumentId string

The unique ID of the library document used when sending the document to be signed

Library Template Types
libraryTemplateTypes array of string

A list of one or more library template types

Modified Date
modifiedDate date

The day on which the library template was last modified

Library Template Name
name string

The name of the library template

Template Sharing Mode
scope string

The scope of visibility of the library template

DocumentLibraryItems

A JSON that contains the library template array object

Name Path Type Description
Library Templates List
libraryDocumentList array of DocumentLibraryItem

A list of library template items

DocumentResponse

The file stream of the document

The file stream of the document

File Content
binary

LibraryDocumentCreationResponse

A JSON object describing the library template

Name Path Type Description
Library Template Id
libraryDocumentId string

The unique ID that can be used to refer to the library template

NextParticipantInfo

Name Path Type Description
Email
email string

The email address of the next participant

Name
name string

The name of the next participant, if available

Waiting Since
waitingSince date

The date since which the document has been waiting for the participant to take action

NextParticipantSetInfo

Name Path Type Description
Next Participant Set Member Infos
nextParticipantSetMemberInfos array of NextParticipantInfo

Information about the members of the next participant set

ParticipantInfo

Name Path Type Description
Company
company string

The company of the participant, if available

Email
email string

The email address of the participant

Name
name string

The name of the participant, if available

Participant ID
participantId string

The unique ID of the participant

Security Options
securityOptions array of string

Security options that apply to the participant

Title
title string

The title of the participant, if available

ParticipantSetInfo

Name Path Type Description
Participant Set ID
participantSetId string

The unique ID of the participant set

Participant Set Member Infos
participantSetMemberInfos array of ParticipantInfo

Information about the members of the recipient set

Private Message
privateMessage string

Private message for the participants in the set

Role
roles array of string

The current roles of the participant set. A participant set can have one or more roles

securityOptions
securityOptions array of string

Security options that apply to the participant

Signing Order
signingOrder integer

Index starting with 1, that tells the order in which this recipient signs

Participant Set Status
status string

The participant set status with respect to the document

ParticipantSetInfoV6

Name Path Type Description
Participant Set Member Infos
memberInfos array of MemberInfosV6

Information about the members of the recipient set

Order
order integer

Index indicating position at which signing group needs to sign.

Role
role string

The current roles of the participant set (signer, approver etc).

Participant Set Name
name string

The name of the participant set

Participant Set Private Messsage
privateMessage string

Private message for the participants in the set

Participant Set Visible Pages
visiblePages array of string

The pages that are visible to the participant set

MemberInfosV6

Name Path Type Description
Email
email string

The email of the participant

SigningUrl

Name Path Type Description
Email for Sign URL
email string

The email address of the signer associated with this signing url

Sign URL
esignUrl string

The URL address of the signer associated with this signing url

SigningUrlResponse

Name Path Type Description
Array of URLs for signer sets
signingUrlSetInfos array of SigningUrlSetInfo

An array of urls for signer sets involved in this agreement

SigningUrlSetInfo

Name Path Type Description
- Signing URL Array
signingUrls array of SigningUrl

An array of urls for current signer set

- Sign URL set name
signingUrlSetName string

The name of the current signer set

SupportingDocument

The information about the supporting document

Name Path Type Description
Supporting Document Name
displayLabel string

Display name of the supporting document

Supporting Document Field Name
fieldName string

The name of the supporting document field

Supporting Document Mime Type
mimeType string

The Mime type of the supporting document

Supporting Document Pages
numPages integer

Number of pages in the supporting document

Supporting Document ID
supportingDocumentId string

Unique ID representing the supporting document

SupportingDocumentV6

The information about the supporting document

Name Path Type Description
Supporting Document Name
displayLabel string

Display name of the supporting document

Supporting Document Field Name
fieldName string

The name of the supporting document field

Supporting Document Mime Type
mimeType string

The Mime type of the supporting document

Supporting Document Pages
numPages integer

Number of pages in the supporting document

Supporting Document ID
id string

Unique ID representing the supporting document

TransientDocumentResponse

A JSON that contains the ID of the uploaded document

Name Path Type Description
Document ID
transientDocumentId string

The document ID of the uploaded document

UserAgreement

Name Path Type Description
Agreement ID
agreementId string

A unique ID that can be used to uniquely identify the agreement

Display User Set Infos
displayUserSetInfos array of DisplayUserSetInfo

The most relevant current user set for the agreement. It is typically the next signer if the agreement is from the current user, or the sender if received from another user

Display Date
displayDate date

The display date for the agreement

Esign
esign boolean

True if this is an e-sign document

Latest Version ID
latestVersionId string

A version ID which uniquely identifies the current version of the agreement

Name
name string

Name of the Agreement

Status
status string

The current status of the agreement

UserAgreements

A JSON that contains the user agreement array object

Name Path Type Description
Agreement List
userAgreementList array of UserAgreement

An array of agreement items

UserAgreementV6

Name Path Type Description
Display User Set Infos
displayParticipantSetInfos array of DisplayUserSetInfo

The most relevant current user set for the agreement. It is typically the next signer if the agreement is from the current user, or the sender if received from another user

Display Date
displayDate string

The display date for the agreement

Esign
esign boolean

True if this is an e-sign document

Hidden
hidden boolean

True if agreement is hidden for the user

Group ID
groupId string

Unique identifier of the group

Latest Version ID
latestVersionId string

A version ID which uniquely identifies the current version of the agreement

Name
name string

Name of the Agreement

Parent ID
parentId string

The parent id of a megaSign child OR the originating id of a widget agreement instance

Agreement ID
id string

The unique identifier of the agreement

Status
status string

The current status of the agreement

Type
type string

The kind of agreement

userAgreementListV6

A JSON that contains the user agreement array object

Name Path Type Description
page
page page

Pagination information for navigating through the response

Agreement List
userAgreementList array of UserAgreementV6

An array of agreement items

page

Pagination information for navigating through the response

Name Path Type Description
nextCursor
nextCursor string

Used to navigate to the next page. If not returned, there are no further pages.

WebhookPayload

Name Path Type Description
Event
event string

The event that has occured on the resource.

Event Date
eventDate date

The date of the event. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time

Event Resource Type
eventResourceType string

The resource on which the event has occured.

Agreement Parent Type
eventResourceParentType string

Information about the resource from which agreement is created. Possible values: Widget or Mega Sign

Agreement Parent ID
eventResourceParentId string

A Unique ID of the resource from which this agreement is created

Event Participant Role
participantRole string

The Role of the participant for the event.

Event Participant Id
participantUserId string

The ID of the participant for the event.

Event Participant Email
participantUserEmail string

The email of the participant for the event.

Event Acting User ID
actingUserId string

The ID of the user that created the event.

Event Acting User Email
actingUserEmail string

The email of the user that created the event.

Event Acting User IP Address
actingUserIpAddress string

The IP address of the user who created the event

Event Initiating User ID
initiatingUserId string

The ID of the user that initiated the event on behalf of acting user.

Event Initiating User Email
initiatingUserEmail string

The email of the user that initiated the event on behalf of acting user.

Notification Applicable Users
webhookNotificationApplicableUsers array of ApplicableUsers

A list of users for whom this notification is applicable

Agreement
agreement WebhookAgreementInfo

The complete information of the agreement

ApplicableUsers

The information about the users for whom this notification is applicable

Name Path Type Description
Notification Applicable User ID
id string

The unique ID of the user for whom this notification is applicable

Notification Applicable User Email
email string

The email of the user for whom this notification is applicable

Notification Applicable User Role
role string

The role of the user in the workflow for whom this notification is generated

Is Payload Applicable User
payloadApplicable boolean

Whether the data provided in this notification is applicable for this user or not

WebhookPayloadWithoutNextParticipantSet

Name Path Type Description
Event
event string

The event that has occured on the resource.

Event Date
eventDate date

The date of the event. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time

Event Resource Type
eventResourceType string

The resource on which the event has occured.

Agreement Parent Type
eventResourceParentType string

Information about the resource from which agreement is created. Possible values: Widget or Mega Sign

Agreement Parent ID
eventResourceParentId string

A Unique ID of the resource from which this agreement is created

Event Participant Id
participantUserId string

The ID of the participant for the event.

Event Participant Email
participantUserEmail string

The email of the participant for the event.

Event Acting User ID
actingUserId string

The ID of the user that created the event.

Event Acting User Email
actingUserEmail string

The email of the user that created the event.

Event Acting User IP Address
actingUserIpAddress string

The IP address of the user who created the event

Event Initiating User ID
initiatingUserId string

The ID of the user that initiated the event on behalf of acting user

Event Initiating User Email
initiatingUserEmail string

The email of the user that initiated the event on behalf of acting user.

Notification Applicable Users
webhookNotificationApplicableUsers array of ApplicableUsers

A list of users for whom this notification is applicable

Agreement
agreement WebhookAgreementInfoWithoutNextParticipantSet

The complete information of the agreement

WebhookPayloadWithSignedDocumentForStatusChange

Name Path Type Description
Event
event string

The event that has occured on the resource.

Event Date
eventDate date

The date of the event. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time

Sub Event
subEvent string

The sub event that has occured on a resource.

Agreement Parent Type
eventResourceParentType string

Information about the resource from which agreement is created. Possible values: Widget or Mega Sign

Agreement Parent ID
eventResourceParentId string

A Unique ID of the resource from which this agreement is created

Event Participant Id
participantUserId string

The ID of the participant for the event.

Event Participant Email
participantUserEmail string

The email of the participant for the event.

Event Acting User ID
actingUserId string

The ID of the user that created the event.

Event Acting User Email
actingUserEmail string

The email of the user that created the event.

Event Acting User IP Address
actingUserIpAddress string

The IP address of the user who created the event

Action Type
actionType string

The action for which the event has occurred.

Event Initiating User ID
initiatingUserId string

The ID of the user that initiated the event on behalf of acting user

Event Initiating User Email
initiatingUserEmail string

The email of the user that initiated the event on behalf of acting user.

Event Resource Type
eventResourceType string

The resource on which the event has occured.

Event Participant Role
participantRole string

The Role of the participant for the event.

Notification Applicable Users
webhookNotificationApplicableUsers array of ApplicableUsers

A list of users for whom this notification is applicable

Agreement
agreement WebhookAgreementInfoWithSignedDocument

The complete information of the agreement

WebhookPayloadWithSignedDocument

Name Path Type Description
Event
event string

The event that has occured on the resource.

Event Date
eventDate date

The date of the event. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time

Agreement Parent Type
eventResourceParentType string

Information about the resource from which agreement is created. Possible values: Widget or Mega Sign

Agreement Parent ID
eventResourceParentId string

A Unique ID of the resource from which this agreement is created

Event Resource Type
eventResourceType string

The resource on which the event has occured.

Event Participant Role
participantRole string

The Role of the participant for the event.

Event Participant Id
participantUserId string

The ID of the participant for the event.

Event Participant Email
participantUserEmail string

The email of the participant for the event.

Event Acting User ID
actingUserId string

The ID of the user that created the event.

Event Acting User Email
actingUserEmail string

The email of the user that created the event.

Event Acting User IP Address
actingUserIpAddress string

The IP address of the user who created the event

Event Initiating User ID
initiatingUserId string

The ID of the user that initiated the event on behalf of acting user

Event Initiating User Email
initiatingUserEmail string

The email of the user that initiated the event on behalf of acting user.

Notification Applicable Users
webhookNotificationApplicableUsers array of ApplicableUsers

A list of users for whom this notification is applicable

Agreement
agreement WebhookAgreementInfoWithSignedDocument

The complete information of the agreement

WebhookPayloadGeneric

Name Path Type Description
Event
event string

The event that has occured on the resource.

Event Date
eventDate date

The date of the event. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time

Sub Event
subEvent string

The sub event that has occured on a resource.

Agreement Parent Type
eventResourceParentType string

Information about the resource from which agreement is created. Possible values: Widget or Mega Sign

Agreement Parent ID
eventResourceParentId string

A Unique ID of the resource from which this agreement is created

Event Resource Type
eventResourceType string

The resource on which the event has occured.

Event Participant Role
participantRole string

The Role of the participant for the event.

Event Participant Id
participantUserId string

The ID of the participant for the event.

Event Participant Email
participantUserEmail string

The email of the participant for the event.

Event Acting User ID
actingUserId string

The ID of the user that created the event.

Event Acting User Email
actingUserEmail string

The email of the user that created the event.

Event Initiating User ID
initiatingUserId string

The ID of the user that initiated the event on behalf of acting user

Event Initiating User Email
initiatingUserEmail string

The email of the user that initiated the event on behalf of acting user.

Action Type
actionType string

The action for which the event has occurred.

Event Acting User IP Address
actingUserIpAddress string

The IP address of the user who created the event

Notification Applicable Users
webhookNotificationApplicableUsers array of ApplicableUsers

A list of users for whom this notification is applicable

Agreement
agreement WebhookAgreementInfoWithSignedDocumentAndNextParticipantInfo

The complete information of the agreement

Mega Sign
megaSign WebhookMegaSignInfo

The complete information of the mega sign

Widget
widget WebhookWidgetInfo

The complete information of the widget

WebhookAgreementInfo

The complete information of the agreement

Name Path Type Description
ID
id string

The unique ID of the agreement

Name
name string

The name of the agreement

Signature Type
signatureType string

Specifies the Signature type that was requested - E-signature or Written

Status
status string

The current status of the agreement

CCs
ccs array of CcInfo

A list of one or more CCs that will be copied in the agreement transaction.

Creation Date
createdDate date

Date when agreement was created

Expiration Time
expirationTime string

Time after which Agreement expires and needs to be signed before it

External ID
externalId.id string

An arbitrary value from your system, which can be specified at sending time and then later returned or queried

External Group
externalId.group string

An arbitrary value from your system, which can be specified at sending time and then later returned or queried

First Reminder Delay
firstReminderDelay integer

Integer which specifies the delay in hours before sending the first reminder.

Locale
locale string

The locale associated with this agreement

Message
message string

An optional message to the participants, describing what is being sent or why their signature is required

Reminder Frequency
reminderFrequency string

Optional parameter that sets how often you want to send reminders to the participants. If it is not specified, the default frequency set for the account will be used

Sender Email
senderEmail string

Email of agreement sender

Vaulting Enabled?
vaultingInfo.enabled boolean

For accounts set up for document vaulting and the option to enable per agreement, this determines whether the document is to be vaulted

Document Visibility?
documentVisibilityEnabled boolean

Is document visibility enabled

Workflow ID
workflowId string

The ID of custom workflow which defines the routing path of an agreement.

Post Sign Redirect Url
postSignOption.redirectUrl string

A publicly accessible url to which the user will be sent after successfully completing the signing process

Participant Sets
participantSetsInfo.participantSets array of WebhookParticipantSets

The participant sets info

Next Participant Sets
participantSetsInfo.nextParticipantSets array of WebhookParticipantSets

The next participant sets info

Documents
documentsInfo.documents array of WebhookDocument

A list of objects representing the documents

Supporting Documents
documentsInfo.supportingDocuments array of WebhookSupportingDocument

A list of supporting documents

WebhookAgreementInfoWithoutNextParticipantSet

The complete information of the agreement

Name Path Type Description
ID
id string

The unique ID of the agreement

Name
name string

The name of the agreement

Signature Type
signatureType string

Specifies the Signature type that was requested - E-signature or Written

Status
status string

The current status of the agreement

CCs
ccs array of CcInfo

A list of one or more CCs that will be copied in the agreement transaction.

Creation Date
createdDate date

Date when agreement was created

Document Visibility?
documentVisibilityEnabled boolean

Is document visibility enabled

Expiration Time
expirationTime string

Time after which Agreement expires and needs to be signed before it

External ID
externalId.id string

An arbitrary value from your system, which can be specified at sending time and then later returned or queried

External Group
externalId.group string

An arbitrary value from your system, which can be specified at sending time and then later returned or queried

First Reminder Delay
firstReminderDelay integer

Integer which specifies the delay in hours before sending the first reminder.

Locale
locale string

The locale associated with this agreement

Message
message string

An optional message to the participants, describing what is being sent or why their signature is required

Reminder Frequency
reminderFrequency string

Optional parameter that sets how often you want to send reminders to the participants. If it is not specified, the default frequency set for the account will be used

Sender Email
senderEmail string

Email of agreement sender

Vaulting Enabled?
vaultingInfo.enabled boolean

For accounts set up for document vaulting and the option to enable per agreement, this determines whether the document is to be vaulted

Post Sign Redirect Url
postSignOption.redirectUrl string

A publicly accessible url to which the user will be sent after successfully completing the signing process

Workflow ID
workflowId string

The ID of custom workflow which defines the routing path of an agreement.

Participant Sets
participantSetsInfo.participantSets array of WebhookParticipantSets

The participant sets info

WebhookAgreementInfoWithSignedDocumentAndNextParticipantInfo

The complete information of the agreement

Name Path Type Description
ID
id string

The unique ID of the agreement

Name
name string

The name of the agreement

Signature Type
signatureType string

Specifies the Signature type that was requested - E-signature or Written

Status
status string

The current status of the agreement

CCs
ccs array of CcInfo

A list of one or more CCs that will be copied in the agreement transaction.

Creation Date
createdDate date

Date when agreement was created

Expiration Time
expirationTime string

Time after which Agreement expires and needs to be signed before it

External ID
externalId.id string

An arbitrary value from your system, which can be specified at sending time and then later returned or queried

External Group
externalId.group string

An arbitrary value from your system, which can be specified at sending time and then later returned or queried

First Reminder Delay
firstReminderDelay integer

Integer which specifies the delay in hours before sending the first reminder.

Locale
locale string

The locale associated with this agreement

Message
message string

An optional message to the participants, describing what is being sent or why their signature is required

Reminder Frequency
reminderFrequency string

Optional parameter that sets how often you want to send reminders to the participants. If it is not specified, the default frequency set for the account will be used

Post Sign Redirect Url
postSignOption.redirectUrl string

A publicly accessible url to which the user will be sent after successfully completing the signing process

Workflow ID
workflowId string

The ID of custom workflow which defines the routing path of an agreement.

Sender Email
senderEmail string

Email of agreement sender

Document Visibility?
documentVisibilityEnabled boolean

Is document visibility enabled

Vaulting Enabled?
vaultingInfo.enabled boolean

For accounts set up for document vaulting and the option to enable per agreement, this determines whether the document is to be vaulted

Participant Sets
participantSetsInfo.participantSets array of WebhookParticipantSets

The participant sets info

Next Participant Sets
participantSetsInfo.nextParticipantSets array of WebhookParticipantSets

The next participant sets info

Documents
documentsInfo.documents array of WebhookDocument

A list of objects representing the documents

Supporting Documents
documentsInfo.supportingDocuments array of WebhookSupportingDocument

A list of supporting documents This is returned only if there are any supporting document in the agreement

Signed Document Info
signedDocumentInfo.document string

A base64 encoded string of the signed document

WebhookAgreementInfoWithSignedDocument

The complete information of the agreement

Name Path Type Description
ID
id string

The unique ID of the agreement

Name
name string

The name of the agreement

Signature Type
signatureType string

Specifies the Signature type that was requested - E-signature or Written

Status
status string

The current status of the agreement

CCs
ccs array of CcInfo

A list of one or more CCs that will be copied in the agreement transaction

Creation Date
createdDate date

Date when agreement was created

Document Visibility?
documentVisibilityEnabled boolean

Is document visibility enabled

Expiration Time
expirationTime string

Time after which Agreement expires and needs to be signed before it

External ID
externalId.id string

An arbitrary value from your system, which can be specified at sending time and then later returned or queried

External Group
externalId.group string

An arbitrary value from your system, which can be specified at sending time and then later returned or queried

First Reminder Delay
firstReminderDelay integer

Integer which specifies the delay in hours before sending the first reminder.

Locale
locale string

The locale associated with this agreement

Message
message string

An optional message to the participants, describing what is being sent or why their signature is required

Reminder Frequency
reminderFrequency string

Optional parameter that sets how often you want to send reminders to the participants. If it is not specified, the default frequency set for the account will be used

Sender Email
senderEmail string

Email of agreement sender

Vaulting Enabled?
vaultingInfo.enabled boolean

For accounts set up for document vaulting and the option to enable per agreement, this determines whether the document is to be vaulted

Post Sign Redirect Url
postSignOption.redirectUrl string

A publicly accessible url to which the user will be sent after successfully completing the signing process

Workflow ID
workflowId string

The ID of custom workflow which defines the routing path of an agreement.

Participant Sets
participantSetsInfo.participantSets array of WebhookParticipantSets

The participant sets info

Documents
documentsInfo.documents array of WebhookDocument

A list of objects representing the documents

Supporting Documents
documentsInfo.supportingDocuments array of WebhookSupportingDocument

A list of supporting documents This is returned only if there are any supporting document in the agreement

Signed Document Info
signedDocumentInfo.document string

A base64 encoded string of the signed document

WebhookMegaSignInfo

The complete information of the mega sign

Name Path Type Description
ID
id string

The unique ID of the megasign

Name
name string

The name of the megasign

Status
status string

The status of the megasign

CCs
ccs array of MegaSignCcInfo

A list of one or more email addresses that you want to copy on this megasign.

External ID
externalId.id string

An arbitrary value from your system, which can be specified at sending time and then later returned or queried

First Reminder Delay
firstReminderDelay integer

Integer which specifies the delay in hours before sending the first reminder.

Locale
locale string

The locale associated with this agreement

Message
message string

An optional message to the participants, describing what is being sent or why their signature is required

Post Sign Redirect Url
postSignOption.redirectUrl string

A publicly accessible url to which the user will be sent after successfully completing the signing process

Sender Email
senderEmail string

Email of megasign creator

Signature Type
signatureType string

Specifies the Signature type that was requested - E-signature or Written

Vaulting Enabled?
vaultingInfo.enabled boolean

For accounts set up for document vaulting and the option to enable per agreement, this determines whether the document is to be vaulted

Child Agreements File Info
childAgreementsInfo.fileInfo MegaSignChildAgreementsFileInfo

File info containing per child agreement information of megaSign.

WebhookWidgetInfo

The complete information of the widget

Name Path Type Description
ID
id string

The unique ID of the widget

Name
name string

The name of the widget

Status
status string

The status of the widget

Authentication Failure Info
authFailureInfo AuthFailureWidgetRedirectionInfo

URL and associated properties for the error page the widget signer will be taken after failing to authenticate

CCs
ccs array of WidgetCcInfo

A list of one or more email addresses that you want to copy on this widget.

Creation Date
createdDate date

Date when widget was created

Completion Info
completionInfo WidgetCompletionRedirectionInfo

URL and associated properties for the success page the widget signer will be taken to after performing desired action on the widget

Creator Email
creatorEmail string

The email of the creator of the widget

Vaulting Enabled?
vaultingInfo.enabled boolean

For accounts set up for document vaulting and the option to enable per agreement, this determines whether the document is to be vaulted

Additional Participant Sets Info
participantSetsInfo.additionalParticipantSets array of WidgetParticipantSetInfo

List of all the participants in the widget except widget signer

First Participant Set Role
participantSetsInfo.widgetParticipantSet.role string

Role assumed by all participants in the set (signer, approver etc.)

First Participant Set Order
participantSetsInfo.widgetParticipantSet.order integer

Index indicating sequential signing group (specified for hybrid routing)

Documents
documentsInfo.documents array of WidgetWebhookDocument

A list of objects representing the documents

AuthFailureWidgetRedirectionInfo

URL and associated properties for the error page the widget signer will be taken after failing to authenticate

Name Path Type Description
Auth Failure Redirect Delay
delay integer

The delay (in seconds) before the user is taken to the resultant page

Auth Failure Redirect Deframe
deframe boolean

If deframe is false, the resultant page will be shown inside the widget frame

Auth Failure Redirect Url
url string

A publicly accessible url to which the user will be sent after successfully completing the widget

WidgetCompletionRedirectionInfo

URL and associated properties for the success page the widget signer will be taken to after performing desired action on the widget

Name Path Type Description
Completion Redirect Delay
delay integer

The delay (in seconds) before the user is taken to the resultant page

Completion Redirect Deframe
deframe boolean

If deframe is false, the resultant page will be shown inside the widget frame

Completion Redirect Url
url string

A publicly accessible url to which the user will be sent after successfully completing the widget

WebhookParticipantSets

Name Path Type Description
Member Infos
memberInfos array of MemberInfos

The information about participant members

Order
order integer

Index indicating position at which signing group needs to sign.

Role
role string

Role assumed by all participants in the set (signer, approver etc.)

Status
status string

Current status of the agreement from the perspective of the user

ID
id string

The ID of the participant set

Name
name string

The name of the participant set

Private Message
privateMessage string

Private message for the participants in the set

MegaSignChildAgreementsFileInfo

File info containing per child agreement information of megaSign.

Name Path Type Description
Child Agreements File ID
childAgreementsInfoFileId string

The ID of the file containing information about the existing childAgreementsInfo of the megaSign.

WidgetWebhookDocument

The information about the document of the widget

Name Path Type Description
ID
id string

The unique ID of the document

Name
name string

The name of the document

WebhookDocument

The information about the document of the agreement

Name Path Type Description
ID
id string

The unique ID of the document

Name
name string

The name of the document

WebhookSupportingDocument

The information about the supporting document

Name Path Type Description
Name
displayLabel string

Display name of the supporting document

Field Name
fieldName string

The name of the supporting document field

ID
id string

The unique ID representing the supporting document

WidgetCcInfo

The information about the CC of the widget

Name Path Type Description
Email
email string

Email of the CC participant of the widget

MegaSignCcInfo

The information about the CC of the mega sign

Name Path Type Description
Email
email string

Email of the CC participant of the megasign

CcInfo

The information about the CC of the agreement

Name Path Type Description
Email
email string

The email of the CC of the agreement

Label
label string

The label of the CC list as returned in workflow description

Visible Pages
visiblePages array of string

The pages that are visible to the CC

WidgetParticipantSetInfo

Name Path Type Description
Role
role string

Role assumed by all participants in the set (signer, approver etc.)

ID
id string

The unique identifier of the participant set

Member Infos
memberInfos array of MemberInfos

The information about the participant members

Order
order integer

Index indicating sequential signing group (specified for hybrid routing)

MemberInfos

Name Path Type Description
ID
id string

The unique Id of the participant

Email
email string

The email of the participant

Company
company string

The company of the participant

Name
name string

The name of the participant

Private Message
privateMessage string

The private message of the participant

Status
status string

The status of the participant

LibraryDocumentCreationResponseV6

A JSON object describing the library template

Name Path Type Description
Library Template Id
id string

The unique ID that can be used to refer to the library template

LibraryDocument

Name Path Type Description
Library Template Id
id string

The unique identifier that is used to refer to the library template

Hidden
hidden boolean

True if Library Document is hidden

Template Type(s)
templateTypes array of string

A list of one or more library template types

Modified Date
modifiedDate date

The day on which the library template was last modified

Library Template Name
name string

The name of the library template

Template Sharing Mode
sharingMode string

The scope of visibility of the library template

Creator Email
creatorEmail string

Email address of the library document creator.

Group ID
groupId string

The unique identifier of the group to which the library template belongs to.

Status
status string

Status of the library document

LibraryDocuments

A JSON that contains the library template array object

Name Path Type Description
page
page page

Pagination information for navigating through the response

Library Templates List
libraryDocumentList array of LibraryDocument

A list of library template items

binary

This is the basic data type 'binary'.

file

This is the basic data type 'file'.