Docusign

The DocuSign API provides programmatic access to DocuSign’s electronic signature and document workflow platform. It allows applications to create, send, and manage digital documents that require signatures, approvals, or other recipient actions. Through the API, developers can upload documents, define signature fields, set routing orders, add recipients, and track envelope status as documents move through a workflow. The system supports various document formats, multi-step approval processes, and notifications when recipients complete or decline actions.

The API uses REST endpoints and JSON payloads, with OAuth 2.0 managing authentication and access tokens. It also includes features for template management, embedded signing within web or mobile applications, retrieving completed documents, and accessing audit trails for compliance. Advanced operations include bulk sending, conditional routing, and integration with identity verification services. The DocuSign API is widely used in systems that need automated document workflows—such as contract management, HR onboarding, financial services, and internal approval processes.

Documentation URL: https://developers.docusign.com/docs/esign-rest-api/reference/

Installable Elements              (No items selected)



Base Elements

These elements are required for the templates below to work

  • Remote Site Setting enabling access to the Docusign Demo API base URL

  • Remote Site Setting enabling access to the Docusign Live API base URL

  • Authentication Provider used to authenticate into Docusign Demo API.

  • Authentication Provider used to authenticate into Docusign Live API.

  • Docusign Named Credentials for use with a demo Docusign instance

  • Docusign Named Credentials for use with a live Docusign instance

Diagnostics

Templates related to Diagnostics

  • Retrieves the available REST API versions.

  • Retrieves a list of log entries as a JSON or xml object or as a zip file containing the entries.

  • Deletes the request log files.

  • Retrieves information for a single log entry.

  • Retrieves the current API request logging setting for the user and remaining log entries.

  • Enables or disables API request logging for troubleshooting.

Accounts

Templates related to Accounts

  • Creates new DocuSign service accounts. This is used to create multiple DocuSign accounts with one call.

  • Retrieves the account information for the specified account.

  • This closes the specified account. You must be an account admin to close your account. Once closed, an account must be reopened by DocuSign.

  • Retrieves the list of recurring and usage charges for the account. This can be used to determine the charge structure and usage of charge plan items.

  • Retrieves the list of brand profiles associated with the account and the default brand profiles.

  • Creates one or more brand profile files for the account.

  • Deletes one or more brand profiles from an account.

  • This method returns details about an account brand.

  • This method updates an account brand.

  • This method deletes a brand from an account.

  • This method exports information about a brand to an XML file.

  • This method returns a specific logo that is used in a brand.

  • This method updates a single brand logo.

  • This method deletes a single logo from an account brand.

  • This method returns metadata about the branding resources that are associated with an account.

  • This method returns a specific branding resource file.

  • This method updates a branding resource file.

  • Deletes the signature for one or more captive recipient records; it is primarily used for testing. This provides a way to reset the signature associated with a client user ID so that a new signature can be created the next time the client user ID is used.

  • Retrieves the Electronic Record and Signature Disclosure, with HTML formatting, associated with the account. You can use an optional query string to set the language for the disclosure.

  • Retrieves the Electronic Record and Signature Disclosure, with HTML formatting, for the requested envelope recipient. This might be different than the current account disclosure depending on account settings, such as branding, and when the account disclosure was last updated. An optional query string can be included to return the language for the disclosure.

  • Account administrators can use this method to customize values in the default disclosure, switch to a custom disclosure that uses your own text and HTML formatting, change values in your existing consumer disclosure.

  • Retrieves a list of envelope custom fields associated with the account. You can use these fields in the envelopes for your account to record information about the envelope, help search for envelopes and track information. The envelope custom fields are shown in the Envelope Settings section when a user is creating an envelope in the DocuSign member console. The envelope custom fields are not seen by the envelope recipients.

  • This method creates a custom field and makes it available for all new envelopes associated with an account.

  • This method updates an existing account custom field.

  • This method deletes an existing account custom field.

  • This method returns a list of Identity Verification workflows that are available to an account.

  • Retrieves a list of Permission Profiles. Permission Profiles are a standard set of user permissions that you can apply to individual users or users in a Group. This makes it easier to manage user permissions for a large number of users, without having to change permissions on a user-by-user basis.

  • This method creates a new permission profile for an account.

  • This method returns information about a specific permission profile that is associated with an account.

  • This method updates an account permission profile.

  • This method deletes a permission profile from an account.

  • Retrieves a list of recipients in the specified account that are associated with a email address supplied in the query string.

  • Retrieves the account settings information for the specified account.

  • Updates the account settings for the specified account.

  • An envelope purge configuration enables account administrators to permanently remove documents and their field data from completed and voided envelopes after a specified retention period (`retentionDays`). This method retrieves the current envelope purge configuration for your account.

  • An envelope purge configuration enables account administrators to permanently remove documents and their field data from completed and voided envelopes after a specified retention period (`retentionDays`). This method sets the envelope purge configuration for your account.

  • This method returns the default settings for the email notifications that signers and senders receive about envelopes.

  • This method changes the default settings for the email notifications that signers and senders receive about envelopes.

  • This method retrieves the password rules for an account.

  • This method updates the password rules for an account.

  • This method returns information about the tab types and tab functionality that is currently enabled for an account.

  • This method modifies the tab types and tab functionality that is enabled for an account.

  • Returns a list of signature providers that the specified account can use.

  • Retrieves a list of supported languages that you can set for an individual recipient when creating an envelope, as well as their simple type enumeration values. These are the languages that you can set for the standard email format and signing view for each recipient.

  • Retrieves a list of file types (mime-types and file-extensions) that are not supported for upload through the DocuSign system.

  • Retrieves the account provisioning information for the account.

