DocuSign Demo (Preview)

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.
This connector is available in the following products and regions:
Service | Class | Regions |
---|---|---|
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 |
Throttling Limits
Name | Calls | Renewal Period |
---|---|---|
API calls per connection | 100 | 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 tabs for a recipient |
Add tabs for a recipient. |
Add verification type to a recipient |
Add verification type to a recipient. |
Create envelope |
Create a new blank envelope. |
Create envelope using template (V2) |
Create a new envelope using a specified template. |
DEPRECATED: Add recipient to an envelope |
Add recipient to an envelope. |
DEPRECATED: Send envelope using template (V1) |
Create a new envelope using a specified template. |
Generate Embedded Sender URL |
Generate Embedded Sender URL |
Generate Embedded Signing URL |
Generate Embedded Signing URL |
Get envelope documents |
Get envelope documents. |
List recipients |
List recipients for a specific envelope. |
Login |
Login |
Remove recipient from an envelope |
Remove recipient from an envelope |
Send envelope |
Send an existing 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 |
Base64 *
|
documentBase64 | True | string |
Base64 of document content |
type *
|
fileExtension | True | string |
pdf, docx etc. |
name *
|
name | True | string |
document name |
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 |
|
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
Add tabs for a recipient
Add tabs for a recipient.
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
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 (V2)
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: 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: Send envelope using template (V1)
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 |
Signers
|
signers | True | dynamic |
The signers of the document. |
Returns
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 envelope documents
Get envelope documents.
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
List recipients
List recipients for a specific 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
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
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
Triggers
DEPRECATED: When an envelope status changes (Connect) |
Triggers a new flow when an envelope status changes. |
When an envelope status changes (Connect) (V2) |
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
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
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
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. |
CreateEnvelopeResponse
Name | Path | Type | Description |
---|---|---|---|
Envelope Id
|
envelopeId | string |
The id of the envelope. |
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 |
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. |
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 |
---|---|---|---|
Document Id
|
documentId | string |
The id of the document. |
Name
|
name | string |
The name 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. |
DeclineReasonWithoutType
object
This is the type 'object'.