Skip to main content

DocuSign Component

DocuSign

Use the DocuSign component to manage signature collection and document distribution.

Component key: docusign

Description​

DocuSign provides intuitive solutions for sending and collecting signatures on documents. Use the DocuSign component to manage signature collection and document distribution.

Use the DocuSign component to send, sign, track, and manage the signature process.

API Documentation: DocuSign API Reference

Connections​

OAuth 2.0​

Docusign requires a Developer Account to create applications for integrations. Create an acccount at Developers.docusign.com for more information.

To Create an App for Docusign for your Developer Account:

  1. Login to your DocuSign Developer Account
  2. Click on your profile icon in the top right hand corner and select My Apps & Keys
  3. Select Add App and Integration Key to create a new application
  4. Note your Integration Key and under the Secret Keys section select Add Secret Key and copy your generated secret key
  5. In Additional settings under Redirect URI’s enter https://oauth2.prismatic.io/callback as the value
  6. Save the App and enter the Integration Key and Secret Key values into the designated fields of your integration’s connection configuration.

The DocuSign Oauth connection requires you to add an Authorization Header with a combination of your integration and secret keys concatenated by a colon character, converted into base64, and prefixed with the word Basic.
If your integration key is 7c2b8d7e-xxxx-xxxx-xxxx-cda8a50dd73f and the secret key is d7014634-xxxx-xxxx-xxxx-6842b7aa8861,

You may use the following Base64 Encoder. In the first box enter in the format of <integration key>:<secret key> 'example: 7c2b8d7e-xxxx-xxxx-xxxx-cda8a50dd73f:d7014634-xxxx-xxxx-xxxx-6842b7aa8861' and select the ENCODE button. The encoded results will appear below 'example: NWMyYjhkN2.....hODg2MQ==' Enter the Authorization Header value in your connection configuration as Basic <encoded results> example: Basic NWMyYjhkN2.....hODg2MQ==

You may also get the base64 value in a JavaScript console with the following method call:

btoa('7c2b8d7e-xxxx-xxxx-xxxx-cda8a50dd73f:d7014634-xxxx-xxxx-xxxx-6842b7aa8861')

This method call results in a new authorization header value: NWMyYjhkN2.....hODg2MQ==.
The final header value will be Basic NWMyYjhkN2.....hODg2MQ==.

InputDefaultNotes
Authorize URL
string
/ Required
authorizeUrl
https://account-d.docusign.com/oauth/auth
The OAuth 2.0 Authorization URL for the API
Integration Key
string
/ Required
clientId
Integration Identifier of your app for the API
Secret Key
password
/ Required
clientSecret
Secret Key of your app for the API
Authorization Header
string
/ Required
Key Value List
headers
You must supply an Authorization header to get a token. Key input value should be 'Authorization' and Headers value should be 'Basic <base64 encoded integration_key:secret_key>'
Scopes
string
/ Required
Hidden Field
scopes
signature
 
Token URL
string
/ Required
tokenUrl
https://account-d.docusign.com/oauth/token
The OAuth 2.0 Token URL for the API
Use Live Environment
boolean
useLiveEnvironment
Use the live DocuSign API environment

Triggers​

Account Level Trigger​

Get notified when an event occurs at the account. | key: accountTrigger

InputNotes
Connection
connection
/ Required
connection
 
Connect Key
string
/ Required
connectKey
This key is used to create the HMAC hash that DocuSign will send along with the message. Check https://developers.docusign.com/platform/webhooks/connect/setting-up-hmac/ for instructions on how to generate a key.
Webhook Event
string
/ Required
Value List
webhookEvents
 

Data Sources​

Select Folder​

Select a Folder. | key: folders | type: picklist

InputDefaultNotesExample
Connection
connection
/ Required
connection
 
 
 
Count
string
count
The maximum number of results to return.
10
Include
string
include
A comma-separated list of folder types to include in the response. Valid values are: envelope_folders, template_folders and shared_template_folders.
envelope_folders
Include Items
boolean
includeItems
Indicates whether folder items are included in the response. If this parameter is omitted, the default is false.
 
Start Position
string
startPosition
The zero-based index of the result from which to start returning results.
30
Sub Folder Depth
string
subFolderDepth
If missing or any value other than -1, the returned list contains only the top-level folders. A value of -1 returns the complete folder hierarchy.
1
User Filter
string
userFilter
Narrows down the resulting folder list by the following values: all, owned_by_me and shared_with_me.
all

