Docusign Demo (Preview)
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. The Docusign Demo connector connects only to Docusign demo environments but offers the same functionality as the production DocuSign connector. Any agreements in a Docusign demo environment are not legally binding.
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 |
Title
DocuSign helps organizations connect and automate how they prepare, sign, act on, and manage agreements. The DocuSign Demo connector connects only to DocuSign Demo environments but offers the same functionality as the regular DocuSign connector. Any documents in a DocuSign Demo environment are not legally binding. For all non-demo uses, use the regular DocuSign connector.
Prerequisites
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.
Obtaining Credentials
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://www.docusign.com/developers/sandbox).
Connector Documentation
For detailed documentation around the connector please refer to https://support.docusign.com/en/guides/DocuSign-eSignature-for-Microsoft-Power-Automate
Known Issues and Limitations
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.
Deployment Instructions
Please use these instructions to deploy this connector as custom connector in Microsoft Power Automate and Power Apps.
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. |
| Apply a template to documents |
Apply a template to documents |
| Copilot for Sales: Get email summary |
This action gets additional sales insights that will be shown in C4S email summary experience inside outlook summary. The action enhances the existing skills of copilot for sales. |
| Copilot for Sales: Get key sales |
This action gets additional sales insights that will be shown in C4S key sales info card in outlook sidecar. The action enhances the existing skills of copilot for sales |
| Copilot for Sales: List envelopes |
Copilot for Sales: List envelopes returns information on Docusign agreements such as title, documents, recipients, agreement status, sender name and URL of the agreement. The plugin can handle requests like show me all my agreements I need to sign or what is the status of the sales order contract. |
| Copilot: Get related activities |
This action gets additional sales insights related to a CRM record that will be shown in the C4S record summary card. The action enhances the existing skills of copilot for sales. |
| Copilot: Get related records |
This action gets records related to a CRM record. The action enhances the existing skills of Copilot for Sales. |
| 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
Apply a template to documents
Apply a template to documents
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
Account ID |
|
Envelope ID
|
envelopeId | True | string |
Envelope ID |
|
Template
|
templateId | True | string |
Template |
|
Preserve template recipient
|
preserve_template_recipient | string |
False |
|
|
Document ID
|
documentId | True | string |
Document ID |
|
Document start page
|
documentStartPage | True | string |
Document start page |
|
Document end page
|
documentEndPage | True | string |
Document end page |
Copilot for Sales: Get email summary
This action gets additional sales insights that will be shown in C4S email summary experience inside outlook summary. The action enhances the existing skills of copilot for sales.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Record type
|
recordType | string |
This input identifies the record type in CRM which is related to the summarized email. |
|
|
Record Id
|
recordId | string |
This input provides the unique identifier of the CRM record which is related to the summarized email. |
|
|
CRM type
|
crmType | string |
This input indicates the type of CRM in which the record related to the summarized email exists. |
|
|
CRM org URL
|
crmOrgUrl | string |
This input indicates the URL of the CRM environment in which the record related to the summarized email exists. |
|
|
Comma separated email addresses
|
emailContacts | True | string |
This input indicates a list of all relevant participant emails in the current email thread. |
|
Top
|
top | integer |
This input indicates the number of insights to fetch. |
|
|
Skip
|
skip | integer |
This input indicates the number of items to skip when fetching insights. |
Returns
- Body
- EmailSummaryResponse
Copilot for Sales: Get key sales
This action gets additional sales insights that will be shown in C4S key sales info card in outlook sidecar. The action enhances the existing skills of copilot for sales
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Record type
|
recordType | True | string |
This input identifies the record type in CRM for which key sales info is requested. |
|
Record Id
|
recordId | True | string |
This input provides the unique identifier of the CRM record for which key sales info is requested. |
|
Start date
|
startDateTime | date-time |
Enter start date-time in the format: 2017-05-02T01:44Z |
|
|
Top
|
top | integer |
This input indicates the number of sales highlights to fetch. |
|
|
Skip
|
skip | integer |
This input indicates the number of items to skip when fetching sales highlights. |
|
|
CRM type
|
crmType | string |
This input indicates the type of CRM in which the CRM record exists, for which key sales info is requested. |
|
|
CRM org URL
|
crmOrgUrl | string |
This input indicates the URL of the CRM environment in which the CRM record exists, for which key sales info is requested. |
Returns
- Body
- KeySalesResponse
Copilot for Sales: List envelopes
Copilot for Sales: List envelopes returns information on Docusign agreements such as title, documents, recipients, agreement status, sender name and URL of the agreement. The plugin can handle requests like show me all my agreements I need to sign or what is the status of the sales order contract.
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
|
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 |
Returns
Copilot: Get related activities
This action gets additional sales insights related to a CRM record that will be shown in the C4S record summary card. The action enhances the existing skills of copilot for sales.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Record type
|
recordType | True | string |
This input indicates the entity or object type in CRM for which insights are requested. |
|
Record Id
|
recordId | True | string |
This input indicates the unique identifier of the CRM record for which insights are requested. |
|
Start date
|
startDateTime | date-time |
This input indicates the start date and time for insights requested. |
|
|
End date
|
endDateTime | date-time |
This input indicates the end date and time for insights requested. |
|
|
Top
|
top | integer |
This input indicates the number of insights to fetch. |
|
|
Skip
|
skip | integer |
This input indicates the number of insights to skip. |
|
|
CRM type
|
crmType | string |
This input indicates the type of CRM in which the CRM record exists, for which insights are requested. |
|
|
CRM org URL
|
crmOrgUrl | string |
This input indicates the URL of the CRM environment in which the CRM record exists, for which insights are requested. |
Returns
Copilot: Get related records
This action gets records related to a CRM record. The action enhances the existing skills of Copilot for Sales.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Record type
|
recordType | True | string |
This input identifies the record type in CRM for which related records are requested. |
|
Record Id
|
recordId | True | string |
This input provides the unique identifier of the CRM record for which related records are requested. |
|
Start date
|
startDateTime | date-time |
Enter start date-time in the format: 2017-05-02T01:44Z |
|
|
Top
|
top | integer |
This input indicates the number of related records to fetch. |
|
|
Skip
|
skip | integer |
This input indicates the number of records to skip when fetching related records. |
|
|
CRM type
|
crmType | string |
This input indicates the type of CRM the related records are fetched from. |
|
|
CRM org URL
|
crmOrgUrl | string |
This input indicates the URL of the CRM environment the related records are fetched from. |
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 '' when no value is provided by user. Enter start date-time in the pattern or format: 2017-05-02T01:44Z. |
|
|
End date
|
to_date | date-time |
Enter '' when no value is provided by user. Enter end date-time in the pattern or format: 2017-05-02T01:44Z. |
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 |
SalesCopilotFilteredEnvelopes
| Name | Path | Type | Description |
|---|---|---|---|
|
Title
|
title | string |
Title of the envelope |
|
SubTitle
|
subTitle | string |
SubTitle of the envelope |
|
URL
|
url | string |
URL of the envelope |
|
Additional Properties
|
additionalPropertiesForSalesEnvelope.additionalPropertiesForSalesEnvelope | string |
Additional Properties |
Activity
| Name | Path | Type | Description |
|---|---|---|---|
|
Title
|
title | string |
This output indicates the title of the activity in the citation card. |
|
Description
|
description | string |
This output indicates the description of the insight. |
|
DateTime
|
dateTime | date-time |
This output indicates the time associated with the insight. |
|
URL
|
url | string |
This output indicates the URL to open insight. |
|
Additional Properties
|
additionalProperties.additionalProperties | string |
Additional properties of the activity |
EmailSummary
| Name | Path | Type | Description |
|---|---|---|---|
|
Title
|
Title | string |
This output indicates the title of the partner section and should include only the partner's name. |
|
description
|
Description | string |
This output indicates the text you would like to be included in the email summary. |
KeySales
| Name | Path | Type | Description |
|---|---|---|---|
|
Title
|
Title | string |
This output indicates the title of citation card for the insight. |
|
description
|
description | string |
This output indicates the text of the insight to be included in key sales info. |
|
Url of the envelope
|
url | string |
This output indicates the URL to learn more about the insight. |
|
Time accosiated with the insight
|
dateTime | string |
This output indicates the time associated with the insight. |
|
Additional Properties
|
additionalProperties.additionalProperties | string |
This output indicates additional properties as name-value pairs of each related insight returned by the action. |
DocumentRecord
| Name | Path | Type | Description |
|---|---|---|---|
|
Record Id
|
recordId | string |
This output uniquely identifies each related record returned by the action. |
|
Record type display name
|
recordTypeDisplayName | string |
This output indicates the display name of record type of each related record returned by the action. |
|
Record type display name in plural
|
recordTypePluralDisplayName | string |
This output indicates the plural display name of the record type of each related record returned by the action. |
|
Record type
|
recordType | string |
This output indicates the type of each related record returned by the action. |
|
Record title
|
recordTitle | string |
This output indicates the title of each related record returned by the action. |
|
Url of the envelope
|
url | string |
This output indicates the URL of each related record returned by the action. |
|
Additional Properties
|
additionalProperties.additionalProperties | string |
This output indicates additional properties as name-value pairs of each related record returned by the action. |
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 |
Specifies if there are more envelopes available |
FilteredSalesCopilotEnvelopeListResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
Filtered Envelopes
|
value | array of SalesCopilotFilteredEnvelopes |
Filtered envelopes |
|
hasMoreResults
|
hasMoreResults | boolean |
ActivityListResponseEnvelope
| Name | Path | Type | Description |
|---|---|---|---|
|
Related activities
|
value | array of Activity |
Related activies |
|
hasMoreResults
|
hasMoreResults | boolean |
EmailSummaryResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
Email summary
|
value | array of EmailSummary |
Key Sales |
|
hasMoreResults
|
hasMoreResults | boolean |
KeySalesResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
Key sales`
|
value | array of KeySales |
Key Sales |
|
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. |
|
Recipient Guid
|
recipientIdGuid | string |
The recipient Guid. |
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'.