Docusign
Docusign enables organizations to create, commit to and manage their agreements across the entire agreement lifecycle. Customers can accelerate revenue, reduce risk and unlock value from the agreements that run their business.
This connector is available in the following products and regions:
| Service | Class | Regions |
|---|---|---|
| Logic Apps | Standard | All Logic Apps regions except the following: - Azure China regions - US Department of Defense (DoD) |
| Power Automate | Premium | All Power Automate regions except the following: - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Power Apps | Premium | All Power Apps regions except the following: - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Contact | |
|---|---|
| Name | docusign |
| URL | https://support.docusign.com |
| Connector Metadata | |
|---|---|
| Publisher | DocuSign, Inc. |
| Website | https://www.docusign.com |
| Privacy policy | https://www.docusign.com/company/privacy-policy |
| Categories | Content and Files;Productivity |
Note
This connector may be used at no additional charge from Microsoft, when building and running Power Automate workflows. To learn more about the program, go to Power Automate embed pay-as-you-go.
To use the Connect trigger in this integration, DocuSign Connect must be enabled in your DocuSign account. It is not enabled by default. Once enabled, the Connect Settings page can be accessed from the DocuSign Admin web application. Using the Connect trigger in this integration will automatically register the webhook for you.
To try the connector, please use a DEMO account:
- Go to https://developers.docusign.com/
- Create Sandbox account.
These are different than free trials in that they never expire, have 90% of our paid account features, and none of the documents sent through DEMO are legally binding ((https://support.docusign.com/en/articles/Free-account-vs-Developer-account).
For issues with DocuSign please try this link first: https://support.docusign.com/en/articles/How-Do-I-Open-a-Case-in-the-DocuSign-Support-Center.
Throttling Limits
| Name | Calls | Renewal Period |
|---|---|---|
| API calls per connection | 250 | 60 seconds |
Actions
| Add documents to an envelope |
Add documents to an envelope. |
| Add recipient to an envelope (V2) |
Add recipient to an envelope. |
| Add reminders for an envelope |
Add reminders for an envelope |
| Add tabs for a recipient on an envelope |
Add tabs for a recipient on an envelope |
| Add verification type to a recipient |
Add verification type to a recipient. |
| Copilot: Get related activities |
Returns the related activities of the of the CRM sales entities. |
| Copilot: Get related records |
Returns the related records of the of the CRM sales entities. |
| Copilot: List envelopes |
This action brings back relevant Docusign envelopes based on envelope status, date range, recipient name, recipient email address, envelope title, document name, or envelope custom field value. The output is the title, description, Envelope ID, document names, sender names, envelope status, status date, date sent, and a URL of the envelope which can be used as a link to view the envelope in Docusign. |
| Create envelope |
Create a new blank envelope. |
| Create envelope using template |
Create a new envelope using a specified template. |
| Create envelope using template with recipients |
Create a new envelope using a specified template and specify recipients. |
| DEPRECATED: Add recipient to an envelope |
Add recipient to an envelope. |
| DEPRECATED: Create envelope using template |
Create a new envelope using a specified template. |
| DEPRECATED: Get documents from envelope |
Get documents from envelope |
| Generate Embedded Sender URL |
Generate Embedded Sender URL |
| Generate Embedded Signing URL |
Generate Embedded Signing URL |
| Get custom field info from envelope |
Get custom field info from envelope |
| Get document custom fields from envelope |
Get document custom fields from envelope |
| Get document generation form fields from envelope |
Get document generation form fields from envelope |
| Get document info from envelope |
Get document info from envelope |
| Get document tabs from envelope |
Get document tabs from envelope |
| Get document tabs from template |
Get document tabs from template |
| Get documents from an envelope |
Get documents from an envelope |
| Get info for recipient tab |
Returns the value of the tab for the given recipient |
| Get recipient info from envelope |
Get recipient info from envelope |
| Get recipient tabs from envelope |
Get recipient tabs from envelope |
| List documents from a template |
List documents from a template |
| List documents from an envelope |
List documents from an envelope |
| List recipients from envelope |
List recipients from envelope |
| List templates |
List templates for a specific account. |
| Login |
Login |
| Remove recipient from an envelope |
Remove recipient from an envelope |
| Resend the envelope |
This action resends a Docusign envelope or sends a reminder to recipients who need to sign a Docusign agreement based on a provided EnvelopeId. |
| Send envelope |
Send an existing envelope. |
| Show build Number (For reference only. Do not include in a flow for execution) |
Identifier for the currently deployed build. |
| Update document generation form fields from envelope |
Update document generation form fields from envelope |
| Update envelope custom field |
Update value for the specified envelope custom field |
| Update envelope prefill tabs |
Update values for a list of prefill tabs |
| Update recipient on an envelope |
Update recipient on an envelope |
| Update recipient tab values on an envelope |
Update recipient tab values on an envelope |
| Void the envelope |
Void the envelope. |
Add documents to an envelope
Add documents to an envelope.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
Account id |
|
Envelope
|
envelopeId | True | string |
Envelope id |
|
Document Base64 *
|
documentBase64 | True | string |
Base64 of document content |
|
Document type *
|
fileExtension | True | string |
pdf, docx etc. |
|
Document name *
|
name | True | string |
document name |
|
Transform Pdf Fields
|
transformPdfFields | string |
False |
|
|
Assign tabs to recipient
|
assignTabsToRecipientId | string |
Recipient Id |
Returns
- Body
- AddDocumentsResponse
Add recipient to an envelope (V2)
Add recipient to an envelope.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
Account id |
|
Envelope
|
envelopeId | True | string |
Envelope id |
|
Recipient type
|
recipientType | True | string |
Recipient type |
|
Client User ID
|
clientUserId | string |
Client user ID for embedded signer |
|
|
Embedded recipient start URL
|
embeddedRecipientStartURL | string |
A sender-provided URL string for redirecting an embedded recipient. |
|
|
Signing order
|
routingOrder | string |
The signing order of the recipient. |
|
|
Email notification language
|
emailNotificationLanguage | string |
Language for the email notification. |
|
|
Email notification subject
|
emailNotificationSubject | string |
Subject of the email notification. |
|
|
Email notification body
|
emailNotificationBody | string |
Body of the email notification. |
|
|
Note
|
note | string |
Custom note for the recipient. |
|
|
Role name
|
roleName | string |
Role name associated with the recipient. |
|
|
SMS Country Code
|
countryCode | integer |
For SMS notifications, the country code, without leading + sign. |
|
|
SMS Phone Number
|
phoneNumber | integer |
For SMS notifications, the phone number without the country code. |
|
|
Signature type
|
signatureType | string |
DocuSign standards-based-signature (SBS) types. |
|
|
details for selected recipient type
|
additionalRecipientParams | dynamic |
Details for selected recipient type. |
Returns
- Body
- Signer
Add reminders for an envelope
Add reminders for an envelope
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
Account id |
|
Envelope
|
envelopeId | True | string |
Envelope id |
|
Reminder Enabled
|
reminderEnabled | True | boolean |
When set to false the reminders are disabled. Default is false |
|
Reminder Delay
|
reminderDelay | True | string |
Add number of days after which recipient receives reminder email. |
|
Reminder Frequency
|
reminderFrequency | True | string |
Add number of days between reminder emails. |
|
Expire After
|
expireAfter | string |
Add number of days before expiry. |
Returns
- Body
- AddRemindersResponse
Add tabs for a recipient on an envelope
Add tabs for a recipient on an envelope
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
Account id |
|
Envelope
|
envelopeId | True | string |
Envelope id |
|
Recipient
|
recipientId | True | string |
Recipient id |
|
Tab type
|
tabType | True | string |
Tab type |
|
tab details
|
tabDetails | True | dynamic |
The details of the selected anchor tab. |
Returns
Add verification type to a recipient
Add verification type to a recipient.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
Account id |
|
Envelope
|
envelopeId | True | string |
Envelope id |
|
Recipient id
|
recipientId | True | string |
Recipient id |
|
Recipient type
|
recipientType | True | string |
Recipient type |
|
Verification Type
|
verificationType | True | string |
Verification Type |
|
Additional recipient data
|
additionalRecipientData | dynamic |
Additional recipient data. |
Returns
Copilot: Get related activities
Returns the related activities of the of the CRM sales entities.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Record type
|
recordType | True | string |
Select record type |
|
Record Id
|
recordId | True | string |
Record Id |
|
Start date
|
startDateTime | date-time |
Enter start date-time in the format: 2017-05-02T01:44Z |
|
|
End date
|
endDateTime | date-time |
Enter end date-time in the format: 2017-05-02T01:44Z |
|
|
Top
|
top | integer |
Top envelopes to be returned |
|
|
Skip
|
skip | integer |
Envelopes to be skipped |
|
|
CRM type
|
crmType | string |
CRM type |
|
|
CRM org URL
|
crmOrgUrl | string |
CRM org URL |
Returns
Copilot: Get related records
Returns the related records of the of the CRM sales entities.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Record type
|
recordType | True | string |
Select record type |
|
Record Id
|
recordId | True | string |
Record Id |
|
Start date
|
startDateTime | date-time |
Enter start date-time in the format: 2017-05-02T01:44Z |
|
|
Top
|
top | integer |
Top envelopes to be returned |
|
|
Skip
|
skip | integer |
Envelopes to be skipped |
|
|
CRM type
|
crmType | string |
CRM type |
|
|
CRM org URL
|
crmOrgUrl | string |
CRM org URL |
Returns
Copilot: List envelopes
This action brings back relevant Docusign envelopes based on envelope status, date range, recipient name, recipient email address, envelope title, document name, or envelope custom field value. The output is the title, description, Envelope ID, document names, sender names, envelope status, status date, date sent, and a URL of the envelope which can be used as a link to view the envelope in Docusign.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Recipient name
|
recipientName | string |
This action lists envelopes based on recipient name |
|
|
Recipient emailId
|
recipientEmailId | string |
This action lists envelopes based on recipient email id |
|
|
Envelope subject
|
envelopeTitle | string |
This action lists envelopes based on email subject of the envelope |
|
|
Custom field name
|
customFieldName | string |
This action lists envelopes based on a name of its custom fields |
|
|
Custom field value
|
customFieldValue | string |
This action lists envelopes based on a value of its custom fields |
|
|
Envelope status
|
envelopeStatus | string |
This action lists envelopes based on status of the envelope |
|
|
Folder
|
folder_ids | string |
This action lists envelopes based on various states of the envelope |
|
|
Order by
|
order_by | string |
This action orders envelopes based on specific property |
|
|
Top
|
top | integer |
Top envelopes to be returned |
|
|
Skip
|
skip | integer |
Envelopes to be skipped |
|
|
Start date
|
from_date | date-time |
Enter start date-time in the pattern or format: 2017-05-02T01:44Z. Do not provide any value until user provides the value. |
|
|
End date
|
to_date | date-time |
Enter end date-time in the format: 2017-05-02T01:44Z. Do not provide any value until user provides the value. |
Returns
Create envelope
Create a new blank envelope.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
Account id |
|
Email subject
|
emailSubject | True | string |
Subject of the email. |
|
Email body
|
emailBody | string |
Body of the email. |
|
|
Custom Fields
|
accountCustomFields | dynamic |
Get the custom fields set at the account level. |
Returns
Create envelope using template
Create a new envelope using a specified template.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
Account id |
|
Template
|
templateId | True | string |
Template id |
|
Envelope status
|
status | True | string |
Envelope status |
Returns
Create envelope using template with recipients
Create a new envelope using a specified template and specify recipients.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
Account id |
|
Template
|
templateId | True | string |
Template id |
|
Envelope status
|
status | True | string |
Envelope status |
|
Signers
|
signers | dynamic |
The signers of the document. |
|
|
Email subject
|
emailSubject | string |
Email subject |
|
|
Email body
|
emailBody | string |
Email body |
Returns
DEPRECATED: Add recipient to an envelope
Add recipient to an envelope.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
Account id |
|
Envelope
|
envelopeId | True | string |
Envelope id |
|
Signer Name
|
AddRecipientToEnvelopeName | True | string |
The name of the recipient. |
|
Signer Email
|
AddRecipientToEnvelopeEmail | True | string |
The email of the recipient. |
|
Signing Order
|
routingOrder | string |
The signing order of the recipient in the document. |
|
|
Role
|
roleName | string |
The role of the signer. |
Returns
DEPRECATED: Create envelope using template
Create a new envelope using a specified template.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
Account id |
|
Template
|
templateId | True | string |
Template id |
|
Envelope status
|
status | True | string |
Envelope status |
|
Custom Fields
|
accountCustomFields | True | dynamic |
Get the custom fields set at the account level. |
Returns
DEPRECATED: Get documents from envelope
Get documents from envelope
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
Account id |
|
Envelope
|
envelopeId | True | string |
Envelope id |
|
Certificate of completion
|
certificate | True | boolean |
When set to false, the envelope signing certificate is removed from the download. |
Returns
- response
- GetDocumentsResponse
Generate Embedded Sender URL
Generate Embedded Sender URL
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
Account id |
|
Envelope
|
envelopeId | True | string |
Envelope id |
|
Open in
|
openIn | True | string |
Open in |
|
Return URL
|
returnUrl | True | string |
Return URL |
|
Additional added URL
|
additionalURL | dynamic |
Additional added URL. |
Returns
Generate Embedded Signing URL
Generate Embedded Signing URL
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
Account id |
|
Envelope
|
envelopeId | True | string |
Envelope id |
|
Signer Name
|
signerName | True | string |
Name of The Signer |
|
Signer Email
|
signerEmail | True | string |
Email of The Signer |
|
Client User ID
|
clientUserId | True | string |
Client User ID |
|
Authentication Method
|
authenticationMethod | True | string |
Authentication Method |
|
Return URL
|
returnUrl | True | string |
Return URL |
|
Additional added URL
|
additionalURL | dynamic |
Additional added URL. |
Returns
Get custom field info from envelope
Get custom field info from envelope
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
Account id |
|
Envelope
|
envelopeId | True | string |
Envelope id |
|
Custom Field Name
|
fieldName | True | string |
Custom Field Name |
Returns
Get document custom fields from envelope
Get document custom fields from envelope
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
Account id |
|
Envelope
|
envelopeId | True | string |
Envelope id |
|
Document id
|
documentId | True | string |
Document id |
Returns
Get document generation form fields from envelope
Get document generation form fields from envelope
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
Account id |
|
Envelope
|
envelopeId | True | string |
Envelope id |
Returns
Get document info from envelope
Get document info from envelope
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
Account id |
|
Envelope
|
envelopeId | True | string |
Envelope id |
|
Document name
|
documentName | True | string |
File name with extension |
Returns
- Body
- EnvelopeDocument
Get document tabs from envelope
Get document tabs from envelope
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
Account id |
|
Envelope
|
envelopeId | True | string |
Envelope id |
|
Document id
|
documentId | True | string |
Document id |
Returns
- Body
- ListTabsResponse
Get document tabs from template
Get document tabs from template
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
Account id |
|
Template
|
templateId | True | string |
Template id |
|
Document id
|
documentId | True | string |
Document id |
Returns
- Body
- ListTabsResponse
Get documents from an envelope
Get documents from an envelope
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
Account id |
|
Envelope
|
envelopeId | True | string |
Envelope id |
|
Output format
|
documentId | True | string |
Provide specific document Id or use an output format from the dropdown |
Returns
- response
- GetDocumentsResponse
Get info for recipient tab
Returns the value of the tab for the given recipient
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
Account id |
|
Envelope
|
envelopeId | True | string |
Envelope id |
|
Recipient id
|
recipientId | True | string |
Recipient id |
|
Tab label
|
tabLabel | True | string |
Tab label |
Returns
- Body
- Tab
Get recipient info from envelope
Get recipient info from envelope
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
Account id |
|
Envelope
|
envelopeId | True | string |
Envelope id |
|
Recipient Email
|
recipientEmail | string |
Recipient email |
|
|
Area Code
|
areaCode | string |
Area code of the recipient |
|
|
Phone Number
|
phoneNumber | string |
Phone number of the recipient |
Returns
- Body
- Signer
Get recipient tabs from envelope
Get recipient tabs from envelope
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
Account id |
|
Envelope
|
envelopeId | True | string |
Envelope id |
|
Recipient id
|
recipientId | True | string |
Recipient id |
Returns
List documents from a template
List documents from a template
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
Account id |
|
Template
|
templateId | True | string |
Template id |
Returns
List documents from an envelope
List documents from an envelope
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
Account id |
|
Envelope
|
envelopeId | True | string |
Envelope id |
Returns
List recipients from envelope
List recipients from envelope
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
Account id |
|
Folder
|
folderId | True | string |
Folder id |
|
Envelope
|
envelopeId | True | string |
Envelope id |
Returns
List templates
List templates for a specific account.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
Account id |
Returns
Login
Remove recipient from an envelope
Remove recipient from an envelope
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
Account id |
|
Folder
|
folderId | True | string |
Folder id |
|
Envelope
|
envelopeId | True | string |
Envelope id |
|
Recipient
|
RemoveRecipientFromEnvelopeRecipientId | True | string |
Recipient id |
Returns
Resend the envelope
This action resends a Docusign envelope or sends a reminder to recipients who need to sign a Docusign agreement based on a provided EnvelopeId.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Envelope
|
envelopeId | True | string |
Envelope id |
Returns
- response
- object
Send envelope
Send an existing envelope.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
Account id |
|
Envelope
|
envelopeId | True | string |
Envelope id |
Returns
- response
- object
Show build Number (For reference only. Do not include in a flow for execution)
Identifier for the currently deployed build.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Build Number
|
buildNumber | dynamic |
Returns
- response
- object
Update document generation form fields from envelope
Update document generation form fields from envelope
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
Account id |
|
Envelope
|
envelopeId | True | string |
Envelope id |
|
Document Guid
|
documentGuid | True | string |
Document Guid |
|
Name
|
name | string |
Name |
|
|
Value
|
value | string |
Value |
Update envelope custom field
Update value for the specified envelope custom field
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
Account id |
|
Envelope
|
envelopeId | True | string |
Envelope id |
|
Field ID
|
fieldId | True | string |
Custom Field ID |
|
Field Type
|
fieldType | True | string |
Custom Field Type |
|
Name
|
name | True | string |
Custom Field Name |
|
Value
|
value | True | string |
Custom Field Value |
Returns
Update envelope prefill tabs
Update values for a list of prefill tabs
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
Account id |
|
Envelope
|
envelopeId | True | string |
Envelope id |
|
Document id
|
documentId | True | string |
Document id |
|
Type
|
tabType | string |
Type |
|
|
Id
|
tabId | string |
Id |
|
|
Value
|
value | string |
Value |
Update recipient on an envelope
Update recipient on an envelope
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
Account id |
|
Envelope
|
envelopeId | True | string |
Envelope id |
|
Recipient id
|
recipientId | True | string |
Recipient id |
|
Signature type
|
signatureType | string |
DocuSign standards-based-signature (SBS) types. |
|
|
Recipient type
|
recipientType | True | string |
Recipient type |
|
Client User ID
|
clientUserId | string |
Client user ID for embedded signer |
|
|
Embedded recipient start URL
|
embeddedRecipientStartURL | string |
A sender-provided URL string for redirecting an embedded recipient. |
|
|
Signing order
|
routingOrder | string |
The signing order of the recipient. |
|
|
Email notification language
|
emailNotificationLanguage | string |
Language for the email notification. |
|
|
Email notification subject
|
emailNotificationSubject | string |
Subject of the email notification. |
|
|
Email notification body
|
emailNotificationBody | string |
Body of the email notification. |
|
|
Note
|
note | string |
Custom note for the recipient. |
|
|
Role name
|
roleName | string |
Role name associated with the recipient. |
|
|
SMS Country Code
|
countryCode | integer |
For SMS notifications, the country code, without leading + sign. |
|
|
SMS Phone Number
|
phoneNumber | integer |
For SMS notifications, the phone number without the country code. |
|
|
details for selected recipient type
|
additionalRecipientParams | dynamic |
Details for selected recipient type. |
Returns
- Body
- Signer
Update recipient tab values on an envelope
Update recipient tab values on an envelope
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
Account id |
|
Envelope
|
envelopeId | True | string |
Envelope id |
|
Recipient
|
recipientId | True | string |
Recipient id |
|
Type
|
tabType | string |
Tab type |
|
|
Id
|
tabId | string |
Id |
|
|
Value
|
value | string |
Value |
Void the envelope
Void the envelope.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
Account id |
|
Envelope
|
envelopeId | True | string |
Envelope id |
|
Void reason
|
voidedReason | True | string |
Voided reason |
Returns
- response
- object
Triggers
| DEPRECATED: When an envelope status changes (Connect) |
Triggers a new flow when an envelope status changes. |
| DEPRECATED: When an envelope status changes (Connect) (V2) |
Triggers a new flow when an envelope status changes. |
| When an envelope status changes (Connect) (V3) |
Triggers a new flow when an envelope status changes. |
DEPRECATED: When an envelope status changes (Connect)
Triggers a new flow when an envelope status changes.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
Account id |
|
Connect name
|
name | True | string | |
|
Envelope event
|
envelopeEvents | True | string |
Returns
DEPRECATED: When an envelope status changes (Connect) (V2)
Triggers a new flow when an envelope status changes.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
Account id |
|
Connect name
|
name | True | string | |
|
Envelope event
|
envelopeEvents | True | string |
Returns
When an envelope status changes (Connect) (V3)
Triggers a new flow when an envelope status changes.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
Account id |
|
Connect name
|
name | True | string | |
|
Envelope event
|
envelopeEvents | True | string |
Returns
Definitions
WebhookEnvelopeResponseV2
| Name | Path | Type | Description |
|---|---|---|---|
|
Custom Fields
|
data.envelopeSummary.customFields | object |
Key-value pairs representing the custom fields for this envelope (where key is the field name, and value is the field value). |
|
Envelope Created Date-Time
|
data.envelopeSummary.createdDateTime | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ |
|
Envelope ID
|
data.envelopeSummary.envelopeId | string | |
|
Envelope Sent Date-Time
|
data.envelopeSummary.sentDateTime | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ |
|
Envelope Status
|
data.envelopeSummary.status | string | |
|
Email Subject
|
data.envelopeSummary.emailSubject | string | |
|
Sender's Name
|
data.envelopeSummary.sender.userName | string | |
|
Sender's User ID
|
data.envelopeSummary.sender.userId | string | |
|
Sender's Account ID
|
data.envelopeSummary.sender.accountId | string | |
|
Sender's Email Address
|
data.envelopeSummary.sender.email | string | |
|
signers
|
data.envelopeSummary.recipients.signers | array of object | |
|
Tabs
|
data.envelopeSummary.recipients.signers.tabs | object |
Key-value pairs representing the tabs for this recipient (where key is the field name, and value is the field value). |
|
Recipient Email
|
data.envelopeSummary.recipients.signers.email | string | |
|
Recipient Id
|
data.envelopeSummary.recipients.signers.recipientId | string | |
|
Routing Order
|
data.envelopeSummary.recipients.signers.routingOrder | string | |
|
Recipient Sent Date-Time
|
data.envelopeSummary.recipients.signers.sentDateTime | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ |
|
Recipient Status
|
data.envelopeSummary.recipients.signers.status | string |
The status of the recipient. |
|
Recipient Type
|
data.envelopeSummary.recipients.signers.recipientType | string |
The type of recipient. |
|
Verification Type
|
data.envelopeSummary.recipients.signers.verificationType | string |
The type of the verification. |
|
Recipient Name
|
data.envelopeSummary.recipients.signers.name | string |
The name of the recipient. |
WebhookEnvelopeResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
Custom Fields
|
customFields | object |
Key-value pairs representing the custom fields for this envelope (where key is the field name, and value is the field value). |
|
Envelope Created Date-Time
|
DocuSignEnvelopeInformation.EnvelopeStatus.Created | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ |
|
Sender's Email Address
|
DocuSignEnvelopeInformation.EnvelopeStatus.Email | string | |
|
Envelope ID
|
DocuSignEnvelopeInformation.EnvelopeStatus.EnvelopeID | string | |
|
Sender's IP Address
|
DocuSignEnvelopeInformation.EnvelopeStatus.SenderIPAddress | string | |
|
Envelope Sent Date-Time
|
DocuSignEnvelopeInformation.EnvelopeStatus.Sent | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ |
|
Envelope Status
|
DocuSignEnvelopeInformation.EnvelopeStatus.Status | string | |
|
Subject
|
DocuSignEnvelopeInformation.EnvelopeStatus.Subject | string | |
|
Sender's Name
|
DocuSignEnvelopeInformation.EnvelopeStatus.UserName | string | |
|
RecipientStatus
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus | array of object | |
|
Tabs
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.tabs | object |
Key-value pairs representing the tabs for this recipient (where key is the field name, and value is the field value). |
|
Decline Reason
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.DeclineReason | DeclineReasonWithoutType | |
|
Recipient Email
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.Email | string | |
|
Recipient Id
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.RecipientId | string | |
|
Routing Order
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.RoutingOrder | string | |
|
Recipient Sent Date-Time
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.Sent | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ |
|
Recipient Status
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.Status | string |
The status of the recipient. |
|
Recipient Type
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.Type | string |
The type of recipient. |
|
Recipient Name
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.UserName | string |
The name of the recipient. |
|
Time Zone
|
DocuSignEnvelopeInformation.TimeZone | string | |
|
Time Zone Offset
|
DocuSignEnvelopeInformation.TimeZoneOffset | string |
GetDocumentsResponse
- File Content
- binary
AddRemindersResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
Reminder enabled
|
reminderEnabled | string |
Reminder enabled |
FilteredEnvelopes
| Name | Path | Type | Description |
|---|---|---|---|
|
Title
|
title | string |
Title of the envelope |
|
Description
|
description | string |
Description of the envelope activity |
|
Envelope Id
|
envelopeId | string |
Envelope Id |
|
Documents
|
documents | string |
List of document names |
|
Recipient names
|
recipients | string |
List of recipient names |
|
Sender name
|
sender | string |
Sender name |
|
Status
|
status | string |
Status of the envelope |
|
Status Date
|
statusDate | string |
Last status update of the activity |
|
Date Sent
|
dateSent | date-time |
Envelope sent date |
|
URL
|
url | string |
URL of the envelope |
Activity
| Name | Path | Type | Description |
|---|---|---|---|
|
Title
|
title | string |
Title of the activity |
|
Description
|
description | string |
Description of the activity |
|
DateTime
|
dateTime | date-time |
Last status update of the activity |
|
URL
|
url | string |
URL of the envelope |
|
Additional Properties
|
additionalProperties.additionalProperties | string |
Additional properties of the activity |
DocumentRecord
| Name | Path | Type | Description |
|---|---|---|---|
|
Record Id
|
recordId | string |
Record Id |
|
Record type display name
|
recordTypeDisplayName | string |
Record type display name |
|
Record type display name in plural
|
recordTypePluralDisplayName | string |
Record type display name in plural |
|
Record type
|
recordType | string |
Record type |
|
Record title
|
recordTitle | string |
Record title |
|
Url of the envelope
|
url | string |
Url of the envelope |
|
Additional Properties
|
additionalProperties.additionalProperties | string |
Additional Properties |
EmbeddedSenderResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
Embedded Sender URL
|
url | string |
The url of embedded sender view. |
EmbeddedSigningResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
URL
|
url | string |
The url of embedded signing view. |
FilteredEnvelopeListResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
Filtered Envelopes
|
value | array of FilteredEnvelopes |
Filtered envelopes |
|
hasMoreResults
|
hasMoreResults | boolean |
ActivityListResponseEnvelope
| Name | Path | Type | Description |
|---|---|---|---|
|
Related activities
|
value | array of Activity |
Related activies |
|
hasMoreResults
|
hasMoreResults | boolean |
DocumentRecordListResponseEnvelope
| Name | Path | Type | Description |
|---|---|---|---|
|
Related records
|
value | array of DocumentRecord |
Related records |
|
hasMoreResults
|
hasMoreResults | boolean |
CreateEnvelopeResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
Envelope Id
|
envelopeId | string |
The id of the envelope. |
|
Template Id
|
templateId | string |
The id of the template. |
|
Status
|
status | string |
The status of the envelope. |
|
Status date time
|
statusDateTime | string |
The datetime the status was set. |
|
URI
|
uri | string |
The URI for the envelope in DocuSign. |
ListRecipientsResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
Signers
|
signers | array of Signer |
Signers |
Tab
| Name | Path | Type | Description |
|---|---|---|---|
|
Tab Name
|
name | string |
The name of the tab. |
|
Tab Type
|
tabType | string |
The type of the tab. |
|
Tab Label
|
tabLabel | string |
The label of the tab. |
|
Tab Value
|
value | string |
The value of the tab. |
|
Tab Id
|
tabId | string |
The id of the tab. |
|
Document Id
|
documentId | string |
The id of the document. |
|
Recipient Id
|
recipientId | string |
The id of the recipient. |
|
Is Prefill
|
prefill | boolean |
Indicates whether the tab is of prefill type. |
RecipientTabsResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
Recipient Tab:
|
recipientTabs | array of Tab |
Recipient tab |
Signer
| Name | Path | Type | Description |
|---|---|---|---|
|
Signing Order
|
routingOrder | string |
The signing order of the recipient in the document. |
|
Role
|
roleName | string |
The role of the signer. |
|
Recipient Id
|
recipientId | string |
The id the recipient. |
|
Name
|
name | string |
The name of the recipient. |
|
Email
|
string |
The email of the recipient. |
|
|
Recipient Type
|
recipientType | string |
The type the recipient. |
|
Verification Type
|
verificationType | string |
The type of verification. |
GetLoginAccountsResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
Login accounts
|
loginAccounts | array of LoginAccount |
Login accounts |
LoginAccount
| Name | Path | Type | Description |
|---|---|---|---|
|
Name
|
name | string |
The name of the account. |
|
Account Id guid
|
accountIdGuid | string |
The GUID of the account. |
ListTabsResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
Tabs
|
tabs | array of Tab |
Tabs |
ListEnvelopeDocumentFieldsResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
Custom Field
|
envelopeDocumentFields | array of EnvelopeDocumentField |
Document Custom Fields |
DocGenFormFieldsResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
Docgen Fields
|
docgenFields | array of DocGenFormField |
Docgen Fields |
DocGenFormField
| Name | Path | Type | Description |
|---|---|---|---|
|
Document Id
|
documentId | string |
Document Id. |
|
Label
|
label | string |
Label. |
|
Type
|
type | string |
Type. |
|
Name
|
name | string |
Name. |
|
Value
|
value | string |
Value. |
ListTemplatesResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
Envelope templates
|
envelopeTemplates | array of EnvelopeTemplate |
The available envelope templates. |
EnvelopeTemplate
| Name | Path | Type | Description |
|---|---|---|---|
|
Template Id
|
templateId | string |
The id of the template. |
|
Name
|
name | string |
The name of the template. |
EnvelopeCustomFieldResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
Field ID
|
fieldId | string |
The id of the envelope custom field. |
|
Field Type
|
fieldType | string |
The type of the envelope custom field. |
|
Name
|
name | string |
The name of the envelope custom field. |
|
Value
|
value | string |
The value of the envelope custom field. |
UpdateEnvelopeCustomFieldResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
Field ID
|
fieldId | string |
The id of the envelope custom field. |
|
Field Type
|
fieldType | string |
The type of the envelope custom field. |
|
Name
|
name | string |
The name of the envelope custom field. |
|
Value
|
value | string |
The value of the envelope custom field. |
ListDocumentsResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
Envelope documents
|
envelopeDocuments | array of EnvelopeDocument |
The documents attached to the envelope. |
ListTemplateDocumentsResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
Template documents
|
templateDocuments | array of EnvelopeDocument |
Documents attached to a template. |
AddDocumentsResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
Envelope Id
|
envelopeId | string |
The id of the envelope. |
|
Envelope documents
|
envelopeDocuments | array of EnvelopeDocument |
The documents attached to the envelope. |
AddRecipientTabsResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
Recipient tabs
|
recipientTabs | array of RecipientTab |
The tabs added to a recipient. |
EnvelopeDocument
| Name | Path | Type | Description |
|---|---|---|---|
|
Name
|
name | string |
The name of the document. |
|
Document Id
|
documentId | string |
The id of the document. |
|
Document Guid
|
documentIdGuid | string |
The guid of the document. |
RecipientTab
| Name | Path | Type | Description |
|---|---|---|---|
|
Tab Id
|
tabId | string |
The id of the tab. |
|
Tab Type
|
tabType | string |
The type of the tab. |
EnvelopeDocumentField
| Name | Path | Type | Description |
|---|---|---|---|
|
Name
|
name | string |
The name of the custom field. |
|
Value
|
value | string |
The value of the custom field. |
DeclineReasonWithoutType
object
This is the type 'object'.