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.

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 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 the list of cloud storage providers enabled for the account and the configuration information for the user.

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

The response body of this method is the PDF file as a byte
stream.

Note: Comments are disabled by default. To use the comments feature, an account administrator must enable comments on the account (in the accountSettingsInformation object, set the enableSigningExtensionComments property to true).

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

Note: To use this function, you must be an account administrator and Connect must be enabled on your account.

Creates a custom Connect configuration for the specified account.

Connect is a webhook service that provides updates when certain events occur in your eSignature workflows. You can use this endpoint to create:

• Account-level Connect configurations to listen for events related to any envelopes sent by one or more account users
• Recipient Connect configurations that are triggered when one or more of your account users receive an envelope

To set an account-level configuration, set configurationType to custom.
To set a Recipient Connect configuration, set configurationType to customrecipient.

If you want to listen for events on only one envelope, use the eventNotification object instead.

Note: To use this function, you must be an account administrator and Connect must be enabled on your account.

Data models

There are four possible data models for your Connect configuration. Consider:

• Do you want the data in JSON or XML?
• Do you want events sent individually (SIM) or in aggregate?

DocuSign recommends using the JSON SIM event model.

JSON SIM (Recommended)

JSON Aggregate

XML Aggregate

XML SIM (Legacy apps only)

Troubleshooting

If your configuration is not working, check the following.

• Connect must be enabled for your account to use this function.
• If you are using envelopeEvents or recipientEvents, make sure that the event values are sentence case, not lowercase.
• Make sure you have either set allUsers to true or set userIds to a non-empty array of IDs.
• By default, this endpoint creates a disabled configuration. To enable the configuration immediately, set the body parameter allowEnvelopePublish to true. You can also enable the configuration in the UI.
• To check if events are being emitted, set enableLog to true to view event logs in the Connect console.

Related topics

• For more information about Connect, see the DocuSign Connect guide.
• Use the MyAPICalls sample app to see an example of this endpoint using the JSON SIM model.

Updates the specified DocuSign Connect configuration in your account. To enable the configuration, set the allowEnvelopePublish property to true.

After any updates, test your configuration to make sure it works as expected.

Note: To use this function, you must be an account administrator and Connect must be enabled on your account.

Deletes the Connect OAuth configuration for the specified account.

Note: To use this function, you must be an account administrator and Connect must be enabled on your account.

Related topics:

• OAuth for DocuSign Connect

Gets the Connect OAuth configuration for the specified account.

Note: To use this function, you must be an account administrator and Connect must be enabled on your account.

Related topics:

• OAuth for DocuSign Connect

Sets up Connect OAuth for the specified account using an authorization server of your choice. To use this endpoint, get the client ID and client secret from your authorization server.

When you call this endpoint, DocuSign requests an access token from your authorization server. DocuSign will use that token in the Authorization HTTP header of your account’s Connect messages. Finally, your listener will be responsible for validating the token by calling the authorization server.

Note: To use this function, you must be an account administrator and Connect must be enabled on your account.

Related topics:

• OAuth for DocuSign Connect

Deletes the specified DocuSign Connect configuration.

Note: To use this function, you must be an account administrator and Connect must be enabled on your account.

Retrieves the information for the specified DocuSign Connect configuration.

Note: To use this function, you must be an account administrator and Connect must be enabled on your account.

Returns all users from the configured Connect service.

Note: To use this function, you must be an account administrator and Connect must be enabled on your account.

Returns users from the configured Connect service.

Note: To use this function, you must be an account administrator and Connect must be enabled on your account.

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 Connect::listEventLogs retrieve the failure log.

Note: To use this function, you must be an account administrator and Connect must be enabled on your account.

Republishes Connect information for the specified envelope.

Note: To use this function, you must be an account administrator and Connect must be enabled on your account.

Retrieves the Connect failure log information. You can use this log to determine which envelopes failed to post, in order to create a republish request.

Note: To use this function, you must be an account administrator and Connect must be enabled on your account.

Deletes the Connect failure log information for the specified entry.

Note: To use this function, you must be an account administrator and Connect must be enabled on your account.

Deletes a list of Connect log entries for your account.

Note: To use this function, you must be an account administrator and Connect must be enabled on your account.

Retrieves a list of the 100 most recent Connect log entries for your account.

The enableLog setting in the Connect configuration must be set to true to enable logging. Log entries are deleted after 15 days.

Note: To use this function, you must be an account administrator and Connect must be enabled on your account.

Deletes a specified entry from the Connect Log.