Billing

Templates related to Billing

  • Retrieves a list of invoices for the account. If the from date or to date queries are not specified, the response returns invoices for the last 365 days.

  • Retrieves the specified invoice.

  • Returns a list past due invoices for the account and notes if payment can be made through the REST API.

  • Retrieves a list containing information about one or more payments. If the from date or to date queries are not used, the response returns payment information for the last 365 days.

  • Posts a payment to a past due invoice.

  • Retrieves the information for a specified payment.

  • Retrieves the billing plan information for the specified account, including the current billing plan, successor plans, billing address, and billing credit card.

  • Updates the billing plan information, billing address, and credit card information for the specified account.

  • This method returns information about a credit card associated with an account.

  • Retrieves a list of the billing plans associated with a distributor.

  • Retrieves the billing plan details for the specified billing plan ID.

BulkEnvelopes

Templates related to BulkEnvelopes

  • Returns a summary of bulk send batches.

  • Gets the general status of a specific bulk send batch such as: number of successes, number pending, number of errors

  • Updates a specific bulk send batch status.

  • This method returns a list of envelopes in a specified bulk batch. Use the query parameters to filter and sort the envelopes by different attributes.

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

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

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

  • This method replaces the definition of an existing bulk send list.

  • This method deletes a bulk send list.

  • This method initiates the bulk send process. It generates a bulk send request based on an [existing bulk send list][create_list] and an envelope or template.

  • This method tests a bulk send list for compatibility with the envelope or template that you want to send. For example, a template that has three roles is not compatible with a bulk send list that has only two recipients. For this reason, you might want to test compatibility first.

Envelopes