Select Template​

Select a Template. | key: templates | type: picklist

InputNotes
Connection
connection
/ Required
connection
 

Actions​

Create Account​

Creates a new DocuSign account. | key: createAccount

InputNotesExample
Account Name
string
accountName
The account name for the new account.
My Account Name
Address 1
string
address1
The first line of the address. Maximum length: 100 characters.
123 Main St
Address 2
string
address2
The second line of the address. Maximum length: 100 characters.
Suite 100
City
string
city
The city associated with the address. Maximum length: 40 characters.
San Francisco
Company
string
company
The name of the user's company.
Prismatic
Connection
connection
/ Required
connection
 
 
Country
string
country
The country associated with the address. Maximum length: 50 characters.
 
Distributor Code
string
distributorCode
The Distributor Code that you received from DocuSign.
DEVCENTER_DEMO_APRIL2013
Distributor Password
string
distributorPassword
The password for the Distributor Code.
 
Email
string
email
The user's email address.
example@email.com
Fax
string
fax
The fax number associated with the account.
555-555-5555
First Name
string
firstName
The user's first name. Maximum Length: 50 characters.
John
Included Seats
string
includedSeats
The number of seats (users) included in the plan.
 
Job Title
string
jobTitle
The user's job title.
Software Engineer
Last Name
string
lastName
The user's last name. Maximum Length: 50 characters.
Smith
Middle Name
string
middleName
The user's middle name. Maximum Length: 50 characters.
Jacob
Phone
string
phone
The phone number associated with the account.
555-555-5555
Plan ID
string
planId
DocuSign's ID for the account plan.
 
Postal Code
string
postalCode
The postal code associated with the address. Maximum length: 20 characters.
94105
Referral Code
string
referralCode
 
 
Referrer Name
string
referrerName
The name of the referrer.
 
State
string
state
The state or province associated with the address. Maximum length: 40 characters.
California
Suffix Name
string
suffixName
The suffix for the user's name. Maximum Length: 50 characters.
Jr
User Name
string
userName
The name of the user.
John Smith

Create Account Signature​

Adds or updates one or more account stamps. | key: createAccountSignature

InputDefaultNotes
Connection
connection
/ Required
connection
 
 
JSON Input
code
/ Required
jsonInput
For extra fields, see https://developers.docusign.com/docs/esign-rest-api/reference/accounts/accountsignatures/createaccountsignatures/

Create Bulk Send List​

This method creates a bulk send list that you can use to send an envelope to up to 1,000 recipients at once. | key: createBulkSendList

InputDefaultNotes
Connection
connection
/ Required
connection
 
 
JSON Input
code
jsonInput
For extra fields, see https://developers.docusign.com/docs/esign-rest-api/reference/bulkenvelopes/bulksend/createbulksendlist/

Create Contact​

This method adds multiple contacts into a contacts list. | key: createContact

InputDefaultNotes
Connection
connection
/ Required
connection
 
 
JSON Input
code
/ Required
jsonInput
For extra fields, see https://developers.docusign.com/docs/esign-rest-api/reference/users/contacts/create/

Create Envelope​

Creates and sends an envelope or creates a draft envelope. | key: createEnvelope

InputDefaultNotes
Change Routing Order
boolean
changeRoutingOrder
When true, users can define the routing order of recipients while sending documents for signature.
Connection
connection
/ Required
connection
 
 
JSON Input
code
/ Required
jsonInput
For extra fields, see https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/
Merge Roles On Draft
boolean
mergeRolesOnDraft
When true, template roles will be merged, and empty recipients will be removed. This parameter applies when you create a draft envelope with multiple templates.

Create Template​

Creates one or more template definitions, using a multipart request for each template. | key: createTemplate

InputDefaultNotes
Connection
connection
/ Required
connection
 
 
JSON Input
code
/ Required
jsonInput
For extra fields, see https://developers.docusign.com/docs/esign-rest-api/reference/templates/templates/create/

Create Webhook​

Create a new webhook (Account Level). | key: createWebhook

InputDefaultNotesExample
Connection
connection
/ Required
connection
 
 
 
Include HMAC
boolean
includeHMAC
When set to true, the HMAC hash is included in the message along with the API request.
 