Note: To use this function, you must be an account administrator and Connect must be enabled on your account.

Retrieves the specified Connect log entry for your account.

The enableLog setting in the Connect configuration must be set to true to enable logging.
If logging is not enabled, then no log entries are recorded.

Note: To use this function, you must be an account administrator and Connect must be enabled on your account.

This method deletes multiple contacts associated with an account.

This method adds multiple contacts into a contacts list.

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

This method deletes a contact 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 providers by using the
cloud_provider query parameter. By default,
contacts are retrieved from the DocuSign account’s
default address book.

To return a specific contact, use the contactId
query parameter. To return all contacts associated
with an account, omit this parameter.

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.

Custom tabs can be created for approve, checkbox, company, date, date signed, decline, email, email address, envelope ID, first name, formula, full name, initial here, last name, list, note, number, radio, sign here, signer attachment, SSN, text, title, and zip tabs.

Deletes the custom from the specified account.

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

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

Given an envelopeId this method
returns the form fields found in
that envelope’s documents.

The response for envelope that has one document
with form fields would look like this:

{
  "docGenFormFields": [
    {
      "documentId": "2dc54cf5-xxxx-xxxx-xxxx-05132a2dd889",
      "docGenFormFieldList": [
        {
          "label": "Candidate_Name",
          "type": "TextBox",
          "required": "True",
          "name": "Candidate_Name"
        },
        {
          "label": "Job_Title",
          "type": "TextBox",
          "required": "True",
          "name": "Job_Title"
        },
        {
          "label": "Manager_Name",
          "type": "TextBox",
          "required": "True",
          "name": "Manager_Name"
        },
        {
          "label": "Start_Date",
          "type": "TextBox",
          "required": "True",
          "name": "Start_Date"
        },
        {
          "label": "Salary",
          "type": "TextBox",
          "required": "True",
          "name": "Salary"
        }
      ],
      "docGenDocumentStatus": "created"
    }
  ]
}

Related topics

• Document generation in the eSignature concepts guide
• How to request a signature by email with document generation
• Document Generation for DocuSign eSignature in the eSignature User Guide

This method updates the form fields
for all the documents in a given
envelope.

The envelope must be in the draft state.

The request body for an envelope that has one document
with form fields would look like this:

{
  "docGenFormFields": [
    {
      "documentId": "2dc54cf5-xxxx-xxxx-xxxx-05132a2dd889",
      "docGenFormFieldList": [
        {
          "name": "Candidate_Name",
          "value": "Peggy Olson"
        },
        {
          "name": "Job_Title",
          "value": "Copywriter"
        },
        {
          "name": "Manager_Name",
          "value": "Donald Draper"
        },
        {
          "name": "Start_Date",
          "value": "March 15, 1960"
        },
        {
          "name": "Salary",
          "value": "8000"
        }
      ]
    }
  ]
}

Related topics

• Document generation in the eSignature concepts guide
• How to request a signature by email with document generation
• Document Generation for DocuSign eSignature in the eSignature User Guide

Creates a preview of the
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.

The request body is a documentHtmlDefinition object, which holds the responsive signing parameters that define how to generate the HTML version of the signing document.

Deletes one or more envelope attachments from a draft envelope.

Returns a list of envelope attachments associated with a specified envelope.

Adds one or more envelope attachments to a draft or in-process envelope.
Each envelope can have a maximum of 12 attachments.

Envelope attachments are files that an application can include in an envelope. They are not converted to PDF. Envelope attachments are available only through the API. There is no user interface in the DocuSign web application for them.

For a list of supported file formats, see Supported File Formats.

Retrieves an envelope attachment from an envelope.

Updates an envelope attachment to a draft or in-process envelope.

Retrieves the default, HTML-formatted Electronic Record and Signature Disclosure (ERSD) for the envelope that you specify.

This is the default ERSD disclosure that DocuSign provides for the convenience of U.S.-based customers only. This default disclosure is only valid for transactions between U.S.-based parties.

To set the language of the disclosure that you want to retrieve, use the optional langCode query parameter.

Retrieves the HTML-formatted Electronic Record and Signature Disclosure (ERSD) for the envelope recipient that you specify. This disclosure might differ from the account-level disclosure, based on the signing brand applied to the envelope and the recipient’s language settings.

To set the language of the disclosure that you want to retrieve, specify the langCode as either a path or query parameter.

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

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.

There are two types of envelope custom fields, text, and list. A text custom field lets the sender enter the value for the field. With a list custom field, the sender selects the value of the field from a pre-made list.

Related topics

• How to get envelope custom tab values