Connectors Reference
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.
|
Status: Production |
Tier: Standard |
Version: 3.0.0 |
|
Name |
Summary |
|
GetAllAgreements ([internal][Optional]string x-api-client-id) |
Get a list of all agreements (Old) |
|
Get a list of all agreements |
|
|
GetAgreementFormFieldData ([internal]string x-api-client-id, string agreementId) |
Get form field data of agreement (Old) |
|
GetAgreementFormFieldData_V2 ([internal]string x-api-client-id, string agreementId) |
Get form field data of agreement |
|
Create an agreement from an uploaded document and send for signature (Old) |
|
|
Create an agreement from an uploaded document and send for signature |
|
|
Create an agreement from a library template and send for signature (Old) |
|
|
Create an agreement from a library template and send for signature |
|
|
Create an agreement from a document URL and send for signature (Old) |
|
|
Create an agreement from a document URL and send for signature |
|
|
GetAgreementInfo ([internal]string x-api-client-id, string agreementId) |
Get the status of an agreement |
|
GetAgreementInfo_V2 (string agreementId, [internal]string x-api-client-id) |
Get the status of an agreement |
|
Get a list of all the document IDs from an agreement |
|
|
Get a list of all the document IDs from an agreement |
|
|
Get a PDF of a signed agreement |
|
|
Get a PDF of a signed agreement |
|
|
GetDocument ([internal]string x-api-client-id, string agreementId, string documentId) |
Get a document from an agreement |
|
GetDocument_V2 (string agreementId, string documentId, [internal]string x-api-client-id) |
Get a document from an agreement |
|
GetSigningUrls (string agreementId, [internal]string x-api-client-id) |
Retrieve the Signing URL |
|
Get a list of all library templates (Old) |
|
|
Get a list of all library templates |
|
|
Create a library template from an uploaded document (Old) |
|
|
Create a library template from an uploaded document |
|
|
Create a library template from a document URL (Old) |
|
|
Create a library template from a document URL |
|
|
CreateTransientDocument ([internal]string x-api-client-id, string File-Name, file File) |
Upload a document and get a document ID (Old) |
|
CreateTransientDocument_V2 ([internal]string x-api-client-id, string File-Name, file File) |
Upload a document and get a document ID |
|
DeleteWebhook (string webhookId, [internal]string x-api-client-id) |
Deletes a webhook |
|
|
|
|
|
|
Name |
Summary |
|
When a new agreement is created |
|
|
When an agreement is sent to a participant |
|
|
When an agreement workflow is completed successfully |
|
|
When the state of an agreement changes |
|
|
When an event occurs |
|
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: Get a list of all agreements (Old)
Description: This operation fetches the list of all agreements of the user.
Syntax:
AdobeSign.GetAllAgreements ([internal][Optional]string x-api-client-id)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
x-api-client-id |
string
|
Microsoft Power Automate Integration |
False |
Returns:
Type:UserAgreements
Description: A JSON that contains the user agreement array object
Summary: Get a list of all agreements
Description: This operation fetches the list of all agreements of the user.
Syntax:
AdobeSign.GetAllAgreements_V2 ([internal][Optional]string x-api-client-id, [advanced][Optional]string cursor, [advanced][Optional]integer pageSize)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
x-api-client-id |
string
|
Microsoft Power Automate Integration |
False |
|
|
cursor |
string (Cursor) |
Used to navigate through the pages. If not provided, returns the first page. |
False |
|
|
pageSize |
integer (Page Size) |
Number of items in the response page. By default: 100; Max: 10000 |
False |
Returns:
Type:userAgreementListV6
Description: A JSON that contains the user agreement array object
Summary: Get form field data of agreement (Old)
Description: Retrieves data entered into the interactive form fields of the agreement.
Syntax:
AdobeSign.GetAgreementFormFieldData ([internal]string x-api-client-id, string agreementId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
x-api-client-id |
string
|
Microsoft Power Automate Integration |
True |
|
|
agreementId |
string (Agreement ID) |
The agreement ID of the agreement whose information is needed |
True |
Returns:
Type:file
Summary: Get form field data of agreement
Description: Retrieves data entered into the interactive form fields of the agreement.
Syntax:
AdobeSign.GetAgreementFormFieldData_V2 ([internal]string x-api-client-id, string agreementId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
x-api-client-id |
string
|
Microsoft Power Automate Integration |
True |
|
|
agreementId |
string (Agreement ID) |
The agreement ID of the agreement whose information is needed |
True |
Returns:
Type:string(binary)
Summary: Form Data Content
Description: The content of the Form Data
Summary: Create an agreement from an uploaded document and send for signature (Old)
Description: This operation creates an agreement from a document uploaded in Adobe Sign and sends it for signature.
Syntax:
AdobeSign.CreateAgreementById ([internal]string x-api-client-id, AgreementCreationInfoId AgreementCreationInfoId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
x-api-client-id |
string
|
Microsoft Power Automate Integration |
True |
|
|
AgreementCreationInfoId |
|
|
True |
Returns:
Type:AgreementCreationResponse
Description: A JSON that contains the ID of the newly created agreement
Summary: Create an agreement from an uploaded document and send for signature
Description: This operation creates an agreement from a document uploaded in Adobe Sign and sends it for signature.
Syntax:
AdobeSign.CreateAgreementById_V2 ([internal]string x-api-client-id, AgreementCreationInfoIdV6 AgreementCreationInfoIdV6)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
x-api-client-id |
string
|
Microsoft Power Automate Integration |
True |
|
|
AgreementCreationInfoIdV6 |
|
|
True |
Returns:
Type:AgreementCreationResponseV6
Description: A JSON that contains the ID of the newly created agreement
Summary: Create an agreement from a library template and send for signature (Old)
Description: This operation creates an agreement from a template stored in the user's Adobe Sign library and sends it for signature.
Syntax:
AdobeSign.CreateAgreementByTemplate ([internal]string x-api-client-id, AgreementCreationInfoTemplate AgreementCreationInfoTemplate)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
x-api-client-id |
string
|
Microsoft Power Automate Integration |
True |
|
|
AgreementCreationInfoTemplate |
|
|
True |
Returns:
Type:AgreementCreationResponse
Description: A JSON that contains the ID of the newly created agreement
Summary: Create an agreement from a library template and send for signature
Description: This operation creates an agreement from a template stored in the user's Adobe Sign library and sends it for signature.
Syntax:
AdobeSign.CreateAgreementByTemplate_V2 ([internal]string x-api-client-id, AgreementCreationInfoTemplateV6 AgreementCreationInfoTemplateV6)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
x-api-client-id |
string
|
Microsoft Power Automate Integration |
True |
|
|
AgreementCreationInfoTemplateV6 |
AgreementCreationInfoTemplateV6
|
|
True |
Returns:
Type:AgreementCreationResponseV6
Description: A JSON that contains the ID of the newly created agreement
Summary: Create an agreement from a document URL and send for signature (Old)
Description: This operation creates an agreement from a document uploaded in Adobe Sign and sends it for signature.
Syntax:
AdobeSign.CreateAgreementByUrl ([internal]string x-api-client-id, AgreementCreationInfoUrl AgreementCreationInfoUrl)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
x-api-client-id |
string
|
Microsoft Power Automate Integration |
True |
|
|
AgreementCreationInfoUrl |
|
|
True |
Returns:
Type:AgreementCreationResponse
Description: A JSON that contains the ID of the newly created agreement
Summary: Create an agreement from a document URL and send for signature
Description: This operation creates an agreement from a document uploaded in Adobe Sign and sends it for signature.
Syntax:
AdobeSign.CreateAgreementByUrl_V2 ([internal]string x-api-client-id, AgreementCreationInfoUrlV6 AgreementCreationInfoUrlV6)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
x-api-client-id |
string
|
Microsoft Power Automate Integration |
True |
|
|
AgreementCreationInfoUrlV6 |
|
|
True |
Returns:
Type:AgreementCreationResponseV6
Description: A JSON that contains the ID of the newly created agreement
Summary: Get the status of an agreement
Description: This operation fetches all the current information of an agreement, like status.
Syntax:
AdobeSign.GetAgreementInfo ([internal]string x-api-client-id, string agreementId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
x-api-client-id |
string
|
Microsoft Power Automate Integration |
True |
|
|
agreementId |
string (Agreement ID) |
The agreement ID of the agreement whose information is needed |
True |
Returns:
Type:AgreementInfo
Description: The complete details about the agreement
Summary: Get the status of an agreement
Description: This operation fetches all the current information of an agreement, like status.
Syntax:
AdobeSign.GetAgreementInfo_V2 (string agreementId, [internal]string x-api-client-id)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
agreementId |
string (Agreement ID) |
The agreement ID of the agreement whose information is needed |
True |
|
|
x-api-client-id |
string
|
Microsoft Power Automate Integration |
True |
Returns:
Type:AgreementInfoV6
Description: Complete Agreement Details
Summary: Get a list of all the document IDs from an agreement
Description: This operation fetches the IDs of all documents and supporting documents of an agreement.
Syntax:
AdobeSign.GetAllDocumentsofAnAgreement ([internal]string x-api-client-id, string agreementId, [advanced][Optional]string supportingDocumentContentFormat)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
x-api-client-id |
string
|
Microsoft Power Automate Integration |
True |
|
|
agreementId |
string (Agreement ID) |
The agreement ID of the agreement whose documents are needed |
True |
|
|
supportingDocumentContentFormat |
string (Supporting documents - Content Type)Values: [ORIGINAL, CONVERTED_PDF] |
Content type of the supporting documents of the agreement |
False |
Returns:
Type:AgreementDocuments
Description: A JSON that contains both the documents and supporting documents array objects
Summary: Get a list of all the document IDs from an agreement
Description: This operation fetches the IDs of all documents and supporting documents of an agreement.
Syntax:
AdobeSign.GetAllDocumentsofAnAgreement_V2 (string agreementId, [advanced][Optional]string supportingDocumentContentFormat, [internal]string x-api-client-id)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
agreementId |
string (Agreement ID) |
The agreement ID of the agreement whose documents are needed |
True |
|
|
supportingDocumentContentFormat |
string (Supporting documents - Content Type)Values: [ORIGINAL, CONVERTED_PDF] |
Content type of the supporting documents of the agreement |
False |
|
|
x-api-client-id |
string
|
Microsoft Power Automate Integration |
True |
Returns:
Type:AgreementDocumentsV6
Description: A JSON that contains both the documents and supporting documents array objects
Summary: Get a PDF of a signed agreement
Description: 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.
Syntax:
AdobeSign.GetCombinedDocument ([internal]string x-api-client-id, string agreementId, [advanced][Optional]boolean attachSupportingDocuments, [advanced][Optional]boolean auditReport)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
x-api-client-id |
string
|
Microsoft Power Automate Integration |
True |
|
|
agreementId |
string (Agreement ID) |
The agreement ID as provided by the action that creates the agreement |
True |
|
|
attachSupportingDocuments |
boolean (Attach Supporting Documents?) |
If true, attach supporting documents to the signed agreement PDF |
False |
|
|
auditReport |
boolean (Attach Audit Report?) |
If true, attach an audit report to the signed agreement PDF |
False |
Returns:
Type:string(binary)File Content
Title: File Content
Description: The file stream of the document
Summary: Get a PDF of a signed agreement
Description: 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.
Syntax:
AdobeSign.GetCombinedDocument_V2 (string agreementId, [advanced][Optional]boolean attachSupportingDocuments, [advanced][Optional]boolean attachAuditReport, [internal]string x-api-client-id)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
agreementId |
string (Agreement ID) |
The agreement ID as provided by the action that creates the agreement |
True |
|
|
attachSupportingDocuments |
boolean (Attach Supporting Documents?) |
If true, attach supporting documents to the signed agreement PDF |
False |
|
|
attachAuditReport |
boolean (Attach Audit Report?) |
If true, attach an audit report to the signed agreement PDF |
False |
|
|
x-api-client-id |
string
|
Microsoft Power Automate Integration |
True |
Returns:
Type:string(binary)File Content
Title: File Content
Description: The file stream of the document
Summary: Get a document from an agreement
Description: This operation fetches the file stream of a specific document of the agreement.
Syntax:
AdobeSign.GetDocument ([internal]string x-api-client-id, string agreementId, string documentId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
x-api-client-id |
string
|
Microsoft Power Automate Integration |
True |
|
|
agreementId |
string (Agreement ID) |
The agreement ID of the agreement whose document is needed |
True |
|
|
documentId |
string (Document ID) |
The document ID of the specific document of the agreement |
True |
Returns:
Type:string(binary)File Content
Title: File Content
Description: The file stream of the document
Summary: Get a document from an agreement
Description: This operation fetches the file stream of a specific document of the agreement.
Syntax:
AdobeSign.GetDocument_V2 (string agreementId, string documentId, [internal]string x-api-client-id)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
agreementId |
string (Agreement ID) |
The agreement ID of the agreement whose document is needed |
True |
|
|
documentId |
string (Document ID) |
The document ID of the specific document of the agreement |
True |
|
|
x-api-client-id |
string
|
Microsoft Power Automate Integration |
True |
Returns:
Type:string(binary)File Content
Title: File Content
Description: The file stream of the document
Summary: Retrieve the Signing URL
Description: This operation retrieves the URL for the e-sign page for the current signer(s) of an agreement.
Syntax:
AdobeSign.GetSigningUrls (string agreementId, [internal]string x-api-client-id)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
agreementId |
string (Agreement ID) |
The agreement ID as provided by the action that creates the agreement |
True |
|
|
x-api-client-id |
string
|
Microsoft Power Automate Integration |
True |
Returns:
Type:SigningUrlResponse
Summary: Get a list of all library templates (Old)
Description: This operation fetches the list of all documents stored as templates in the Adobe Sign library of the user.
Syntax:
AdobeSign.GetLibraryDocuments ([internal][Optional]string x-api-client-id, [internal][Optional]string libraryTemplateType)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
x-api-client-id |
string
|
Microsoft Power Automate Integration |
False |
|
|
libraryTemplateType |
string (Library Template Type) |
External ID for which you would like to retrieve agreement information. |
False |
Returns:
Type:DocumentLibraryItems
Description: A JSON that contains the library template array object
Summary: Get a list of all library templates
Description: This operation fetches the list of all documents stored as templates in the Adobe Sign library of the user.
Syntax:
AdobeSign.GetLibraryDocuments_V2 ([internal][Optional]string x-api-client-id, [advanced][Optional]string cursor, [advanced][Optional]integer pageSize, [internal][Optional]string libraryTemplateType)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
x-api-client-id |
string
|
Microsoft Power Automate Integration |
False |
|
|
cursor |
string (Cursor) |
Used to navigate through the pages. If not provided, returns the first page. |
False |
|
|
pageSize |
integer (Page Size) |
Number of items in the response page. By default: 100; Max: 10000 |
False |
|
|
libraryTemplateType |
string (Library Template Type) |
External ID for which you would like to retrieve agreement information. |
False |
Returns:
Type:LibraryDocuments
Description: A JSON that contains the library template array object
Summary: Create a library template from an uploaded document (Old)
Description: This operation creates a template in Adobe Sign library from an uploaded document. Use this template for sending agreements.
Syntax:
AdobeSign.CreateLibraryDocumentById ([internal]string x-api-client-id, LibraryCreationInfoId LibraryCreationInfoId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
x-api-client-id |
string
|
Microsoft Power Automate Integration |
True |
|
|
LibraryCreationInfoId |
|
|
True |
Returns:
Type:LibraryDocumentCreationResponse
Description: A JSON object describing the library template
Summary: Create a library template from an uploaded document
Description: This operation creates a template in Adobe Sign library from an uploaded document. Use this template for sending agreements.
Syntax:
AdobeSign.CreateLibraryDocumentById_V2 ([internal]string x-api-client-id, LibraryDocumentInfoId LibraryDocumentInfoId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
x-api-client-id |
string
|
Microsoft Power Automate Integration |
True |
|
|
LibraryDocumentInfoId |
|
|
True |
Returns:
Type:LibraryDocumentCreationResponseV6
Description: A JSON object describing the library template
Summary: Create a library template from a document URL (Old)
Description: This operation creates a template in Adobe Sign library from a document URL. Use this template for sending agreements
Syntax:
AdobeSign.CreateLibraryDocumentByUrl ([internal]string x-api-client-id, LibraryCreationInfoUrl LibraryCreationInfoUrl)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
x-api-client-id |
string
|
Microsoft Power Automate Integration |
True |
|
|
LibraryCreationInfoUrl |
|
|
True |
Returns:
Type:LibraryDocumentCreationResponse
Description: A JSON object describing the library template
Summary: Create a library template from a document URL
Description: This operation creates a template in Adobe Sign library from a document URL. Use this template for sending agreements
Syntax:
AdobeSign.CreateLibraryDocumentByUrl_V2 ([internal]string x-api-client-id, LibraryDocumentInfoUrl LibraryDocumentInfoUrl)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
x-api-client-id |
string
|
Microsoft Power Automate Integration |
True |
|
|
LibraryDocumentInfoUrl |
|
|
True |
Returns:
Type:LibraryDocumentCreationResponseV6
Description: A JSON object describing the library template
Summary: Upload a document and get a document ID (Old)
Description: 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.
Syntax:
AdobeSign.CreateTransientDocument ([internal]string x-api-client-id, string File-Name, file File)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
x-api-client-id |
string
|
Microsoft Power Automate Integration |
True |
|
|
File-Name |
string (File Name) |
The name of the document to be uploaded, with extension |
True |
|
|
File |
(File Content) |
The file stream of the document to be uploaded |
True |
Returns:
Type:TransientDocumentResponse
Description: A JSON that contains the ID of the uploaded document
Summary: Upload a document and get a document ID
Description: 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.
Syntax:
AdobeSign.CreateTransientDocument_V2 ([internal]string x-api-client-id, string File-Name, file File)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
x-api-client-id |
string
|
Microsoft Power Automate Integration |
True |
|
|
File-Name |
string (File Name) |
The name of the document to be uploaded, with extension |
True |
|
|
File |
(File Content) |
The file stream of the document to be uploaded |
True |
Returns:
Type:TransientDocumentResponse
Description: A JSON that contains the ID of the uploaded document
Summary: Deletes a webhook
Description: Deletes a webhook.
Syntax:
AdobeSign.DeleteWebhook (string webhookId, [internal]string x-api-client-id)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
webhookId |
string (Webhook Id) |
The ID of the webhook |
True |
|
|
x-api-client-id |
string
|
Microsoft Power Automate Integration |
True |
Returns:
Summary:
Description:
Syntax:
AdobeSign.WebhookEcho ()
Returns:
Summary:
Description:
Syntax:
AdobeSign.WebhookResponse ()
Returns:
Summary: When a new agreement is created
Description: Triggers a new flow when a new agreement is created.
Syntax:
AdobeSign.CreateWebhookForAgreementCreatedEvent (WebhookCreationInfoForAgreementCreatedEvent WebhookCreationInfo, [internal]string x-api-client-id)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
WebhookCreationInfo |
WebhookCreationInfoForAgreementCreatedEvent
|
|
True |
|
|
x-api-client-id |
string
|
Microsoft Power Automate Integration |
True |
Returns:
Description: A JSON that contains the ID of the newly created webhook
Summary: When an agreement is sent to a participant
Description: Triggers a new flow when an agreement is sent to a participant.
Syntax:
AdobeSign.CreateWebhookForAgreementSignatureRequestedEvent (WebhookCreationInfoForAgreementSignatureRequestedEvent WebhookCreationInfo, [internal]string x-api-client-id)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
WebhookCreationInfo |
WebhookCreationInfoForAgreementSignatureRequestedEvent
|
|
True |
|
|
x-api-client-id |
string
|
Microsoft Power Automate Integration |
True |
Returns:
Description: A JSON that contains the ID of the newly created webhook
Summary: When an agreement workflow is completed successfully
Description: Triggers a new flow when an agreement workflow is completed successfully
Syntax:
AdobeSign.CreateWebhookForAgreementSignedEvent (WebhookCreationInfoForAgreementWorkflowCompletedEvent WebhookCreationInfo, [internal]string x-api-client-id)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
WebhookCreationInfo |
WebhookCreationInfoForAgreementWorkflowCompletedEvent
|
|
True |
|
|
x-api-client-id |
string
|
Microsoft Power Automate Integration |
True |
Returns:
Description: A JSON that contains the ID of the newly created webhook
Summary: When the state of an agreement changes
Description: Triggers a new flow when the status of an agreement changes. Covers most common Agreement events such as creation, completion, etc.
Syntax:
AdobeSign.CreateWebhookForAgreementStatusUpdated (WebhookCreationInfoStatusChange WebhookCreationInfo, [internal]string x-api-client-id)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
WebhookCreationInfo |
WebhookCreationInfoStatusChange
|
|
True |
|
|
x-api-client-id |
string
|
Microsoft Power Automate Integration |
True |
Returns:
Description: A JSON that contains the ID of the newly created webhook
Summary: When an event occurs
Description: Triggers a new flow when an event occurs. Covers all Agreement, Mega Sign and Widget events.
Syntax:
AdobeSign.CreateWebhookGeneric (WebhookCreationInfoGeneric WebhookCreationInfo, [internal]string x-api-client-id)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
WebhookCreationInfo |
|
|
True |
|
|
x-api-client-id |
string
|
Microsoft Power Automate Integration |
True |
Returns:
Description: A JSON that contains the ID of the newly created webhook
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
documentCreationInfo |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
name |
string
|
The name of the agreement |
|
fileInfos1 |
|
|
|
signatureType |
string
|
The type of signature you would like to request - E-signature or Written Values: [E-Signature, Written Signature] |
|
recipientSetInfos1 |
|
|
|
message |
string
|
An optional message to the recipients requesting their action |
|
daysUntilSigningDeadline |
integer
|
The number of days that remain before the document expires |
|
reminderFrequency |
string
|
How often do you want to send reminders? Values: [DAILY_UNTIL_SIGNED, WEEKLY_UNTIL_SIGNED] |
|
securityOptions |
|
Sets optional secondary security parameters for your document |
|
fileInfos2 |
|
|
|
fileInfos3 |
|
|
|
fileInfos4 |
|
|
|
fileInfos5 |
|
|
|
fileInfos6 |
|
|
|
fileInfos7 |
|
|
|
fileInfos8 |
|
|
|
fileInfos9 |
|
|
|
fileInfos10 |
|
|
|
recipientSetInfos2 |
|
|
|
recipientSetInfos3 |
|
|
|
recipientSetInfos4 |
|
|
|
recipientSetInfos5 |
|
|
|
recipientSetInfos6 |
|
|
|
recipientSetInfos7 |
|
|
|
recipientSetInfos8 |
|
|
|
recipientSetInfos9 |
|
|
|
recipientSetInfos10 |
|
|
|
recipientSetInfos11 |
|
|
|
recipientSetInfos12 |
|
|
|
recipientSetInfos13 |
|
|
|
recipientSetInfos14 |
|
|
|
recipientSetInfos15 |
|
|
|
recipientSetInfos16 |
|
|
|
recipientSetInfos17 |
|
|
|
recipientSetInfos18 |
|
|
|
recipientSetInfos19 |
|
|
|
recipientSetInfos20 |
|
|
|
recipientSetInfos21 |
|
|
|
recipientSetInfos22 |
|
|
|
recipientSetInfos23 |
|
|
|
recipientSetInfos24 |
|
|
|
recipientSetInfos25 |
|
|
|
mergeFieldInfo1 |
|
|
|
mergeFieldInfo2 |
|
|
|
mergeFieldInfo3 |
|
|
|
mergeFieldInfo4 |
|
|
|
mergeFieldInfo5 |
|
|
|
mergeFieldInfo6 |
|
|
|
mergeFieldInfo7 |
|
|
|
mergeFieldInfo8 |
|
|
|
mergeFieldInfo9 |
|
|
|
mergeFieldInfo10 |
|
|
|
mergeFieldInfo11 |
|
|
|
mergeFieldInfo12 |
|
|
|
mergeFieldInfo13 |
|
|
|
mergeFieldInfo14 |
|
|
|
mergeFieldInfo15 |
|
|
|
mergeFieldInfo16 |
|
|
|
mergeFieldInfo17 |
|
|
|
mergeFieldInfo18 |
|
|
|
mergeFieldInfo19 |
|
|
|
mergeFieldInfo20 |
|
|
|
mergeFieldInfo21 |
|
|
|
mergeFieldInfo22 |
|
|
|
mergeFieldInfo23 |
|
|
|
mergeFieldInfo24 |
|
|
|
mergeFieldInfo25 |
|
|
|
mergeFieldInfo26 |
|
|
|
mergeFieldInfo27 |
|
|
|
mergeFieldInfo28 |
|
|
|
mergeFieldInfo29 |
|
|
|
mergeFieldInfo30 |
|
|
|
mergeFieldInfo31 |
|
|
|
mergeFieldInfo32 |
|
|
|
mergeFieldInfo33 |
|
|
|
mergeFieldInfo34 |
|
|
|
mergeFieldInfo35 |
|
|
|
mergeFieldInfo36 |
|
|
|
mergeFieldInfo37 |
|
|
|
mergeFieldInfo38 |
|
|
|
mergeFieldInfo39 |
|
|
|
mergeFieldInfo40 |
|
|
|
mergeFieldInfo41 |
|
|
|
mergeFieldInfo42 |
|
|
|
mergeFieldInfo43 |
|
|
|
mergeFieldInfo44 |
|
|
|
mergeFieldInfo45 |
|
|
|
mergeFieldInfo46 |
|
|
|
mergeFieldInfo47 |
|
|
|
mergeFieldInfo48 |
|
|
|
mergeFieldInfo49 |
|
|
|
mergeFieldInfo50 |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
transientDocumentId |
string
|
The document ID received by uploading a document |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
recipientSetMemberInfos1 |
|
|
|
signingOrder |
integer
|
Index starting with 1, that tells the order in which this recipient signs |
|
recipientSetRole |
string
|
Specify the role of recipient Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
|
string
|
Email of the recipient |
Summary:
Description: Sets optional secondary security parameters for your document
Properties:
|
Name |
Type |
Summary |
|
protectOpen |
boolean
|
Should the signed agreement PDF be encrypted using a password? |
|
openPassword |
string
|
The password that should be used to encrypt the signed agreement PDF |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
transientDocumentId |
string
|
The document ID received by uploading a document |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
transientDocumentId |
string
|
The document ID received by uploading a document |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
transientDocumentId |
string
|
The document ID received by uploading a document |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
transientDocumentId |
string
|
The document ID received by uploading a document |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
transientDocumentId |
string
|
The document ID received by uploading a document |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
transientDocumentId |
string
|
The document ID received by uploading a document |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
transientDocumentId |
string
|
The document ID received by uploading a document |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
transientDocumentId |
string
|
The document ID received by uploading a document |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
transientDocumentId |
string
|
The document ID received by uploading a document |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
recipientSetMemberInfos1 |
|
|
|
signingOrder |
integer
|
Index starting with 1, that tells the order in which this recipient signs |
|
recipientSetRole |
string
|
Specify the role of recipient Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
|
string
|
Email of the recipient |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
recipientSetMemberInfos1 |
|
|
|
signingOrder |
integer
|
Index starting with 1, that tells the order in which this recipient signs |
|
recipientSetRole |
string
|
Specify the role of recipient Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
|
string
|
Email of the recipient |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
recipientSetMemberInfos1 |
|
|
|
signingOrder |
integer
|
Index starting with 1, that tells the order in which this recipient signs |
|
recipientSetRole |
string
|
Specify the role of recipient Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
|
string
|
Email of the recipient |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
recipientSetMemberInfos1 |
|
|
|
signingOrder |
integer
|
Index starting with 1, that tells the order in which this recipient signs |
|
recipientSetRole |
string
|
Specify the role of recipient Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
|
string
|
Email of the recipient |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
recipientSetMemberInfos1 |
|
|
|
signingOrder |
integer
|
Index starting with 1, that tells the order in which this recipient signs |
|
recipientSetRole |
string
|
Specify the role of recipient Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
|
string
|
Email of the recipient |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
recipientSetMemberInfos1 |
|
|
|
signingOrder |
integer
|
Index starting with 1, that tells the order in which this recipient signs |
|
recipientSetRole |
string
|
Specify the role of recipient Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
|
string
|
Email of the recipient |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
recipientSetMemberInfos1 |
|
|
|
signingOrder |
integer
|
Index starting with 1, that tells the order in which this recipient signs |
|
recipientSetRole |
string
|
Specify the role of recipient Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
|
string
|
Email of the recipient |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
recipientSetMemberInfos1 |
|
|
|
signingOrder |
integer
|
Index starting with 1, that tells the order in which this recipient signs |
|
recipientSetRole |
string
|
Specify the role of recipient Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
|
string
|
Email of the recipient |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
recipientSetMemberInfos1 |
|
|
|
signingOrder |
integer
|
Index starting with 1, that tells the order in which this recipient signs |
|
recipientSetRole |
string
|
Specify the role of recipient Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
|
string
|
Email of the recipient |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
recipientSetMemberInfos1 |
|
|
|
signingOrder |
integer
|
Index starting with 1, that tells the order in which this recipient signs |
|
recipientSetRole |
string
|
Specify the role of recipient Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
|
string
|
Email of the recipient |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
recipientSetMemberInfos1 |
|
|
|
signingOrder |
integer
|
Index starting with 1, that tells the order in which this recipient signs |
|
recipientSetRole |
string
|
Specify the role of recipient Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
|
string
|
Email of the recipient |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
recipientSetMemberInfos1 |
|
|
|
signingOrder |
integer
|
Index starting with 1, that tells the order in which this recipient signs |
|
recipientSetRole |
string
|
Specify the role of recipient Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
|
string
|
Email of the recipient |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
recipientSetMemberInfos1 |
|
|
|
signingOrder |
integer
|
Index starting with 1, that tells the order in which this recipient signs |
|
recipientSetRole |
string
|
Specify the role of recipient Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
|
string
|
Email of the recipient |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
recipientSetMemberInfos1 |
|
|
|
signingOrder |
integer
|
Index starting with 1, that tells the order in which this recipient signs |
|
recipientSetRole |
string
|
Specify the role of recipient Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
|
string
|
Email of the recipient |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
recipientSetMemberInfos1 |
|
|
|
signingOrder |
integer
|
Index starting with 1, that tells the order in which this recipient signs |
|
recipientSetRole |
string
|
Specify the role of recipient Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
|
string
|
Email of the recipient |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
recipientSetMemberInfos1 |
|
|
|
signingOrder |
integer
|
Index starting with 1, that tells the order in which this recipient signs |
|
recipientSetRole |
string
|
Specify the role of recipient Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
|
string
|
Email of the recipient |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
recipientSetMemberInfos1 |
|
|
|
signingOrder |
integer
|
Index starting with 1, that tells the order in which this recipient signs |
|
recipientSetRole |
string
|
Specify the role of recipient Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
|
string
|
Email of the recipient |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
recipientSetMemberInfos1 |
|
|
|
signingOrder |
integer
|
Index starting with 1, that tells the order in which this recipient signs |
|
recipientSetRole |
string
|
Specify the role of recipient Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
|
string
|
Email of the recipient |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
recipientSetMemberInfos1 |
|
|
|
signingOrder |
integer
|
Index starting with 1, that tells the order in which this recipient signs |
|
recipientSetRole |
string
|
Specify the role of recipient Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
|
string
|
Email of the recipient |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
recipientSetMemberInfos1 |
|
|
|
signingOrder |
integer
|
Index starting with 1, that tells the order in which this recipient signs |
|
recipientSetRole |
string
|
Specify the role of recipient Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
|
string
|
Email of the recipient |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
recipientSetMemberInfos1 |
|
|
|
signingOrder |
integer
|
Index starting with 1, that tells the order in which this recipient signs |
|
recipientSetRole |
string
|
Specify the role of recipient Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
|
string
|
Email of the recipient |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
recipientSetMemberInfos1 |
|
|
|
signingOrder |
integer
|
Index starting with 1, that tells the order in which this recipient signs |
|
recipientSetRole |
string
|
Specify the role of recipient Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
|
string
|
Email of the recipient |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
recipientSetMemberInfos1 |
|
|
|
signingOrder |
integer
|
Index starting with 1, that tells the order in which this recipient signs |
|
recipientSetRole |
string
|
Specify the role of recipient Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
|
string
|
Email of the recipient |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
recipientSetMemberInfos1 |
|
|
|
signingOrder |
integer
|
Index starting with 1, that tells the order in which this recipient signs |
|
recipientSetRole |
string
|
Specify the role of recipient Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
|
string
|
Email of the recipient |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
name |
string Agreement Name |
The name of the agreement |
|
fileInfos |
array of (DocumentFileInfoId) Document |
Provide transient document id, library document or a public URL of document |
|
signatureType |
string Signature Type |
The type of signature you would like to request - e-signature or written Values: [ESIGN, WRITTEN] |
|
participantSetsInfo |
array of (ParticipantCreateSetInfoV6) Participant |
A list of one or more participant who will act upon this agreement |
|
message |
string Message |
An optional message to the recipients requesting their action |
|
daysUntilSigningDeadline |
integer Days to Deadline |
The number of days that remain before the document expires |
|
expirationTime |
string Expiration Time |
Time after which Agreement expires. Example: 2020-12-31T23:59:00Z |
|
reminderFrequency |
string Reminder Frequency |
How often do you want to send reminders ? Values: [DAILY_UNTIL_SIGNED, WEEKLY_UNTIL_SIGNED] |
|
securityOption |
|
Sets optional secondary security parameters for your document |
|
mergeFieldInfo |
array of (MergefieldInfo) Form Field |
Optional default values for form fields to merge into the document |
|
postSignOption |
|
|
|
state |
string
|
The state in which the agreement should land. Values: [AUTHORING, DRAFT, IN_PROCESS] |
Summary:
Description: Sets optional secondary security parameters for your document
Properties:
|
Name |
Type |
Summary |
|
openPassword |
string Document Password |
The password that should be used to encrypt the signed agreement PDF |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
documentCreationInfo |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
name |
string
|
The name of the agreement |
|
fileInfos1 |
|
|
|
signatureType |
string
|
The type of signature you would like to request - E-signature or Written Values: [E-Signature, Written Signature] |
|
recipientSetInfos1 |
|
|
|
message |
string
|
An optional message to the recipients requesting their action |
|
daysUntilSigningDeadline |
integer
|
The number of days that remain before the document expires |
|
reminderFrequency |
string
|
How often do you want to send reminders? Values: [DAILY_UNTIL_SIGNED, WEEKLY_UNTIL_SIGNED] |
|
securityOptions |
|
Sets optional secondary security parameters for your document |
|
fileInfos2 |
|
|
|
fileInfos3 |
|
|
|
fileInfos4 |
|
|
|
fileInfos5 |
|
|
|
fileInfos6 |
|
|
|
fileInfos7 |
|
|
|
fileInfos8 |
|
|
|
fileInfos9 |
|
|
|
fileInfos10 |
|
|
|
recipientSetInfos2 |
|
|
|
recipientSetInfos3 |
|
|
|
recipientSetInfos4 |
|
|
|
recipientSetInfos5 |
|
|
|
recipientSetInfos6 |
|
|
|
recipientSetInfos7 |
|
|
|
recipientSetInfos8 |
|
|
|
recipientSetInfos9 |
|
|
|
recipientSetInfos10 |
|
|
|
recipientSetInfos11 |
|
|
|
recipientSetInfos12 |
|
|
|
recipientSetInfos13 |
|
|
|
recipientSetInfos14 |
|
|
|
recipientSetInfos15 |
|
|
|
recipientSetInfos16 |
|
|
|
recipientSetInfos17 |
|
|
|
recipientSetInfos18 |
|
|
|
recipientSetInfos19 |
|
|
|
recipientSetInfos20 |
|
|
|
recipientSetInfos21 |
|
|
|
recipientSetInfos22 |
|
|
|
recipientSetInfos23 |
|
|
|
recipientSetInfos24 |
|
|
|
recipientSetInfos25 |
|
|
|
mergeFieldInfo1 |
|
|
|
mergeFieldInfo2 |
|
|
|
mergeFieldInfo3 |
|
|
|
mergeFieldInfo4 |
|
|
|
mergeFieldInfo5 |
|
|
|
mergeFieldInfo6 |
|
|
|
mergeFieldInfo7 |
|
|
|
mergeFieldInfo8 |
|
|
|
mergeFieldInfo9 |
|
|
|
mergeFieldInfo10 |
|
|
|
mergeFieldInfo11 |
|
|
|
mergeFieldInfo12 |
|
|
|
mergeFieldInfo13 |
|
|
|
mergeFieldInfo14 |
|
|
|
mergeFieldInfo15 |
|
|
|
mergeFieldInfo16 |
|
|
|
mergeFieldInfo17 |
|
|
|
mergeFieldInfo18 |
|
|
|
mergeFieldInfo19 |
|
|
|
mergeFieldInfo20 |
|
|
|
mergeFieldInfo21 |
|
|
|
mergeFieldInfo22 |
|
|
|
mergeFieldInfo23 |
|
|
|
mergeFieldInfo24 |
|
|
|
mergeFieldInfo25 |
|
|
|
mergeFieldInfo26 |
|
|
|
mergeFieldInfo27 |
|
|
|
mergeFieldInfo28 |
|
|
|
mergeFieldInfo29 |
|
|
|
mergeFieldInfo30 |
|
|
|
mergeFieldInfo31 |
|
|
|
mergeFieldInfo32 |
|
|
|
mergeFieldInfo33 |
|
|
|
mergeFieldInfo34 |
|
|
|
mergeFieldInfo35 |
|
|
|
mergeFieldInfo36 |
|
|
|
mergeFieldInfo37 |
|
|
|
mergeFieldInfo38 |
|
|
|
mergeFieldInfo39 |
|
|
|
mergeFieldInfo40 |
|
|
|
mergeFieldInfo41 |
|
|
|
mergeFieldInfo42 |
|
|
|
mergeFieldInfo43 |
|
|
|
mergeFieldInfo44 |
|
|
|
mergeFieldInfo45 |
|
|
|
mergeFieldInfo46 |
|
|
|
mergeFieldInfo47 |
|
|
|
mergeFieldInfo48 |
|
|
|
mergeFieldInfo49 |
|
|
|
mergeFieldInfo50 |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
libraryDocumentId |
string
|
Choose a document from the templates stored in your library |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
recipientSetMemberInfos1 |
|
|
|
signingOrder |
integer
|
Index starting with 1, that tells the order in which this recipient signs |
|
recipientSetRole |
string
|
Specify the role of recipient Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
|
string
|
Email of the recipient |
Summary:
Description: Sets optional secondary security parameters for your document
Properties:
|
Name |
Type |
Summary |
|
protectOpen |
boolean
|
Should the signed agreement PDF be encrypted using a password? |
|
openPassword |
string
|
The password that should be used to encrypt the signed agreement PDF |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
libraryDocumentId |
string
|
Choose a document from the templates stored in your library |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
libraryDocumentId |
string
|
Choose a document from the templates stored in your library |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
libraryDocumentId |
string
|
Choose a document from the templates stored in your library |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
libraryDocumentId |
string
|
Choose a document from the templates stored in your library |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
libraryDocumentId |
string
|
Choose a document from the templates stored in your library |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
libraryDocumentId |
string
|
Choose a document from the templates stored in your library |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
libraryDocumentId |
string
|
Choose a document from the templates stored in your library |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
libraryDocumentId |
string
|
Choose a document from the templates stored in your library |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
libraryDocumentId |
string
|
Choose a document from the templates stored in your library |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
recipientSetMemberInfos1 |
|
|
|
signingOrder |
integer
|
Index starting with 1, that tells the order in which this recipient signs |
|
recipientSetRole |
string
|
Specify the role of recipient Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
|
string
|
Email of the recipient |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
recipientSetMemberInfos1 |
|
|
|
signingOrder |
integer
|
Index starting with 1, that tells the order in which this recipient signs |
|
recipientSetRole |
string
|
Specify the role of recipient Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
|
string
|
Email of the recipient |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
recipientSetMemberInfos1 |
|
|
|
signingOrder |
integer
|
Index starting with 1, that tells the order in which this recipient signs |
|
recipientSetRole |
string
|
Specify the role of recipient Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
|
string
|
Email of the recipient |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
recipientSetMemberInfos1 |
|
|
|
signingOrder |
integer
|
Index starting with 1, that tells the order in which this recipient signs |
|
recipientSetRole |
string
|
Specify the role of recipient Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
|
string
|
Email of the recipient |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
recipientSetMemberInfos1 |
|
|
|
signingOrder |
integer
|
Index starting with 1, that tells the order in which this recipient signs |
|
recipientSetRole |
string
|
Specify the role of recipient Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
|
string
|
Email of the recipient |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
recipientSetMemberInfos1 |
|
|
|
signingOrder |
integer
|
Index starting with 1, that tells the order in which this recipient signs |
|
recipientSetRole |
string
|
Specify the role of recipient Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
|
string
|
Email of the recipient |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
recipientSetMemberInfos1 |
|
|
|
signingOrder |
integer
|
Index starting with 1, that tells the order in which this recipient signs |
|
recipientSetRole |
string
|
Specify the role of recipient Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
|
string
|
Email of the recipient |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
recipientSetMemberInfos1 |
|
|
|
signingOrder |
integer
|
Index starting with 1, that tells the order in which this recipient signs |
|
recipientSetRole |
string
|
Specify the role of recipient Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
|
string
|
Email of the recipient |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
recipientSetMemberInfos1 |
|
|
|
signingOrder |
integer
|
Index starting with 1, that tells the order in which this recipient signs |
|
recipientSetRole |
string
|
Specify the role of recipient Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
|
string
|
Email of the recipient |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
recipientSetMemberInfos1 |
|
|
|
signingOrder |
integer
|
Index starting with 1, that tells the order in which this recipient signs |
|
recipientSetRole |
string
|
Specify the role of recipient Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
|
string
|
Email of the recipient |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
recipientSetMemberInfos1 |
|
|
|
signingOrder |
integer
|
Index starting with 1, that tells the order in which this recipient signs |
|
recipientSetRole |
string
|
Specify the role of recipient Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
|
string
|
Email of the recipient |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
recipientSetMemberInfos1 |
|
|
|
signingOrder |
integer
|
Index starting with 1, that tells the order in which this recipient signs |
|
recipientSetRole |
string
|
Specify the role of recipient Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
|
string
|
Email of the recipient |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
recipientSetMemberInfos1 |
|
|
|
signingOrder |
integer
|
Index starting with 1, that tells the order in which this recipient signs |
|
recipientSetRole |
string
|
Specify the role of recipient Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
|
string
|
Email of the recipient |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
recipientSetMemberInfos1 |
|
|
|
signingOrder |
integer
|
Index starting with 1, that tells the order in which this recipient signs |
|
recipientSetRole |
string
|
Specify the role of recipient Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
|
string
|
Email of the recipient |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
recipientSetMemberInfos1 |
|
|
|
signingOrder |
integer
|
Index starting with 1, that tells the order in which this recipient signs |
|
recipientSetRole |
string
|
Specify the role of recipient Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
|
string
|
Email of the recipient |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
recipientSetMemberInfos1 |
|
|
|
signingOrder |
integer
|
Index starting with 1, that tells the order in which this recipient signs |
|
recipientSetRole |
string
|
Specify the role of recipient Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
|
string
|
Email of the recipient |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
recipientSetMemberInfos1 |
|
|
|
signingOrder |
integer
|
Index starting with 1, that tells the order in which this recipient signs |
|
recipientSetRole |
string
|
Specify the role of recipient Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
|
string
|
Email of the recipient |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
recipientSetMemberInfos1 |
|
|
|
signingOrder |
integer
|
Index starting with 1, that tells the order in which this recipient signs |
|
recipientSetRole |
string
|
Specify the role of recipient Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
|
string
|
Email of the recipient |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
recipientSetMemberInfos1 |
|
|
|
signingOrder |
integer
|
Index starting with 1, that tells the order in which this recipient signs |
|
recipientSetRole |
string
|
Specify the role of recipient Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
|
string
|
Email of the recipient |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
recipientSetMemberInfos1 |
|
|
|
signingOrder |
integer
|
Index starting with 1, that tells the order in which this recipient signs |
|
recipientSetRole |
string
|
Specify the role of recipient Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
|
string
|
Email of the recipient |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
recipientSetMemberInfos1 |
|
|
|
signingOrder |
integer
|
Index starting with 1, that tells the order in which this recipient signs |
|
recipientSetRole |
string
|
Specify the role of recipient Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
|
string
|
Email of the recipient |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
recipientSetMemberInfos1 |
|
|
|
signingOrder |
integer
|
Index starting with 1, that tells the order in which this recipient signs |
|
recipientSetRole |
string
|
Specify the role of recipient Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
|
string
|
Email of the recipient |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
recipientSetMemberInfos1 |
|
|
|
signingOrder |
integer
|
Index starting with 1, that tells the order in which this recipient signs |
|
recipientSetRole |
string
|
Specify the role of recipient Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
|
string
|
Email of the recipient |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
recipientSetMemberInfos1 |
|
|
|
signingOrder |
integer
|
Index starting with 1, that tells the order in which this recipient signs |
|
recipientSetRole |
string
|
Specify the role of recipient Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
|
string
|
Email of the recipient |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
name |
string Agreement Name |
The name of the agreement |
|
fileInfos |
array of (DocumentFileInfoTemplate) Library Template |
Provide transient document id, library document or a public URL of document |
|
signatureType |
string Signature Type |
The type of signature you would like to request - e-signature or written Values: [ESIGN, WRITTEN] |
|
participantSetsInfo |
array of (ParticipantCreateSetInfoV6) Participant |
A list of one or more participant who will act upon this agreement |
|
message |
string Message |
An optional message to the recipients requesting their action |
|
daysUntilSigningDeadline |
integer Days to Deadline |
The number of days that remain before the document expires |
|
expirationTime |
string Expiration Time |
Time after which Agreement expires. Example: 2020-12-31T23:59:00Z |
|
reminderFrequency |
string Reminder Frequency |
How often do you want to send reminders ? Values: [DAILY_UNTIL_SIGNED, WEEKLY_UNTIL_SIGNED] |
|
securityOption |
|
Sets optional secondary security parameters for your document |
|
mergeFieldInfo |
array of (MergefieldInfo) Form Field |
Optional default values for form fields to merge into the document |
|
postSignOption |
|
|
|
state |
string
|
The state in which the agreement should land. Values: [AUTHORING, DRAFT, IN_PROCESS] |
Summary:
Description: Sets optional secondary security parameters for your document
Properties:
|
Name |
Type |
Summary |
|
openPassword |
string Document Password |
The password that should be used to encrypt the signed agreement PDF |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
documentCreationInfo |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
name |
string
|
The name of the agreement |
|
fileInfos1 |
|
|
|
signatureType |
string
|
The type of signature you would like to request - E-signature or Written Values: [E-Signature, Written Signature] |
|
recipientSetInfos1 |
|
|
|
message |
string
|
An optional message to the recipients requesting their action |
|
daysUntilSigningDeadline |
integer
|
The number of days that remain before the document expires |
|
reminderFrequency |
string
|
How often do you want to send reminders? Values: [DAILY_UNTIL_SIGNED, WEEKLY_UNTIL_SIGNED] |
|
securityOptions |
|
Sets optional secondary security parameters for your document |
|
fileInfos2 |
|
|
|
fileInfos3 |
|
|
|
fileInfos4 |
|
|
|
fileInfos5 |
|
|
|
fileInfos6 |
|
|
|
fileInfos7 |
|
|
|
fileInfos8 |
|
|
|
fileInfos9 |
|
|
|
fileInfos10 |
|
|
|
recipientSetInfos2 |
|
|
|
recipientSetInfos3 |
|
|
|
recipientSetInfos4 |
|
|
|
recipientSetInfos5 |
|
|
|
recipientSetInfos6 |
|
|
|
recipientSetInfos7 |
|
|
|
recipientSetInfos8 |
|
|
|
recipientSetInfos9 |
|
|
|
recipientSetInfos10 |
|
|
|
recipientSetInfos11 |
|
|
|
recipientSetInfos12 |
|
|
|
recipientSetInfos13 |
|
|
|
recipientSetInfos14 |
|
|
|
recipientSetInfos15 |
|
|
|
recipientSetInfos16 |
|
|
|
recipientSetInfos17 |
|
|
|
recipientSetInfos18 |
|
|
|
recipientSetInfos19 |
|
|
|
recipientSetInfos20 |
|
|
|
recipientSetInfos21 |
|
|
|
recipientSetInfos22 |
|
|
|
recipientSetInfos23 |
|
|
|
recipientSetInfos24 |
|
|
|
recipientSetInfos25 |
|
|
|
mergeFieldInfo1 |
|
|
|
mergeFieldInfo2 |
|
|
|
mergeFieldInfo3 |
|
|
|
mergeFieldInfo4 |
|
|
|
mergeFieldInfo5 |
|
|
|
mergeFieldInfo6 |
|
|
|
mergeFieldInfo7 |
|
|
|
mergeFieldInfo8 |
|
|
|
mergeFieldInfo9 |
|
|
|
mergeFieldInfo10 |
|
|
|
mergeFieldInfo11 |
|
|
|
mergeFieldInfo12 |
|
|
|
mergeFieldInfo13 |
|
|
|
mergeFieldInfo14 |
|
|
|
mergeFieldInfo15 |
|
|
|
mergeFieldInfo16 |
|
|
|
mergeFieldInfo17 |
|
|
|
mergeFieldInfo18 |
|
|
|
mergeFieldInfo19 |
|
|
|
mergeFieldInfo20 |
|
|
|
mergeFieldInfo21 |
|
|
|
mergeFieldInfo22 |
|
|
|
mergeFieldInfo23 |
|
|
|
mergeFieldInfo24 |
|
|
|
mergeFieldInfo25 |
|
|
|
mergeFieldInfo26 |
|
|
|
mergeFieldInfo27 |
|
|
|
mergeFieldInfo28 |
|
|
|
mergeFieldInfo29 |
|
|
|
mergeFieldInfo30 |
|
|
|
mergeFieldInfo31 |
|
|
|
mergeFieldInfo32 |
|
|
|
mergeFieldInfo33 |
|
|
|
mergeFieldInfo34 |
|
|
|
mergeFieldInfo35 |
|
|
|
mergeFieldInfo36 |
|
|
|
mergeFieldInfo37 |
|
|
|
mergeFieldInfo38 |
|
|
|
mergeFieldInfo39 |
|
|
|
mergeFieldInfo40 |
|
|
|
mergeFieldInfo41 |
|
|
|
mergeFieldInfo42 |
|
|
|
mergeFieldInfo43 |
|
|
|
mergeFieldInfo44 |
|
|
|
mergeFieldInfo45 |
|
|
|
mergeFieldInfo46 |
|
|
|
mergeFieldInfo47 |
|
|
|
mergeFieldInfo48 |
|
|
|
mergeFieldInfo49 |
|
|
|
mergeFieldInfo50 |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
documentURL |
|
File at a public URL location |
Summary:
Description: File at a public URL location
Properties:
|
Name |
Type |
Summary |
|
url |
string
|
A publicly accessible URL for retrieving the document |
|
name |
string
|
The name of the referenced document, with extension |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
recipientSetMemberInfos1 |
|
|
|
signingOrder |
integer
|
Index starting with 1, that tells the order in which this recipient signs |
|
recipientSetRole |
string
|
Specify the role of recipient Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
|
string
|
Email of the recipient |
Summary:
Description: Sets optional secondary security parameters for your document
Properties:
|
Name |
Type |
Summary |
|
protectOpen |
boolean
|
Should the signed agreement PDF be encrypted using a password? |
|
openPassword |
string
|
The password that should be used to encrypt the signed agreement PDF |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
documentURL |
|
File at a public URL location |
Summary:
Description: File at a public URL location
Properties:
|
Name |
Type |
Summary |
|
url |
string
|
A publicly accessible URL for retrieving the document |
|
name |
string
|
The name of the referenced document, with extension |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
documentURL |
|
File at a public URL location |
Summary:
Description: File at a public URL location
Properties:
|
Name |
Type |
Summary |
|
url |
string
|
A publicly accessible URL for retrieving the document |
|
name |
string
|
The name of the referenced document, with extension |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
documentURL |
|
File at a public URL location |
Summary:
Description: File at a public URL location
Properties:
|
Name |
Type |
Summary |
|
url |
string
|
A publicly accessible URL for retrieving the document |
|
name |
string
|
The name of the referenced document, with extension |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
documentURL |
|
File at a public URL location |
Summary:
Description: File at a public URL location
Properties:
|
Name |
Type |
Summary |
|
url |
string
|
A publicly accessible URL for retrieving the document |
|
name |
string
|
The name of the referenced document, with extension |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
documentURL |
|
File at a public URL location |
Summary:
Description: File at a public URL location
Properties:
|
Name |
Type |
Summary |
|
url |
string
|
A publicly accessible URL for retrieving the document |
|
name |
string
|
The name of the referenced document, with extension |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
documentURL |
|
File at a public URL location |
Summary:
Description: File at a public URL location
Properties:
|
Name |
Type |
Summary |
|
url |
string
|
A publicly accessible URL for retrieving the document |
|
name |
string
|
The name of the referenced document, with extension |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
documentURL |
|
File at a public URL location |
Summary:
Description: File at a public URL location
Properties:
|
Name |
Type |
Summary |
|
url |
string
|
A publicly accessible URL for retrieving the document |
|
name |
string
|
The name of the referenced document, with extension |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
documentURL |
|
File at a public URL location |
Summary:
Description: File at a public URL location
Properties:
|
Name |
Type |
Summary |
|
url |
string
|
A publicly accessible URL for retrieving the document |
|
name |
string
|
The name of the referenced document, with extension |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
documentURL |
|
File at a public URL location |
Summary:
Description: File at a public URL location
Properties:
|
Name |
Type |
Summary |
|
url |
string
|
A publicly accessible URL for retrieving the document |
|
name |
string
|
The name of the referenced document, with extension |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
recipientSetMemberInfos1 |
|
|
|
signingOrder |
integer
|
Index starting with 1, that tells the order in which this recipient signs |
|
recipientSetRole |
string
|
Specify the role of recipient Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
|
string
|
Email of the recipient |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
recipientSetMemberInfos1 |
|
|
|
signingOrder |
integer
|
Index starting with 1, that tells the order in which this recipient signs |
|
recipientSetRole |
string
|
Specify the role of recipient Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
|
string
|
Email of the recipient |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
recipientSetMemberInfos1 |
|
|
|
signingOrder |
integer
|
Index starting with 1, that tells the order in which this recipient signs |
|
recipientSetRole |
string
|
Specify the role of recipient Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
|
string
|
Email of the recipient |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
recipientSetMemberInfos1 |
|
|
|
signingOrder |
integer
|
Index starting with 1, that tells the order in which this recipient signs |
|
recipientSetRole |
string
|
Specify the role of recipient Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
|
string
|
Email of the recipient |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
recipientSetMemberInfos1 |
|
|
|
signingOrder |
integer
|
Index starting with 1, that tells the order in which this recipient signs |
|
recipientSetRole |
string
|
Specify the role of recipient Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
|
string
|
Email of the recipient |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
recipientSetMemberInfos1 |
|
|
|
signingOrder |
integer
|
Index starting with 1, that tells the order in which this recipient signs |
|
recipientSetRole |
string
|
Specify the role of recipient Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
|
string
|
Email of the recipient |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
recipientSetMemberInfos1 |
|
|
|
signingOrder |
integer
|
Index starting with 1, that tells the order in which this recipient signs |
|
recipientSetRole |
string
|
Specify the role of recipient Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
|
string
|
Email of the recipient |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
recipientSetMemberInfos1 |
|
|
|
signingOrder |
integer
|
Index starting with 1, that tells the order in which this recipient signs |
|
recipientSetRole |
string
|
Specify the role of recipient Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
|
string
|
Email of the recipient |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
recipientSetMemberInfos1 |
|
|
|
signingOrder |
integer
|
Index starting with 1, that tells the order in which this recipient signs |
|
recipientSetRole |
string
|
Specify the role of recipient Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
|
string
|
Email of the recipient |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
recipientSetMemberInfos1 |
|
|
|
signingOrder |
integer
|
Index starting with 1, that tells the order in which this recipient signs |
|
recipientSetRole |
string
|
Specify the role of recipient Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
|
string
|
Email of the recipient |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
recipientSetMemberInfos1 |
|
|
|
signingOrder |
integer
|
Index starting with 1, that tells the order in which this recipient signs |
|
recipientSetRole |
string
|
Specify the role of recipient Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
|
string
|
Email of the recipient |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
recipientSetMemberInfos1 |
|
|
|
signingOrder |
integer
|
Index starting with 1, that tells the order in which this recipient signs |
|
recipientSetRole |
string
|
Specify the role of recipient Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
|
string
|
Email of the recipient |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
recipientSetMemberInfos1 |
|
|
|
signingOrder |
integer
|
Index starting with 1, that tells the order in which this recipient signs |
|
recipientSetRole |
string
|
Specify the role of recipient Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
|
string
|
Email of the recipient |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
recipientSetMemberInfos1 |
|
|
|
signingOrder |
integer
|
Index starting with 1, that tells the order in which this recipient signs |
|
recipientSetRole |
string
|
Specify the role of recipient Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
|
string
|
Email of the recipient |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
recipientSetMemberInfos1 |
|
|
|
signingOrder |
integer
|
Index starting with 1, that tells the order in which this recipient signs |
|
recipientSetRole |
string
|
Specify the role of recipient Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
|
string
|
Email of the recipient |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
recipientSetMemberInfos1 |
|
|
|
signingOrder |
integer
|
Index starting with 1, that tells the order in which this recipient signs |
|
recipientSetRole |
string
|
Specify the role of recipient Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
|
string
|
Email of the recipient |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
recipientSetMemberInfos1 |
|
|
|
signingOrder |
integer
|
Index starting with 1, that tells the order in which this recipient signs |
|
recipientSetRole |
string
|
Specify the role of recipient Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
|
string
|
Email of the recipient |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
recipientSetMemberInfos1 |
|
|
|
signingOrder |
integer
|
Index starting with 1, that tells the order in which this recipient signs |
|
recipientSetRole |
string
|
Specify the role of recipient Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
|
string
|
Email of the recipient |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
recipientSetMemberInfos1 |
|
|
|
signingOrder |
integer
|
Index starting with 1, that tells the order in which this recipient signs |
|
recipientSetRole |
string
|
Specify the role of recipient Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
|
string
|
Email of the recipient |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
recipientSetMemberInfos1 |
|
|
|
signingOrder |
integer
|
Index starting with 1, that tells the order in which this recipient signs |
|
recipientSetRole |
string
|
Specify the role of recipient Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
|
string
|
Email of the recipient |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
recipientSetMemberInfos1 |
|
|
|
signingOrder |
integer
|
Index starting with 1, that tells the order in which this recipient signs |
|
recipientSetRole |
string
|
Specify the role of recipient Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
|
string
|
Email of the recipient |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
recipientSetMemberInfos1 |
|
|
|
signingOrder |
integer
|
Index starting with 1, that tells the order in which this recipient signs |
|
recipientSetRole |
string
|
Specify the role of recipient Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
|
string
|
Email of the recipient |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
recipientSetMemberInfos1 |
|
|
|
signingOrder |
integer
|
Index starting with 1, that tells the order in which this recipient signs |
|
recipientSetRole |
string
|
Specify the role of recipient Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
|
string
|
Email of the recipient |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
recipientSetMemberInfos1 |
|
|
|
signingOrder |
integer
|
Index starting with 1, that tells the order in which this recipient signs |
|
recipientSetRole |
string
|
Specify the role of recipient Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
|
string
|
Email of the recipient |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
name |
string Agreement Name |
The name of the agreement |
|
fileInfos |
array of (DocumentFileInfoUrl) Document |
Provide transient document id, library document or a public URL of document |
|
signatureType |
string Signature Type |
Specifies the Signature type that was requested - E-signature or Written Values: [ESIGN, WRITTEN] |
|
participantSetsInfo |
array of (ParticipantCreateSetInfoV6) Participant |
A list of one or more participant who will act upon this agreement |
|
message |
string Message |
An optional message to the recipients requesting their action |
|
daysUntilSigningDeadline |
integer Days to Deadline |
The number of days that remain before the document expires |
|
expirationTime |
string Expiration Time |
Time after which Agreement expires. Example: 2020-12-31T23:59:00Z |
|
reminderFrequency |
string Reminder Frequency |
How often do you want to send reminders ? Values: [DAILY_UNTIL_SIGNED, WEEKLY_UNTIL_SIGNED] |
|
securityOption |
|
Sets optional secondary security parameters for your document |
|
mergeFieldInfo |
array of (MergefieldInfo) Form Field |
Optional default values for form fields to merge into the document |
|
postSignOption |
|
|
|
state |
string
|
The state in which the agreement should land. Values: [AUTHORING, DRAFT, IN_PROCESS] |
Summary:
Description: Sets optional secondary security parameters for your document
Properties:
|
Name |
Type |
Summary |
|
openPassword |
string Document Password |
The password that should be used to encrypt the signed agreement PDF |
Summary:
Description: A JSON that contains the ID of the newly created agreement
Properties:
|
Name |
Type |
Summary |
|
agreementId |
string
|
The unique ID of the agreement that can be used to query status and download signed documents |
Summary:
Description: A JSON that contains the ID of the newly created agreement
Properties:
|
Name |
Type |
Summary |
|
id |
string
|
The unique ID of the agreement that can be used to query status and download signed documents |
Summary:
Description: A JSON that contains both the documents and supporting documents array objects
Properties:
|
Name |
Type |
Summary |
|
documents |
array of (Document)
|
A list of objects representing the documents |
|
supportingDocuments |
array of (SupportingDocument)
|
A list of supporting documents. This is returned only if there are any supporting document in the agreement |
Summary:
Description: A JSON that contains both the documents and supporting documents array objects
Properties:
|
Name |
Type |
Summary |
|
documents |
array of (DocumentV6) Documents |
A list of objects representing the documents |
|
supportingDocuments |
array of (SupportingDocumentV6) Supporting Documents |
A list of supporting documents. This is returned only if there are any supporting document in the agreement |
Summary:
Description: The complete details about the agreement
Properties:
|
Name |
Type |
Summary |
|
agreementId |
string
|
A unique ID that can be used to uniquely identify the agreement |
|
events |
array of (DocumentHistoryEvent)
|
An ordered list of the events in the audit trail of this document |
|
expiration |
string(date)
|
The date after which the agreement can no longer be signed |
|
latestVersionId |
string
|
A unique ID which uniquely identifies the current version of the agreement |
|
message |
string
|
The message associated with the agreement that the sender has provided |
|
name |
string
|
The name of the agreement, specified by the sender |
|
nextParticipantSetInfos |
array of (NextParticipantSetInfo)
|
Information about who needs to act next for this agreement |
|
participantSetInfos |
array of (ParticipantSetInfo)
|
Information about all the participant sets of this document |
|
signatureType |
string
|
Specifies the Signature type that was requested - E-signature or Written Values: [ESIGN, WRITTEN] |
|
securityOptions |
string
|
Security information about the document that specifies whether or not a password is required to view and sign it |
|
status |
string
|
The current status of the agreement Values: [OUT_FOR_SIGNATURE, WAITING_FOR_REVIEW, SIGNED, APPROVED, ABORTED, DOCUMENT_LIBRARY, WIDGET, EXPIRED, ARCHIVED, PREFILL, AUTHORING, WAITING_FOR_FAXIN, WAITING_FOR_VERIFICATION, WIDGET_WAITING_FOR_VERIFICATION, WAITING_FOR_PAYMENT, OUT_FOR_APPROVAL, OTHER] |
Summary:
Description: Complete Agreement Details
Properties:
|
Name |
Type |
Summary |
|
id |
string Agreement ID |
A unique ID that can be used to uniquely identify the agreement |
|
createdDate |
string(date) Created Date |
Date when agreement was created |
|
firstReminderDelay |
integer First Reminder Delay |
Integer which specifies the delay in hours before sending the first reminder. |
|
reminderFrequency |
string Reminder Frequency |
How often do you want to send reminders? Values: [DAILY_UNTIL_SIGNED, WEEKDAILY_UNTIL_SIGNED, EVERY_OTHER_DAY_UNTIL_SIGNED, EVERY_THIRD_DAY_UNTIL_SIGNED, EVERY_FIFTH_DAY_UNTIL_SIGNED, WEEKLY_UNTIL_SIGNED] |
|
expiration |
string(date) Expiration Date |
The date after which the agreement can no longer be signed |
|
locale |
string Locale |
The locale associated with this agreement - for example, en_US or fr_FR |
|
message |
string Message |
The message associated with the agreement that the sender has provided |
|
name |
string Agreement Name |
The name of the agreement, specified by the sender |
|
documentVisibilityEnabled |
boolean Document Visibility? |
Is document visibility enabled? |
|
participantSetsInfo |
array of (ParticipantSetInfoV6) Participant Sets |
Information about all the participant sets of this document |
|
signatureType |
string Signature Type |
Specifies the Signature type that was requested - E-signature or Written Values: [ESIGN, WRITTEN] |
|
securityOptions |
string Security Options |
Security information about the document that specifies whether or not a password is required to view and sign it |
|
status |
string Status |
The current status of the agreement Values: [OUT_FOR_SIGNATURE, OUT_FOR_DELIVERY, OUT_FOR_ACCEPTANCE, OUT_FOR_FORM_FILLING, OUT_FOR_APPROVAL, AUTHORING, CANCELLED, SIGNED, APPROVED, DELIVERED, ACCEPTED, FORM_FILLED, EXPIRED, ARCHIVED, PREFILL, WIDGET_WAITING_FOR_VERIFICATION, DRAFT, DOCUMENTS_NOT_YET_PROCESSED, WAITING_FOR_FAXIN, WAITING_FOR_VERIFICATION] |
|
senderEmail |
string Sender Email |
The email of the sender |
|
workflowId |
string Workflow ID |
The ID of custom workflow which defines the routing path of an agreement. |
|
ccs |
array of (CcInfo) CCs |
A list of one or more CCs that will be copied in the agreement transaction. |
Summary:
Description: The information about the CC of the agreement
Properties:
|
Name |
Type |
Summary |
|
|
string
|
The email of the CC of the agreement |
|
label |
string
|
The label of the CC list as returned in workflow description |
|
visiblePages |
array of (string)
|
The pages that are visible to the CC |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
company |
string
|
Displays the name of the company of the user, if available |
|
|
string
|
Displays the email of the user |
|
fullName |
string
|
Displays the full name of the user, if available. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
displayUserSetMemberInfos |
array of (DisplayUserInfo)
|
Displays the info about user set |
|
displayUserSetName |
string
|
|
Summary:
Description: The information about the document
Properties:
|
Name |
Type |
Summary |
|
documentId |
string
|
The unique ID of the document |
|
mimeType |
string
|
The Mime type of the document |
|
name |
string
|
The name of the document |
|
numPages |
integer
|
Number of pages in the document |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
transientDocumentId |
string ID |
The document id received by uploading a transient document |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
libraryDocumentId |
string
|
Choose a document from the templates stored in your library |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
urlFileInfo |
|
File at a public URL location |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
actingUserEmail |
string
|
Email address of the user that initiated the event |
|
date |
string(date)
|
The date of the audit event |
|
description |
string
|
A description of the audit event |
|
participantEmail |
string
|
Email address of the user that initiated the event |
|
type |
string
|
Type of agreement event Values: [CREATED, UPLOADED_BY_SENDER, FAXED_BY_SENDER, AGREEMENT_MODIFIED, USER_ACK_AGREEMENT_MODIFIED, PRESIGNED, SIGNED, ESIGNED, DIGSIGNED, APPROVED, OFFLINE_SYNC, FAXIN_RECEIVED, SIGNATURE_REQUESTED, APPROVAL_REQUESTED, RECALLED, REJECTED, EXPIRED, EXPIRED_AUTOMATICALLY, SHARED, EMAIL_VIEWED, AUTO_CANCELLED_CONVERSION_PROBLEM, SIGNER_SUGGESTED_CHANGES, SENDER_CREATED_NEW_REVISION, PASSWORD_AUTHENTICATION_FAILED, KBA_AUTHENTICATION_FAILED, KBA_AUTHENTICATED, WEB_IDENTITY_AUTHENTICATED, WEB_IDENTITY_SPECIFIED, EMAIL_BOUNCED, WIDGET_ENABLED, WIDGET_DISABLED, DELEGATED, AUTO_DELEGATED, REPLACED_SIGNER, VAULTED, DOCUMENTS_DELETED, OTHER, FORM_FILLING_REQUESTED] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
libraryDocumentId |
string
|
The unique ID of the library document used when sending the document to be signed |
|
libraryTemplateTypes |
array of (string)
|
A list of one or more library template types |
|
modifiedDate |
string(date)
|
The day on which the library template was last modified |
|
name |
string
|
The name of the library template |
|
scope |
string
|
The scope of visibility of the library template Values: [PERSONAL, SHARED, GLOBAL] |
Summary:
Description: A JSON that contains the library template array object
Properties:
|
Name |
Type |
Summary |
|
libraryDocumentList |
array of (DocumentLibraryItem)
|
A list of library template items |
Summary:
Description: The information about the document
Properties:
|
Name |
Type |
Summary |
|
id |
string Document ID |
The unique ID of the document |
|
mimeType |
string Mime Type |
The Mime type of the document |
|
name |
string Name |
The name of the document |
|
numPages |
integer Num Pages |
Number of pages in the document |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
libraryDocumentCreationInfo |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
name |
string
|
Agreement Name used to identify the template |
|
libraryTemplateTypes |
string
|
A list of one or more library template types Values: [Reusable document, Reusable form field layer, Both] |
|
librarySharingMode |
string
|
Specifies who should have access to this library document Values: [Only me, Any user in my group, Any user in my organization] |
|
fileInfos1 |
|
|
|
fileInfos2 |
|
|
|
fileInfos3 |
|
|
|
fileInfos4 |
|
|
|
fileInfos5 |
|
|
|
fileInfos6 |
|
|
|
fileInfos7 |
|
|
|
fileInfos8 |
|
|
|
fileInfos9 |
|
|
|
fileInfos10 |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
transientDocumentId |
string
|
The document ID received by uploading a document |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
transientDocumentId |
string
|
The document ID received by uploading a document |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
transientDocumentId |
string
|
The document ID received by uploading a document |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
transientDocumentId |
string
|
The document ID received by uploading a document |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
transientDocumentId |
string
|
The document ID received by uploading a document |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
transientDocumentId |
string
|
The document ID received by uploading a document |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
transientDocumentId |
string
|
The document ID received by uploading a document |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
transientDocumentId |
string
|
The document ID received by uploading a document |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
transientDocumentId |
string
|
The document ID received by uploading a document |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
transientDocumentId |
string
|
The document ID received by uploading a document |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
libraryDocumentCreationInfo |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
name |
string
|
Agreement Name used to identify the template |
|
libraryTemplateTypes |
string
|
A list of one or more library template types Values: [Reusable document, Reusable form field layer, Both] |
|
librarySharingMode |
string
|
Specifies who should have access to this library document Values: [Only me, Any user in my group, Any user in my organization] |
|
fileInfos1 |
|
|
|
fileInfos2 |
|
|
|
fileInfos3 |
|
|
|
fileInfos4 |
|
|
|
fileInfos5 |
|
|
|
fileInfos6 |
|
|
|
fileInfos7 |
|
|
|
fileInfos8 |
|
|
|
fileInfos9 |
|
|
|
fileInfos10 |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
documentURL |
|
File at a public URL location |
Summary:
Description: File at a public URL location
Properties:
|
Name |
Type |
Summary |
|
url |
string
|
A publicly accessible URL for retrieving the document |
|
name |
string
|
The name of the referenced document, with extension |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
documentURL |
|
File at a public URL location |
Summary:
Description: File at a public URL location
Properties:
|
Name |
Type |
Summary |
|
url |
string
|
A publicly accessible URL for retrieving the document |
|
name |
string
|
The name of the referenced document, with extension |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
documentURL |
|
File at a public URL location |
Summary:
Description: File at a public URL location
Properties:
|
Name |
Type |
Summary |
|
url |
string
|
A publicly accessible URL for retrieving the document |
|
name |
string
|
The name of the referenced document, with extension |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
documentURL |
|
File at a public URL location |
Summary:
Description: File at a public URL location
Properties:
|
Name |
Type |
Summary |
|
url |
string
|
A publicly accessible URL for retrieving the document |
|
name |
string
|
The name of the referenced document, with extension |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
documentURL |
|
File at a public URL location |
Summary:
Description: File at a public URL location
Properties:
|
Name |
Type |
Summary |
|
url |
string
|
A publicly accessible URL for retrieving the document |
|
name |
string
|
The name of the referenced document, with extension |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
documentURL |
|
File at a public URL location |
Summary:
Description: File at a public URL location
Properties:
|
Name |
Type |
Summary |
|
url |
string
|
A publicly accessible URL for retrieving the document |
|
name |
string
|
The name of the referenced document, with extension |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
documentURL |
|
File at a public URL location |
Summary:
Description: File at a public URL location
Properties:
|
Name |
Type |
Summary |
|
url |
string
|
A publicly accessible URL for retrieving the document |
|
name |
string
|
The name of the referenced document, with extension |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
documentURL |
|
File at a public URL location |
Summary:
Description: File at a public URL location
Properties:
|
Name |
Type |
Summary |
|
url |
string
|
A publicly accessible URL for retrieving the document |
|
name |
string
|
The name of the referenced document, with extension |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
documentURL |
|
File at a public URL location |
Summary:
Description: File at a public URL location
Properties:
|
Name |
Type |
Summary |
|
url |
string
|
A publicly accessible URL for retrieving the document |
|
name |
string
|
The name of the referenced document, with extension |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
documentURL |
|
File at a public URL location |
Summary:
Description: File at a public URL location
Properties:
|
Name |
Type |
Summary |
|
url |
string
|
A publicly accessible URL for retrieving the document |
|
name |
string
|
The name of the referenced document, with extension |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string
|
The unique identifier that is used to refer to the library template |
|
hidden |
boolean
|
True if Library Document is hidden |
|
templateTypes |
array of (string) Template Type(s) |
A list of one or more library template types |
|
modifiedDate |
string(date)
|
The day on which the library template was last modified |
|
name |
string
|
The name of the library template |
|
sharingMode |
string
|
The scope of visibility of the library template Values: [USER, GROUP, ACCOUNT, GLOBAL] |
|
creatorEmail |
string
|
Email address of the library document creator. |
|
groupId |
string
|
The unique identifier of the group to which the library template belongs to. |
|
status |
string
|
Status of the library document Values: [AUTHORING, ACTIVE, REMOVED] |
Summary:
Description: A JSON object describing the library template
Properties:
|
Name |
Type |
Summary |
|
libraryDocumentId |
string
|
The unique ID that can be used to refer to the library template |
Summary:
Description: A JSON object describing the library template
Properties:
|
Name |
Type |
Summary |
|
id |
string
|
The unique ID that can be used to refer to the library template |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
transientDocumentId |
string ID |
The document id received by uploading a transient document |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
urlFileInfo |
|
File at a public URL location |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
name |
string Template Name |
Agreement Name used to identify the template |
|
templateTypes |
array of (string) Template Type |
A list of one or more library template types |
|
sharingMode |
string Sharing Mode |
Specifies who should have access to this library document Values: [USER, GROUP, ACCOUNT] |
|
fileInfos |
array of (LibraryDocumentFileInfoId) Document |
Provide transient document id |
|
state |
string Template State |
State of the library document. Values: [AUTHORING, ACTIVE] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
name |
string Template Name |
Agreement Name used to identify the template |
|
templateTypes |
array of (string) Template Type |
A list of one or more library template types |
|
sharingMode |
string Sharing Mode |
Specifies who should have access to this library document Values: [USER, GROUP, ACCOUNT] |
|
fileInfos |
array of (LibraryDocumentFileInfoUrl) Document |
Provide a public URL of document |
|
state |
string Template State |
State of the library document. Values: [AUTHORING, ACTIVE] |
Summary:
Description: A JSON that contains the library template array object
Properties:
|
Name |
Type |
Summary |
|
page |
|
Pagination information for navigating through the response |
|
libraryDocumentList |
array of (LibraryDocument)
|
A list of library template items |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
|
string |
The email of the participant |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fieldName |
string
|
The name of the field |
|
defaultValue |
string
|
The default value of the field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
|
string
|
The email address of the next participant |
|
name |
string
|
The name of the next participant, if available |
|
waitingSince |
string(date)
|
The date since which the document has been waiting for the participant to take action |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
nextParticipantSetMemberInfos |
array of (NextParticipantInfo)
|
Information about the members of the next participant set |
Summary:
Description: Pagination information for navigating through the response
Properties:
|
Name |
Type |
Summary |
|
nextCursor |
string
|
Used to navigate to the next page. If not returned, there are no further pages. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
memberInfos |
array of (MemberInfosV6)
|
Information about the members of the recipient set |
|
order |
integer(int32) Order |
Index starting with 1, indicating position at which signing group needs to sign. |
|
role |
string Role |
The current roles of the participant set (signer, approver etc). Values: [SIGNER, APPROVER, ACCEPTOR, CERTIFIED_RECIPIENT, FORM_FILLER, DELEGATE_TO_SIGNER, DELEGATE_TO_APPROVER, DELEGATE_TO_ACCEPTOR, DELEGATE_TO_CERTIFIED_RECIPIENT, DELEGATE_TO_FORM_FILLER] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
company |
string
|
The company of the participant, if available |
|
|
string
|
The email address of the participant |
|
name |
string
|
The name of the participant, if available |
|
participantId |
string
|
The unique ID of the participant |
|
securityOptions |
array of (string)
|
Security options that apply to the participant |
|
title |
string
|
The title of the participant, if available |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
participantSetId |
string
|
The unique ID of the participant set |
|
participantSetMemberInfos |
array of (ParticipantInfo)
|
Information about the members of the recipient set |
|
privateMessage |
string
|
Private message for the participants in the set |
|
roles |
array of (string)
|
The current roles of the participant set. A participant set can have one or more roles |
|
securityOptions |
array of (string)
|
Security options that apply to the participant |
|
signingOrder |
integer
|
Index starting with 1, that tells the order in which this recipient signs |
|
status |
string
|
The participant set status with respect to the document Values: [WAITING_FOR_MY_SIGNATURE, WAITING_FOR_MY_APPROVAL, WAITING_FOR_MY_DELEGATION, OUT_FOR_SIGNATURE, SIGNED, APPROVED, RECALLED, HIDDEN, NOT_YET_VISIBLE, WAITING_FOR_FAXIN, ARCHIVED, UNKNOWN, PARTIAL, FORM, WAITING_FOR_AUTHORING, OUT_FOR_APPROVAL, WIDGET, EXPIRED, WAITING_FOR_MY_REVIEW, IN_REVIEW, OTHER] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
memberInfos |
array of (MemberInfosV6) Participant Set Member Infos |
Information about the members of the recipient set |
|
order |
integer(int32) Order |
Index indicating position at which signing group needs to sign. |
|
role |
string Role |
The current roles of the participant set (signer, approver etc). Values: [SIGNER, APPROVER, ACCEPTOR, CERTIFIED_RECIPIENT, FORM_FILLER, DELEGATE_TO_SIGNER, DELEGATE_TO_APPROVER, DELEGATE_TO_ACCEPTOR, DELEGATE_TO_CERTIFIED_RECIPIENT, DELEGATE_TO_FORM_FILLER, SHARE] |
|
name |
string Participant Set Name |
The name of the participant set |
|
privateMessage |
string Participant Set Private Messsage |
Private message for the participants in the set |
|
visiblePages |
array of (string) Participant Set Visible Pages |
The pages that are visible to the participant set |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
redirectDelay |
string Redirect Delay |
The delay (in seconds) before the user is taken to the success page. |
|
redirectUrl |
string Redirect URL |
URL to redirect after completing the signing process, e.g. https://adobe.com |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
|
string
|
The email address of the signer associated with this signing url |
|
esignUrl |
string
|
The URL address of the signer associated with this signing url |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
signingUrlSetInfos |
array of (SigningUrlSetInfo)
|
An array of urls for signer sets involved in this agreement |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
signingUrls |
array of (SigningUrl)
|
An array of urls for current signer set |
|
signingUrlSetName |
string
|
The name of the current signer set |
Summary:
Description: The information about the supporting document
Properties:
|
Name |
Type |
Summary |
|
displayLabel |
string
|
Display name of the supporting document |
|
fieldName |
string
|
The name of the supporting document field |
|
mimeType |
string
|
The Mime type of the supporting document |
|
numPages |
integer(int32)
|
Number of pages in the supporting document |
|
supportingDocumentId |
string
|
Unique ID representing the supporting document |
Summary:
Description: The information about the supporting document
Properties:
|
Name |
Type |
Summary |
|
displayLabel |
string Supporting Document Name |
Display name of the supporting document |
|
fieldName |
string Supporting Document Field Name |
The name of the supporting document field |
|
mimeType |
string Supporting Document Mime Type |
The Mime type of the supporting document |
|
numPages |
integer(int32) Supporting Document Pages |
Number of pages in the supporting document |
|
id |
string Supporting Document ID |
Unique ID representing the supporting document |
Summary:
Description: A JSON that contains the ID of the uploaded document
Properties:
|
Name |
Type |
Summary |
|
transientDocumentId |
string
|
The document ID of the uploaded document |
Summary:
Description: File at a public URL location
Properties:
|
Name |
Type |
Summary |
|
url |
string
|
A publicly accessible URL for retrieving the raw file content |
|
name |
string
|
The original system file name of the document being sent |
|
mimeType |
string
|
The mime type of the referenced file, e.g. application/pdf Values: [application/pdf, application/msword, application/vnd.openxmlformats-officedocument.wordprocessingml.document, application/vnd.ms-excel, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet, application/vnd.ms-powerpoint, application/vnd.openxmlformats-officedocument.presentationml.presentation, text/plain, text/rtf, text/csv, text/html, image/tiff, image/bmp, image/gif, image/jpeg, image/png] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
agreementId |
string
|
A unique ID that can be used to uniquely identify the agreement |
|
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 |
|
displayDate |
string(date)
|
The display date for the agreement |
|
esign |
boolean
|
True if this is an e-sign document |
|
latestVersionId |
string
|
A version ID which uniquely identifies the current version of the agreement |
|
name |
string
|
Name of the Agreement |
|
status |
string
|
The current status of the agreement Values: [WAITING_FOR_MY_SIGNATURE, WAITING_FOR_MY_APPROVAL, WAITING_FOR_MY_DELEGATION, OUT_FOR_SIGNATURE, OUT_FOR_APPROVAL, SIGNED, APPROVED, RECALLED, WAITING_FOR_FAXIN, ARCHIVED, FORM, EXPIRED, WIDGET, WAITING_FOR_AUTHORING] |
Summary:
Description: A JSON that contains the user agreement array object
Properties:
|
Name |
Type |
Summary |
|
page |
|
Pagination information for navigating through the response |
|
userAgreementList |
array of (UserAgreementV6)
|
An array of agreement items |
Summary:
Description: A JSON that contains the user agreement array object
Properties:
|
Name |
Type |
Summary |
|
userAgreementList |
array of (UserAgreement)
|
An array of agreement items |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
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 |
|
displayDate |
string
|
The display date for the agreement |
|
esign |
boolean
|
True if this is an e-sign document |
|
hidden |
boolean
|
True if agreement is hidden for the user |
|
groupId |
string
|
Unique identifier of the group |
|
latestVersionId |
string
|
A version ID which uniquely identifies the current version of the agreement |
|
name |
string
|
Name of the Agreement |
|
parentId |
string
|
The parent id of a megaSign child *OR* the originating id of a widget agreement instance |
|
id |
string
|
The unique identifier of the agreement |
|
status |
string
|
The current status of the agreement Values: [WAITING_FOR_MY_SIGNATURE, WAITING_FOR_MY_APPROVAL, WAITING_FOR_MY_DELEGATION, WAITING_FOR_MY_ACKNOWLEDGEMENT, WAITING_FOR_MY_ACCEPTANCE, WAITING_FOR_MY_FORM_FILLING, OUT_FOR_SIGNATURE, OUT_FOR_APPROVAL, OUT_FOR_DELIVERY, OUT_FOR_ACCEPTANCE, OUT_FOR_FORM_FILLING, FORM_FILLED, DELIVERED, CANCELLED, SIGNED, APPROVED, RECALLED, WAITING_FOR_FAXIN, ARCHIVED, FORM, EXPIRED, WIDGET, WAITING_FOR_PREFILL, DOCUMENTS_NOT_YET_PROCESSED, WAITING_FOR_MY_VERIFICATION, WAITING_FOR_VERIFICATION, WAITING_FOR_AUTHORING] |
|
type |
string
|
The kind of agreement Values: [AGREEMENT, MEGASIGN_CHILD, WIDGET_INSTANCE] |
Summary:
Description: Conditional parameters for agreement related events
Properties:
|
Name |
Type |
Summary |
|
includeDetailedInfo |
boolean
|
Should detailed agreement info be sent in notification? |
|
includeParticipantsInfo |
boolean
|
Should agreement participant info be sent in notification? |
|
includeDocumentsInfo |
boolean
|
Should agreement document info be sent in notification? |
Summary:
Description: Conditional parameters for agreement related events
Properties:
|
Name |
Type |
Summary |
|
includeDetailedInfo |
boolean
|
Should detailed agreement info be sent in notification? |
|
includeParticipantsInfo |
boolean
|
Should agreement participant info be sent in notification? |
Summary:
Description: Conditional parameters for agreement related events
Properties:
|
Name |
Type |
Summary |
|
includeDetailedInfo |
boolean
|
Should detailed agreement info be sent in notification? |
|
includeParticipantsInfo |
boolean
|
Should agreement participant info be sent in notification? |
|
includeDocumentsInfo |
boolean
|
Should agreement document info be sent in notification? |
|
includeSignedDocuments |
boolean
|
Should a final copy of signed document on agreement completion be sent in notification? |
Summary:
Description: Conditional parameters for agreement related events
Properties:
|
Name |
Type |
Summary |
|
includeDetailedInfo |
boolean
|
Should detailed agreement info be sent in notification? |
|
includeParticipantsInfo |
boolean
|
Should agreement participant info be sent in notification? |
|
includeDocumentsInfo |
boolean
|
Should agreement document info be sent in notification? |
|
includeSignedDocuments |
boolean
|
Should a final copy of signed document be sent in notification of agreement completion? |
Summary:
Description: Conditional parameters for agreement related events
Properties:
|
Name |
Type |
Summary |
|
includeDetailedInfo |
boolean
|
Should detailed agreement info be sent in notification? |
|
includeParticipantsInfo |
boolean
|
Should agreement participant info be sent in notification? |
|
includeDocumentsInfo |
boolean
|
Should agreement document info be sent in notification? |
|
includeSignedDocuments |
boolean
|
Should a final copy of signed document on agreement completion be sent in notification? |
Summary:
Description: Conditional parameter for optional data in payload
Properties:
|
Name |
Type |
Summary |
|
webhookAgreementEvents |
|
Conditional parameters for agreement related events |
Summary:
Description: Conditional parameter for optional data in payload
Properties:
|
Name |
Type |
Summary |
|
webhookAgreementEvents |
WebhookAgreementEventsForAgreementCreatedEvent
|
Conditional parameters for agreement related events |
Summary:
Description: Conditional parameter for data in payload
Properties:
|
Name |
Type |
Summary |
|
webhookAgreementEvents |
WebhookAgreementEventsForSignedEvent
|
Conditional parameters for agreement related events |
Summary:
Description: Conditional parameter for data in payload
Properties:
|
Name |
Type |
Summary |
|
webhookAgreementEvents |
WebhookAgreementEventsForStatusChange
|
Conditional parameters for agreement related events |
Summary:
Description: Conditional parameter for optional data in payload
Properties:
|
Name |
Type |
Summary |
|
webhookAgreementEvents |
|
Conditional parameters for agreement related events |
|
webhookMegaSignEvents |
|
Conditional parameters for mega sign related events |
|
webhookWidgetEvents |
|
Conditional parameters for widget related events |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
webhookUrlInfo |
|
Webhook URL |
|
state |
string
|
The default state of webhook |
|
name |
string
|
The name of the trigger |
|
scope |
string
|
The scope of the trigger Values: [Any agreement in my account, Any agreement in my group, Any of my agreements] |
|
webhookSubscriptionEvents |
array of (string)
|
The events for which the flow should be triggered |
|
webhookConditionalParams |
WebhookConditionalParamsForAgreementCreatedEvent
|
Conditional parameter for optional data in payload |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
state |
string
|
The default state of webhook |
|
webhookUrlInfo |
|
Webhook URL |
|
name |
string
|
The name of the trigger |
|
scope |
string
|
The scope of the trigger Values: [Any agreement in my account, Any agreement in my group, Any of my agreements, A specific agreement] |
|
resourceType |
string
|
Specify only when "Scope" is "A specific agreement". Values: [AGREEMENT] |
|
resourceId |
string
|
Specify only when "Scope" is "A specific agreement". Select an agreement from the list or enter the agreement ID. |
|
webhookSubscriptionEvents |
array of (string)
|
The events for which the flow should be triggered |
|
webhookConditionalParams |
|
Conditional parameter for optional data in payload |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
state |
string
|
The default state of webhook |
|
webhookUrlInfo |
|
Webhook URL |
|
name |
string
|
The name of the trigger |
|
scope |
string
|
The scope of the trigger Values: [Any agreement in my account, Any agreement in my group, Any of my agreements, A specific agreement] |
|
resourceType |
string
|
Specify only when "Scope" is "A specific agreement". Values: [AGREEMENT] |
|
resourceId |
string
|
Specify only when "Scope" is "A specific agreement". Select an agreement from the list or enter the agreement ID. |
|
webhookSubscriptionEvents |
array of (string)
|
The events for which the flow should be triggered |
|
webhookConditionalParams |
WebhookConditionalParamsForAgreementSignedEvent
|
Conditional parameter for data in payload |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
state |
string
|
The default state of webhook |
|
webhookUrlInfo |
|
Webhook URL |
|
name |
string
|
The name of the trigger |
|
scope |
string
|
The scope of the trigger Values: [Any resource in my account, Any resource in my group, Any of my resource, A specific resource] |
|
resourceType |
string
|
Specify only when "Scope" is "A specific resource". Select the resource type for which the flow should be triggered. Values: [Agreement, Mega Sign, Widget] |
|
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. |
|
webhookSubscriptionEvents |
array of (string)
|
The events for which the flow should be triggered |
|
webhookConditionalParams |
WebhookConditionalParamsGeneric
|
Conditional parameter for optional data in payload |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
state |
string
|
The default state of webhook |
|
webhookUrlInfo |
|
Webhook URL |
|
name |
string
|
The name of the trigger |
|
scope |
string
|
The scope of the trigger Values: [Any agreement in my account, Any agreement in my group, Any of my agreements, A specific agreement] |
|
resourceType |
string
|
Specify only when "Scope" is "A specific agreement". Values: [AGREEMENT] |
|
resourceId |
string
|
Specify only when "Scope" is "A specific agreement". Select an agreement from the list or enter the agreement ID. |
|
webhookSubscriptionEvents |
array of (string)
|
The events for which the flow should be triggered |
|
webhookConditionalParams |
WebhookConditionalParamsForAgreementStatusChange
|
Conditional parameter for data in payload |
Summary:
Description: A JSON that contains the ID of the newly created webhook
Properties:
|
Name |
Type |
Summary |
|
webhookId |
string
|
The unique ID of the webhook |
Summary:
Description: Conditional parameters for mega sign related events
Properties:
|
Name |
Type |
Summary |
|
includeDetailedInfo |
boolean
|
Should detailed mega sign info be sent in notification? |
Summary:
Description: Webhook URL
Properties:
|
Name |
Type |
Summary |
|
url |
string
|
The url on which you want to create the webhook |
Summary:
Description: Conditional parameters for widget related events
Properties:
|
Name |
Type |
Summary |
|
includeDetailedInfo |
boolean
|
Should detailed widget info be sent in notification? |
|
includeParticipantsInfo |
boolean
|
Should widget participant info be sent in notification? |
|
includeDocumentsInfo |
boolean
|
Should widget document info be sent in notification? |