URL To Publish To
string
/ Required
urlToPublishTo
The URL that DocuSign will publish events to.
https://www.example.com
Webhook Event
string
/ Required
Value List
webhookEvents
 
 
Connect (Webhook) Configuration Name
string
/ Required
webhookName
A name for the configuration.
My Webhook

Delete Account​

Closes the specified account. | key: deleteAccount

InputNotesExample
Account ID
string
/ Required
accountId
The external account number (int) or account ID GUID.
23233123
Connection
connection
/ Required
connection
 
 

Delete Account Signature​

Deletes a stamp specified by signatureId. | key: deleteAccountSignature

InputNotesExample
Account ID
string
/ Required
accountId
The external account number (int) or account ID GUID.
23233123
Connection
connection
/ Required
connection
 
 
Signature ID
string
/ Required
signatureId
 
 

Delete All Instanced Webhooks​

Delete all webhooks that point to a flow in this instance. | key: deleteAllInstancedWebhooks

InputNotes
Connection
connection
/ Required
connection
 

Delete Bulk Send List​

This method deletes a bulk send list. | key: deleteBulkSendList

InputNotes
Bulk Send List ID
string
/ Required
bulkSendListId
The GUID of the bulk send list. This property is created after you post a new bulk send list.
Connection
connection
/ Required
connection
 

Delete Contact​

This method deletes a contact associated with an account. | key: deleteContact

InputNotes
Connection
connection
/ Required
connection
 
Contact ID
string
/ Required
contactId
The ID of a contact person in the account's address book.

Delete Envelope Document​

Deletes one or more documents from an existing envelope that has not yet been completed. | key: deleteEnvelopeDocument

InputNotesExample
Connection
connection
/ Required
connection
 
 
Document IDs
string
/ Required
Value List
documentIds
A list of document IDs to delete.
1
Envelope ID
string
/ Required
envelopeId
The envelope's GUID.
d6f6a764-1021-43df-b8db-06c5477dd28a

Delete Template Document​

This method deletes one or more documents from an existing template. | key: deleteTemplateDocument

InputNotesExample
Connection
connection
/ Required
connection
 
 
Document IDs
string
/ Required
Value List
documentIds
A list of document IDs to delete.
1
Template ID
string
/ Required
templateId
The ID of the template.
d6f6a764-1021-43df-b8db-06c5477dd28a

Delete User​

Closes one or more users in the account, preventing them from accessing account features. | key: deleteUser

InputDefaultNotesExample
Connection
connection
/ Required
connection
 
 
 
Delete
string
deleteParam
A list of groups to remove the user from. A comma-separated list of the following: Groups, PermissionSet or SigningGroupsEmail.
Groups
User IDs
string
/ Required
Value List
userIds
A list of user IDs to delete.
a1b5f946-2351-4380-b24e-297e8c708a67

Delete Webhook​

Delete a single webhook. | key: deleteWebhook

InputNotesExample
Connect ID
string
/ Required
connectId
The ID of the custom Connect (Webhook) configuration to delete.
10486941
Connection
connection
/ Required
connection
 
 

Get Account​

Retrieves the account information for the specified account. | key: getAccount

InputNotesExample
Account ID
string
/ Required
accountId
The external account number (int) or account ID GUID.
23233123
Connection
connection
/ Required
connection
 
 

Get Account Signature​

Returns information about the specified stamp. | key: getAccountSignature

InputNotes
Connection
connection
/ Required
connection
 
Signature ID
string
/ Required
signatureId
 

Get Account Signature Image​

Returns the image for an account stamp. | key: getAccountSignatureImage

InputNotes
Connection
connection
/ Required
connection
 
Image Type
string
/ Required
imageType
Specificies the type of image.
Signature ID
string
/ Required
signatureId
 

Get Bulk Send Batches​

Returns a summary of bulk send batches. | key: getBulkSendBatches

InputNotes
Connection
connection
/ Required
connection
 

Get Bulk Send List​

This method returns all of the details associated with a specific bulk send list that belongs to the current user. | key: getBulkSendList

InputNotes
Bulk Send List ID
string
/ Required
bulkSendListId
The GUID of the bulk send list. This property is created after you post a new bulk send list.
Connection
connection
/ Required
connection
 

Get Bulk Send Lists​

