{"api":"esign_rest","category":"reference"}

ConnectConfigurations Resource

The ConnectConfigurations resource methods enable you to configure the DocuSign Connect service associated with an account.

MethodDescription
list
GET /v2/accounts/{accountId}/connect

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

Note: Connect must be enabled for your account to use this function. This does not retrieve information for Connect configurations for Box, eOriginal, or Salesforce.

update
PUT /v2/accounts/{accountId}/connect

Updates the specified DocuSign Connect configuration in your account.

Note: Connect must be enabled for your account to use this function. This cannot be used to update Connect configurations for Box, eOriginal, or Salesforce.

create
POST /v2/accounts/{accountId}/connect

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].

Note: Connect must be enabled for your account to use this function. This cannot be used to set up Connect configurations for Salesforce or eOriginal.

get
GET /v2/accounts/{accountId}/connect/{connectId}

Retrieves the information for the specified DocuSign Connect configuration.

Note: Connect must be enabled for your account to use this function.

delete
DELETE /v2/accounts/{accountId}/connect/{connectId}

Deletes the specified DocuSign Connect configuration.

Note: Connect must be enabled for your account to use this function.

listUsers
GET /v2/accounts/{accountId}/connect/{connectId}/users

Returns users from the configured Connect service.