Templates related to Envelopes

  • This method initiates a new chunked upload with the first part of the content.

  • Returns the details (but not the content) about a chunked upload.

  • This method checks the integrity of a chunked upload and then commits it. When this request is successful, the chunked upload is then ready to be referenced in other API calls.

  • Deletes a chunked upload that has been committed but not yet consumed.

  • Adds a chunk or part to an existing chunked upload. After you use the Create method to initiate a new chunked upload and upload the first part.

  • Retrieves envelope status changes for all envelopes. You can modify the information returned by adding query strings to limit the request to check between certain dates and times, or for certain envelopes, or for certain status codes. It is recommended that you use one or more of the query strings in order to limit the size of the response.

  • Creates an envelope.

  • Retrieves the overall status for the specified envelope.

  • The Put Envelopes endpoint provides the following functionality: sends the specified single draft envelope, voids the specified in-process envelope, replaces the current email subject and message for a draft envelope, place the envelope documents and envelope metadata in a purge queue so that this information is removed from the DocuSign system

  • Returns a list of attachments associated with a specified envelope

  • Adds one or more attachments to a draft or in-process envelope.

  • Deletes one or more attachments from a draft envelope.

  • Retrieves an attachment from an envelope.

  • Adds an attachment to a draft or in-process envelope.

  • Gets the envelope audit events for the specified envelope.

  • Retrieves a PDF file containing all of the comments that senders and recipients have added to the documents in an envelope.

  • Retrieves the custom field information for the specified envelope. You can use these fields in the envelopes for your account to record information about the envelope, help search for envelopes, and track information. The envelope custom fields are shown in the Envelope Settings section when a user is creating an envelope in the DocuSign member console. The envelope custom fields are not seen by the envelope recipients.

  • Updates the envelope custom fields in draft and in-process envelopes.

  • Updates the envelope custom fields for draft and in-process envelopes.

  • Deletes envelope custom fields for draft and in-process envelopes.

  • Retrieves a list of documents associated with the specified envelope.

  • Adds one or more documents to an existing envelope document.

  • Deletes one or more documents from an existing draft envelope.

  • Retrieves the specified document from the envelope. If the account has the Highlight Data Changes feature enabled, there is an option to request that any changes in the envelope be highlighted.

  • Adds a document to an existing draft envelope.

  • Retrieves the custom document field information from an existing envelope document.

  • Updates existing custom document fields in an existing envelope document.

  • Creates custom document fields in an existing envelope document.

  • Deletes custom document fields from an existing envelope document.

  • Returns images of the pages in a document for display based on the parameters that you specify.

  • Deletes a page from a document in an envelope based on the page number.

  • Retrieves a page image for display from the specified envelope.

  • Rotates page image from an envelope for display. The page image can be rotated to the left or right.

  • Returns the tabs from the page specified by `pageNumber` of the document specified by `documentId` in the envelope specified by `envelopeId`.

  • Creates a preview of the [responsive](/docs/esign-rest-api/esign101/concepts/responsive/) HTML version of a specific document. This method enables you to preview a PDF document conversion to responsive HTML across device types prior to sending.

  • Returns the tabs on the document specified by `documentId` in the envelope specified by `envelopeId`.

  • Updates tabs in the document specified by `documentId` in the envelope specified by `envelopeId`.

  • Adds tabs to the document specified by `documentId` in the envelope specified by `envelopeId`.

  • Deletes tabs from the document specified by `documentId` in the envelope specified by `envelopeId`.

  • Retrieves the templates associated with a document in the specified envelope.

  • Adds templates to a document in the specified envelope.

  • Deletes the specified template from a document in an existing envelope.

  • Retrieves the email override settings for the specified envelope.

  • Updates the existing email override settings for the specified envelope. Note that modifying email settings will only affect email communications that occur after the modification was made.

  • Adds email override settings, changing the email address to reply to an email address, name, or the BCC for email archive information, for the envelope. Note that adding email settings will only affect email communications that occur after the addition was made.

  • Deletes all existing email override settings for the envelope. If you want to delete an individual email override setting, use the PUT and set the value to an empty string. Note that deleting email settings will only affect email communications that occur after the deletion and the normal account email settings are used for future email communications.

  • This method downloads the envelope and tab data (also called form data) from any in-process, completed, or canceled envelope that you sent or that is shared with you. Recipients who are also full administrators on an account can view form data for any envelopes that another user on the account has sent to them.

  • Retrieves general information about the envelope lock.

  • Updates the lock duration time or update the `lockedByApp` property information for the specified envelope. The user and integrator key must match the user specified by the `lockByUser` property and integrator key information and the `X-DocuSign-Edit` header must be included or an error will be generated.

  • Locks the specified envelope, and sets the time until the lock expires, to prevent other users or recipients from accessing and changing the envelope.

  • Deletes the lock from the specified envelope. The `X-DocuSign-Edit` header must be included in the request.

  • Retrieves the envelope notification, reminders and expirations, information for an existing envelope.

  • This method sets the notifications (reminders and expirations) for an existing envelope. The request body sends a structure containing reminders and expirations settings. It also specifies whether to use the settings specified in the request, or the account default notification settings for the envelope.

  • Retrieves the status of all recipients in a single envelope and identifies the current recipient in the routing list.

  • Updates recipients in a draft envelope or corrects recipient information for an in process envelope.

  • Adds one or more recipients to an envelope.

  • Deletes one or more recipients from a draft or sent envelope. Recipients to be deleted are listed in the request, with the `recipientId` being used as the key for deleting recipients.

  • Deletes the specified recipient file from the specified envelope. This cannot be used if the envelope has been sent.

  • Retrieves the Electronic Record and Signature Disclosure, with html formatting, associated with the account. You can use an optional query string to set the language for the disclosure.

  • This method returns information about document visibility for a recipient.

  • This method updates document visibility for a recipient.

  • Creates a resource token for a sender. This token allows a sender to return identification data for a recipient using the [ID Evidence API](/docs/idevidence-api/).

  • Retrieves the initials image for the specified user. The image is returned in the same format as it was uploaded. In the request you can specify if the chrome (the added line and identifier around the initial image) is returned with the image.

  • Updates the initials image for a signer that does not have a DocuSign account. The supported image formats for this file are: gif, png, jpeg, and bmp. The file size must be less than 200K.

  • Retrieves signature information for a signer or sign-in-person recipient.

  • Retrieves the specified user signature image. The image is returned in the same format as uploaded. In the request you can specify if the chrome (the added line and identifier around the initial image) is returned with the image.

  • Updates the signature image for an accountless signer. The supported image formats for this file are: gif, png, jpeg, and bmp. The file size must be less than 200K.

  • Retrieves information about the tabs associated with a recipient in a draft envelope.

  • Updates one or more tabs for a recipient in a draft envelope.

  • Adds one or more tabs for a recipient.

  • Deletes one or more tabs associated with a recipient in a draft envelope.

  • This method updates document visibility for one or more recipients based on the `recipientId` and `visible` values that you include in the request body.

  • Creates a preview of the [responsive](/docs/esign-rest-api/esign101/concepts/responsive/), HTML versions of all of the documents in an envelope. This method enables you to preview the PDF document conversions to responsive HTML across device types prior to sending.

  • This returns a list of the server-side templates, their name and ID, used in an envelope.

  • Adds templates to the specified envelope.

  • Returns a URL that allows you to embed the envelope correction view of the DocuSign UI in your applications.

  • Revokes the correction view URL to the Envelope UI.

  • Returns a URL that allows you to embed the edit view of the DocuSign UI in your applications. This is a one-time use login token that allows the user to be placed into the DocuSign editing view.

  • Returns a URL that allows you to embed the recipient view of the DocuSign UI in your applications. This call cannot be used to view draft envelopes, since those envelopes have not been sent.

  • This method returns a URL for an envelope recipient preview in the DocuSign UI that you can embed in your application. You use this method to enable the sender to preview the recipients' experience.

  • Returns a URL that allows you to embed the sender view of the DocuSign UI in your applications. This is a one-time use login token that allows the user to be placed into the DocuSign sending view.

  • Returns a URL that enables you to embed the DocuSign UI recipient view of a [shared envelope](https://support.docusign.com/en/guides/ndse-admin-guide-share-envelopes) in your applications. This is the view that a user sees of an envelope that a recipient on the same account has shared with them.

  • Returns an envelope's workflow definition if the envelope specified by `envelopeId` has one.

  • Updates the specified envelope's workflow definition if it has one.

  • Deletes the specified envelope's workflow definition if it has one.

  • Retrieves the envelope status for the specified envelopes.

  • This method retrieves a list of envelope transfer rules associated with an account.

  • This method changes the status for one or more envelope transfer rules based on the `envelopeTransferRuleId`s in the request body. You use this method to change whether or not the rules are enabled.

  • This method creates an envelope transfer rule.

  • This method changes the status of an envelope transfer rule. You use this method to change whether or not the rule is enabled.

  • This method deletes an envelope transfer rule.

  • Returns template's workflow definition if the template specified by `templateId` has one.

  • Updates the specified template's workflow definition if it has one.

  • Deletes the specified template's workflow definition if it has one.

  • Returns a URL that allows you to embed the authentication view of the DocuSign UI in your applications.

Connect

Templates related to Connect

  • Retrieves all the DocuSign Custom Connect definitions for the specified account.

  • Updates the specified DocuSign Connect configuration in your account.

  • Creates a DocuSign Custom Connect definition for your account. DocuSign Connect enables the sending of real-time data updates to external applications. These updates are generated by user transactions as the envelope progresses through actions to completion. The Connect Service provides updated information about the status of these transactions and returns updates that include the actual content of document form fields. Be aware that, these updates might or might not include the document itself. For more information about Connect, see the [ML:DocuSign Connect Service Guide].

  • Retrieves the information for the specified DocuSign Connect configuration.

  • Deletes the specified DocuSign Connect configuration.

  • Returns users from the configured Connect service.

  • Republishes Connect information for the specified envelope.

  • Republishes Connect information for the specified set of envelopes. The primary use is to republish Connect post failures by including envelope IDs for the envelopes that failed to post in the request. The list of envelope IDs that failed to post correctly can be retrieved by calling to [ML:GetConnectLog] retrieve the failure log.

  • Retrieves the Connect Failure Log information. It can be used to determine which envelopes failed to post, so a republish request can be created.

  • Deletes the Connect failure log information for the specified entry.

  • Retrieves a list of connect log entries for your account.

  • Retrieves a list of connect log entries for your account.

  • Retrieves the specified Connect log entry for your account.

  • Deletes a specified entry from the Connect Log.

Users

Templates related to Users

  • This method updates one or more contacts associated with an account.

  • This method adds multiple contacts into a contacts list.

  • This method deletes multiple contacts associated with an account.

  • This method returns one or more contacts associated with a DocuSign account. You can also retrieve contacts from connected [cloud storage][CloudStorage] providers by using the `cloud_provider` query parameter. By default, contacts are retrieved from the DocuSign account's default address book.

  • This method deletes a contact associated with an account.

  • This method returns a URL for starting an edit view of a template that uses the DocuSign Template UI.

  • Retrieves the list of users for the specified account

  • This method updates the information about one or more account users.

  • Adds new users to your account. Set the `userSettings` property in the request to specify the actions the users can perform on the account.

  • This closes one or more user records in the account. Users are never deleted from an account, but closing a user prevents them from using account functions.

  • Retrieves the user information for the specified user.

  • To update user information for a specific user, submit a [Users](#Users) object with updated field values in the request body of this operation.

  • Retrieves a list of custom user settings for a single user.

  • Adds or updates custom user settings for the specified user.

  • Deletes the specified custom user settings for a single user.

  • Retrieves the user profile information, the privacy settings and personal information (address, phone number, etc.) for the specified user.

  • Updates the user's detail information, profile information, privacy settings, and personal information in the user ID card.

  • Retrieves the user profile picture for the specified user. The image is returned in the same format as uploaded.

  • Updates the user profile image by uploading an image to the user profile.

  • Deletes the user profile image from the specified user's profile.

  • Retrieves a list of the account settings and email notification information for the specified user.

  • Updates the account settings list and email notification types for the specified user.

  • Retrieves the signature definitions for the specified user.

  • Adds a user signature image and/or user initials image to the specified user.

  • Retrieves the structure of a single signature with a known signature name.

  • Creates, or updates, the signature font and initials for the specified user. When creating a signature, you use this resource to create the signature name and then add the signature and initials images into the signature.

  • Removes the signature information for the user.

  • Retrieves the specified initials image or signature image for the specified user. The image is returned in the same format as uploaded. In the request you can specify if the chrome (the added line and identifier around the initial image) is returned with the image.

  • Updates the user signature image or user initials image for the specified user. The supported image formats for this file are: gif, png, jpeg, and bmp. The file must be less than 200K.

  • Deletes the specified initials image or signature image for the specified user.

Folders

Templates related to Folders

  • Retrieves a list of the folders for the account, including the folder hierarchy. You can specify whether to return just the template folder or template folder and normal folders by setting the `template` query string parameter.

  • Retrieves a list of the envelopes in the specified folder. You can narrow the query by specifying search criteria in the query string parameters.

  • Moves envelopes to the specified folder.

  • Retrieves a list of envelopes that match the criteria specified in the query.

UserGroups

Templates related to UserGroups

  • Retrieves information about groups associated with the account.

  • Updates the group name and modifies, or sets, the permission profile for the group.

  • Creates one or more groups for the account.

  • Deletes an existing user group.

  • Retrieves information about the brands associated with the requested group.

  • Adds group brand ID information to a group.

  • Deletes brand information from the requested group.

  • Retrieves a list of users in a group.

  • Adds one or more users to an existing group.

  • Deletes one or more users from a group.

Payments

Templates related to Payments

  • This method returns a list of payment gateway accounts and basic information about them.

PowerForms

Templates related to PowerForms

  • This method returns a list of PowerForms that are available to the user.

  • This method creates a new PowerForm.

  • This method deletes one or more PowerForms. The request body takes an array of PowerForm objects that are deleted based on the `powerFormId`.

  • This method returns detailed information about a specific PowerForm.

  • This method updates an existing PowerForm.

  • This method deletes a PowerForm.

  • This method enables Powerform Administrators or the sender of a PowerForm to download the data that recipients have entered into a PowerForm.

  • This method returns a list of users who have sent PowerForms.

EmailArchive

Templates related to EmailArchive

  • This method retrieves all of the BCC email archive configurations associated with an account.

  • This method creates a BCC email archive configuration for an account (adds a BCC email address to the account for archiving the emails that DocuSign generates).

  • This method returns a specific BCC email archive configuration for an account, as well as the history of changes to the email address.

  • This method deletes a BCC email archive configuration from an account.

SigningGroups

Templates related to SigningGroups

  • Retrieves a list of all signing groups in the specified account.

  • Updates the name of one or more existing signing groups.

  • Creates one or more signing groups.

  • Deletes one or more signing groups in the specified account.

  • Retrieves information, including group member information, for the specified signing group.

  • Updates signing group name and member information. You can also add new members to the signing group. A signing group can have a maximum of 50 members.

  • Retrieves the list of members in the specified Signing Group.

  • Adds one or more new members to a signing group. A signing group can have a maximum of 50 members.

  • Deletes one or more members from the specified signing group.

CustomTabs

Templates related to CustomTabs

  • Retrieves a list of all tabs associated with the account.

  • Creates a tab with pre-defined properties, such as a text tab with a certain font type and validation pattern. Users can access the custom tabs when sending documents through the DocuSign web application.

  • Retrieves information about the requested custom tab on the specified account.

  • Updates the information in a custom tab for the specified account.

  • Deletes the custom from the specified account.

Templates

Templates related to Templates

  • Retrieves the list of templates for the specified account. The request can be limited to a specific folder.

  • Creates a template definition using a multipart request.

  • Retrieves the definition of the specified template.

  • Updates an existing template.

  • Shares a template with the specified members group.

  • Removes a member group's sharing permissions for a specified template.

  • Retrieves the custom document field information from an existing template.

  • Updates the custom fields in a template.

  • Creates custom document fields in an existing template document.

  • Deletes envelope custom fields in a template.

  • Retrieves a list of documents associated with the specified template.

  • Adds one or more documents to an existing template document.

  • Deletes one or more documents from an existing template.

  • Retrieves one or more PDF documents from the specified template.

  • Adds the specified document to an existing template document.

  • Retrieves the custom document fields for an existing template document.

  • Updates existing custom document fields in an existing template document.

  • Creates custom document fields in an existing template document.

  • Deletes custom document fields from an existing template document.

  • Deletes a page from a document in a template based on the page number.

  • Retrieves a page image for display from the specified template.

  • Rotates page image from a template for display. The page image can be rotated to the left or right.

  • Returns the tabs from the page specified by `pageNumber` of the document specified by `documentId` in the template specified by `templateId`.

  • Creates a preview of the [responsive](/docs/esign-rest-api/esign101/concepts/responsive/), HTML version of a specific template document. This method enables you to preview a PDF document conversion to responsive HTML across device types prior to sending.

  • Returns the tabs on the document specified by `documentId` in the template specified by `templateId`.

  • Updates tabs in the document specified by `documentId` in the template specified by `templateId`.

  • Adds tabs to the document specified by `documentId` in the template specified by `templateId`.

  • Deletes tabs from the document specified by `documentId` in the template specified by `templateId`.

  • Retrieves general information about the template lock.

  • Updates the lock duration time or update the `lockedByApp` property information for the specified template. The user and integrator key must match the user specified by the `lockByUser` property and integrator key information and the `X-DocuSign-Edit` header must be included or an error will be generated.

  • Locks the specified template, and sets the time until the lock expires, to prevent other users or recipients from accessing and changing the template.

  • Deletes the lock from the specified template. The `X-DocuSign-Edit` header must be included in the request.

  • Retrieves the envelope notification, reminders and expirations, information for an existing template.

  • Updates the notification structure for an existing template. Use this endpoint to set reminder and expiration notifications.

  • Retrieves the information for all recipients in the specified template.

  • Updates recipients in a template.

  • Adds one or more recipients to a template.

  • Deletes one or more recipients from a template. Recipients to be deleted are listed in the request, with the `recipientId` being used as the key for deleting recipients.

  • Deletes the specified recipient file from the specified template.

  • This method returns information about document visibility for a template recipient.

  • This method updates the document visibility for a template recipient.

  • Gets the tabs information for a signer or sign-in-person recipient in a template.

  • Updates one or more tabs for a recipient in a template.

  • Adds one or more tabs for a recipient.

  • Deletes one or more tabs associated with a recipient in a template.

  • This method updates document visibility for one or more template recipients based on the `recipientId` and `visible` values that you include in the request body.

  • Creates a preview of the [responsive](/docs/esign-rest-api/esign101/concepts/responsive/), HTML versions of all of the documents associated with a template. This method enables you to preview the PDF document conversions to responsive HTML across device types prior to sending.

  • This method returns a URL for a template recipient preview in the DocuSign UI that you can embed in your application. You use this method to enable the sender to preview the recipients' experience.

CloudStorage

Templates related to CloudStorage

  • Retrieves the list of cloud storage providers enabled for the account and the configuration information for the user.

  • Configures the redirect URL information for one or more cloud storage providers for the specified user. The redirect URL is added to the authentication URL to complete the return route.

  • Deletes the user authentication information for one or more cloud storage providers. The next time the user tries to access the cloud storage provider, they must pass normal authentication.

  • Retrieves the list of cloud storage providers enabled for the account and the configuration information for the user.

  • Deletes the user authentication information for the specified cloud storage provider. The next time the user tries to access the cloud storage provider, they must pass normal authentication for this cloud storage provider.

  • Retrieves a list of all the items in a specified folder from the specified cloud storage provider.

  • Retrieves a list of all the items in all the folders associated with the user from the specified cloud storage provider. You can limit the scope of the returned items by providing a comma separated list of folder IDs in the request.

Workspaces

Templates related to Workspaces

  • Gets information about the Workspaces that have been created.

  • Creates a new workspace.

  • Retrives properties about a workspace given a unique workspaceId.

  • Updates information about a specific workspace.

  • Deletes an existing workspace (logically).

  • Retrieves workspace folder contents, which can include sub folders and files.

  • This method deletes one or more files or sub-folders from a workspace folder or root.

  • This method adds a file to a workspace.

  • Retrieves a workspace file (the binary).

  • Updates workspace item metadata for one or more specific files/folders.

  • Retrieves a workspace file as rasterized pages.

Notary

Templates related to Notary

  • Gets settings for a notary user. The current user must be a notary.

  • Updates notary information for the current user.

  • Registers the current user as a notary.

  • Returns a list of jurisdictions that the notary is registered in. The current user must be a notary.

  • Creates a jurisdiction object.

  • Gets a jurisdiction object for the current user.

  • Updates the jurisdiction information about a notary.

  • Deletes the specified jurisdiction.

In order to install this in your org, you need to access the library from the Declarative Webhooks app in your Salesforce org, Declarative Webhooks Library tab.