This method returns a list of bulk send lists belonging to the current user, as well as basic information about each list. | key: getBulkSendLists

InputNotes
Connection
connection
/ Required
connection
 

Get Bulk Send Status​

Gets the general status of a specific bulk send batch. | key: getBulkSendBatchStatus

InputNotesExample
Bulk Send Batch ID
string
/ Required
bulkSendBatchId
The batch ID.
d6f6a764-1021-43df-b8db-06c5477dd28a
Connection
connection
/ Required
connection
 
 

Get Contact​

This method returns one or more contacts associated with a DocuSign account. | key: getContact

InputNotesExample
Cloud Provider
string
cloudProvider
The cloud provider from which to retrieve the contacts. Valid values are: rooms or docusignCore.
rooms
Connection
connection
/ Required
connection
 
 
Contact ID
string
/ Required
contactId
The ID of a contact person in the account's address book.
 

Get Envelope​

Retrieves the overall status for the specified envelope. | key: getEnvelope

InputDefaultNotesExample
Advanced Update
boolean
advancedUpdate
 
 
Connection
connection
/ Required
connection
 
 
 
Envelope ID
string
/ Required
envelopeId
The envelope's GUID.
d6f6a764-1021-43df-b8db-06c5477dd28a
Include
string
include
Specifies additional information about the envelope to return. Enter a comma-separated list, such as tabs,recipients.
envelope_folders

Get Envelope Document​

Retrieves a single document or all documents from an envelope. | key: getEnvelopeDocument

InputDefaultNotesExample
Certificate
boolean
certificate
When true, the certificate of completion is included in the combined PDF file.
 
Connection
connection
/ Required
connection
 
 
 
Document ID
string
/ Required
documentId
The ID of the document to retrieve.
1
Documents By User ID
boolean
documentsByUserid
When true, allows recipients to get documents by their user id.
 
Encrypt
boolean
encrypt
When true, the PDF bytes returned in the response are encrypted for all the key managers configured on your DocuSign account.
 
Envelope ID
string
/ Required
envelopeId
The envelope's GUID.
d6f6a764-1021-43df-b8db-06c5477dd28a
Language
string
language
Specifies the language for the Certificate of Completion in the response. The supported languages are: Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Dutch (nl), English US (en), French (fr), German (de), Italian (it), Japanese (ja), Korean (ko), Portuguese (pt), Portuguese (Brazil) (pt_BR), Russian (ru), Spanish (es).
en
Recipient ID
string
recipientId
Allows the sender to retrieve the documents as one of the recipients that they control. The documents_by_userid parameter must be set to false for this to work.
3842784d-ef49-43e0-8c9c-714812a90ddd
Shared User ID
string
sharedUserId
The ID of a shared user that you want to impersonate in order to retrieve their view of the list of documents.
3842784d-ef49-43e0-8c9c-714812a90ddd
Show Changes
boolean
showChanges
When true, any changed fields for the returned PDF are highlighted in yellow and optional signatures or initials outlined in red. The account must have the Highlight Data Changes feature enabled.
 
Watermark
boolean
watermark
When true, the account has the watermark feature enabled, and the envelope is not complete, then the watermark for the account is added to the PDF documents. This option can remove the watermark.
 

Get Recipient Signature​

Retrieves signature information for a signer or sign-in-person recipient. | key: getRecipientSignature

InputNotesExample
Connection
connection
/ Required
connection
 
 
Envelope ID
string
/ Required
envelopeId
The envelope's GUID.
d6f6a764-1021-43df-b8db-06c5477dd28a
Recipient ID
string
/ Required
recipientId
A local reference used to map recipients to other objects, such as specific document tabs. A recipientId must be either an integer or a GUID, and the recipientId must be unique within an envelope.
3842784d-ef49-43e0-8c9c-714812a90ddd

Get Recipient Signature Image​

Retrieves the specified user signature image. | key: getRecipientSignatureImage

InputDefaultNotesExample
Connection
connection
/ Required
connection
 
 
 
Envelope ID
string
/ Required
envelopeId
The envelope's GUID.
d6f6a764-1021-43df-b8db-06c5477dd28a
Include Chrome
boolean
includeChrome
When true, the response includes the chromed version of the signature image.
 
Recipient ID
string
/ Required
recipientId
A local reference used to map recipients to other objects, such as specific document tabs. A recipientId must be either an integer or a GUID, and the recipientId must be unique within an envelope.
3842784d-ef49-43e0-8c9c-714812a90ddd

Get Template​

Retrieves the definition of the specified template. | key: getTemplate

InputNotesExample
Connection
connection
/ Required
connection
 
 
Template ID
string
/ Required
templateId
The ID of the template.
d6f6a764-1021-43df-b8db-06c5477dd28a

Get Template Document​

This method retrieves one or more PDF documents from the template that you specify. | key: getTemplateDocument

InputDefaultNotesExample
Connection
connection
/ Required
connection
 
 
 
Document ID
string
/ Required
documentId
The ID of the document to retrieve.
1
Encrypt
boolean
encrypt
When true, the PDF bytes returned in the response are encrypted for all the key managers configured on your DocuSign account.
 
File Type
string
fileType
 
 
Show Changes
boolean
showChanges
When true, any document fields that a recipient changed are highlighted in yellow in the returned PDF document, and optional signatures or initials are outlined in red.
 
Template ID
string
/ Required
templateId
The ID of the template.
d6f6a764-1021-43df-b8db-06c5477dd28a

Get User​

Retrieves the user information for the specified user. | key: getUser

InputNotesExample
Connection
connection
/ Required
connection
 
 
User ID
string
/ Required
userId
The ID of the user to access.
a1b5f946-2351-4380-b24e-297e8c708a67

Get Webhook​

Retrieve a single webhook. | key: getWebhook

InputNotesExample
Connect ID
string
/ Required
connectId
The ID of the custom Connect (Webhook) configuration being accessed.
10486941
Connection
connection
/ Required
connection
 
 

List Account Settings​

Retrieves the account settings information for the specified account. | key: listAccountSettings

InputNotesExample
Account ID
string
/ Required
accountId
The external account number (int) or account ID GUID.
23233123
Connection
connection
/ Required
connection
 
 

List Envelope Documents​

Retrieves a list of documents associated with the specified envelope. | key: listEnvelopeDocuments

InputDefaultNotesExample
Connection
connection
/ Required
connection
 
 
 
Documents By User ID
boolean
documentsByUserid
When true, allows recipients to get documents by their user id.
 
Envelope ID
string
/ Required
envelopeId
The envelope's GUID.
d6f6a764-1021-43df-b8db-06c5477dd28a
Include Metadata
boolean
includeMetadata
When true, the response includes metadata that indicates which properties the sender can edit.
 
Include Tabs
boolean
includeTabs
When true, information about the tabs, including prefill tabs, associated with the documents are included in the response.
 
Recipient ID
string
recipientId
Allows the sender to retrieve the documents as one of the recipients that they control. The documents_by_userid parameter must be set to false for this to work.
3842784d-ef49-43e0-8c9c-714812a90ddd
Shared User ID
string
sharedUserId
The ID of a shared user that you want to impersonate in order to retrieve their view of the list of documents.
3842784d-ef49-43e0-8c9c-714812a90ddd

List Folder Items​

Gets information about items in the specified folder. | key: listFolderItems

InputDefaultNotesExample
Connection
connection
/ Required
connection
 
 
 
Folder ID
string
/ Required
folderId
The ID of the folder.
d6f6a764-1021-43df-b8db-06c5477dd28a
Include Items
boolean
includeItems
Indicates whether folder items are included in the response. If this parameter is omitted, the default is false.
 

List Folders​

Returns a list of the account's folders. | key: listFolders

InputDefaultNotesExample
Connection
connection
/ Required
connection
 
 
 
Count
string
count
The maximum number of results to return.
10
Include
string
include
A comma-separated list of folder types to include in the response. Valid values are: envelope_folders, template_folders and shared_template_folders.
envelope_folders
Include Items
boolean
includeItems
Indicates whether folder items are included in the response. If this parameter is omitted, the default is false.
 
Start Position
string
startPosition
The zero-based index of the result from which to start returning results.
30
Sub Folder Depth
string
subFolderDepth
If missing or any value other than -1, the returned list contains only the top-level folders. A value of -1 returns the complete folder hierarchy.
1
User Filter
string
userFilter
Narrows down the resulting folder list by the following values: all, owned_by_me and shared_with_me.
all

List Template Documents​

Retrieves a list of documents associated with the specified template. | key: listTemplateDocuments

InputNotesExample
Connection
connection
/ Required
connection
 
 
Template ID
string
/ Required
templateId
The ID of the template.
d6f6a764-1021-43df-b8db-06c5477dd28a

List Templates​

Retrieves the list of templates for the specified account. | key: listTemplates

InputNotes
Connection
connection
/ Required
connection
 

List Webhooks​

Retrieve all webhooks. | key: listWebhooks

InputNotes
Connection
connection
/ Required
connection
 

Raw Request​

Send raw HTTP request to DocuSign. | key: rawRequest

InputDefaultNotesExample
Connection
connection
/ Required
connection
 
 
 
Data
string
data
The HTTP body payload to send to the URL.
{"exampleKey": "Example Data"}
Debug Request
boolean
debugRequest
false
Enabling this flag will log out the current request.
 
File Data
string
Key Value List
fileData
File Data to be sent as a multipart form upload.
[{key: "example.txt", value: "My File Contents"}]
File Data File Names
string
Key Value List
fileDataFileNames
File names to apply to the file data inputs. Keys must match the file data keys above.
 
Form Data
string
Key Value List
formData
The Form Data to be sent as a multipart form upload.
[{"key": "Example Key", "value": new Buffer("Hello World")}]
Header
string
Key Value List
headers
A list of headers to send with the request.
User-Agent: curl/7.64.1
Max Retry Count
string
maxRetries
0
The maximum number of retries to attempt. Specify 0 for no retries.
 
Method
string
/ Required
method
The HTTP method to use.
 
Query Parameter
string
Key Value List
queryParams
A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.
 
Response Type
string
/ Required
responseType
json
The type of data you expect in the response. You can request json, text, or binary data.
 
Retry On All Errors
boolean
retryAllErrors
false
If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors.
 
Retry Delay (ms)
string
retryDelayMS
0
The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.
 
Timeout
string
timeout
The maximum time that a client will await a response to its request
2000
URL
string
/ Required
url
Input the path only (/ACCOUNT_ID/folders), The base URL is already included (https://account.docusign.com for live environment or https://account-d.docusign.com for development). For example, to connect to https://account.docusign.com/ACCOUNT_ID/folders, only /ACCOUNT_ID/folders is entered in this field.
/ACCOUNT_ID/folders
Use Exponential Backoff
boolean
useExponentialBackoff
false
Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.
 

Update Account Signature​

Updates an account stamp specified by the signatureId query parameter. | key: updateAccountSignature

InputDefaultNotesExample
Connection
connection
/ Required
connection
 
 
 
Date Area Height
string
dateAreaHeight
The height of the rectangle.
 
Date Area Width
string
dateAreaWidth
The width of the rectangle.
 
Date Area X
string
dateAreaX
The X axis position of the top-left corner.
 
Date Area Y
string
dateAreaY
The Y axis position of the top-left corner.
 
Disallow User Resize Stamp
boolean
disallowUserResizeStamp
When set to true, prevents the user from resizing the stamp.
 
External ID
string
externalID
Optionally specify an external identifier for the user's signature.
 
Image Type
string
imageType
Specificies the type of image.
 
Is Default
boolean
isDefault
Boolean that specifies whether the signature is the default signature for the user.
 
NRDS ID
string
nrdsId
The National Association of Realtors (NAR) membership ID for a user who is a realtor.
123456789
NRDS Last Name
string
nrdsLastName
The last name of the user who is a realtor.
Smith
Phonetic Name
string
phoneticName
The phonetic spelling of the signatureName.
 
Signature Font
string
signatureFont
The font type to use for the signature if the signature is not drawn.
 
Signature Groups
code
signatureGroups
A JSON array of signature groups.
 
Signature ID
string
signatureId
Specifies the signature ID associated with the signature name.
 
Signature ID
string
/ Required
signatureIdPath
Signature ID to update.
 
Signature Initials
string
signatureInitials
Specifies the user's signature in initials format.
JS
Signature Name
string
signatureName
Specifies the user's signature name.
John Smith
Signature Type
string
signatureType
The type of signature. Check this link for more information: https://support.docusign.com/s/document-item?language=en_US&bundleId=xcm1643837555908&topicId=url1578456563691.html
Electronic Signature
Signature Users
code
signatureUsers
JSON array of users associated with the signature.
 
Stamp Format
string
stampFormat
NameHanko refers to the stamp that displays only the name of the signer. On the other hand, NameDateHanko refers to the stamp that displays both the name and date.
 
Stamp Size MM
string
stampSizeMM
The size of the stamp in millimeters.
10

Update Account Signature Image​

Sets a signature image, initials, or stamp. | key: updateAccountSignatureImage

InputNotes
Connection
connection
/ Required
connection
 
Image Type
string
/ Required
imageType
Specificies the type of image.
Signature ID
string
/ Required
signatureId
The ID of the account stamp.

Update Bulk Send List​

This method replaces the definition of an existing bulk send list. | key: updateBulkSendList

InputDefaultNotes
Bulk Send List ID
string
/ Required
bulkSendListId
The GUID of the bulk send list. This property is created after you post a new bulk send list.
Connection
connection
/ Required
connection
 
 
JSON Input
code
jsonInput
For extra fields, see https://developers.docusign.com/docs/esign-rest-api/reference/bulkenvelopes/bulksend/updatebulksendlist/

Update Contact​

This method updates one or more contacts associated with an account. | key: updateContact

InputDefaultNotes
Connection
connection
/ Required
connection
 
 
JSON Input
code
/ Required
jsonInput
For extra fields, see https://developers.docusign.com/docs/esign-rest-api/reference/users/contacts/update/

Update Envelope​

This method enables you to make changes to an envelope. | key: updateEnvelope

InputDefaultNotesExample
Advanced Update
boolean
advancedUpdate
When true, allows the caller to update recipients, tabs, custom fields, notification, email settings and other envelope attributes.
 
Connection
connection
/ Required
connection
 
 
 
Envelope ID
string
/ Required
envelopeId
The envelope's GUID.
d6f6a764-1021-43df-b8db-06c5477dd28a
JSON Input
code
/ Required
jsonInput
For extra fields, see https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/update/
 
Resend Envelope
boolean
resendEnvelope
When true, sends the specified envelope again.
 

Update Envelope Document​

Adds or replaces a document in an existing draft or in-process envelope. | key: updateEnvelopeDocument

InputDefaultNotesExample
Connection
connection
/ Required
connection
 
 
 
Document ID
string
/ Required
documentId
The unique ID of the document within the envelope.
1
Document Name
string
/ Required
documentName
newDocument
The name of the document.
newDocument
Envelope ID
string
/ Required
envelopeId
The envelope's GUID.
d6f6a764-1021-43df-b8db-06c5477dd28a
PDF data
data
/ Required
pdfBuffer
This must refer to a buffer containing the raw bytes of a PDF.
 

Update Template​

Updates an existing template. | key: updateTemplate

InputDefaultNotesExample
Connection
connection
/ Required
connection
 
 
 
JSON Input
code
/ Required
jsonInput
For extra fields, see https://developers.docusign.com/docs/esign-rest-api/reference/templates/templates/update/
 
Template ID
string
/ Required
templateId
The ID of the template.
d6f6a764-1021-43df-b8db-06c5477dd28a

Update Template Document​

This methods updates an existing template document. | key: updateTemplateDocument

InputDefaultNotesExample
Connection
connection
/ Required
connection
 
 
 
Document ID
string
/ Required
documentId
The ID of the document to retrieve.
1
JSON Input
code
/ Required
jsonInput
For extra fields, see https://developers.docusign.com/docs/esign-rest-api/reference/templates/templatedocuments/update/
 
Template ID
string
/ Required
templateId
The ID of the template.
d6f6a764-1021-43df-b8db-06c5477dd28a

Update User​

To update user information for a specific user, submit a Users object with updated field values in the request body of this operation. | key: updateUser

InputDefaultNotesExample
Connection
connection
/ Required
connection
 
 
 
JSON Input
code
/ Required
jsonInput
For extra fields, see https://developers.docusign.com/docs/esign-rest-api/reference/users/users/update/
 
User ID
string
/ Required
userId
The ID of the user to access.
a1b5f946-2351-4380-b24e-297e8c708a67

Update Webhook​

Update an existing webhook. | key: updateWebhook

InputDefaultNotes
Connection
connection
/ Required
connection
 
 
JSON Input
code
/ Required
jsonInput
For extra fields, see https://developers.docusign.com/docs/esign-rest-api/reference/connect/connectconfigurations/update/