v1

latestSwagger 2.02026-07-134146194.6 MB

ConnectConfigurations

Updates a specified Connect configuration.

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.

<ds-inlinemessage> To use this method, you must be an account administrator and Connect must be enabled on your account. </ds-inlinemessage>

put/v2.1/accounts/{accountId}/connect

Path parameters

accountIdstring required

The external account number (int) or account ID GUID.

Request body

allowEnvelopePublishstring

Set this value to true to enable the webhook. The default property is false.

allowSalesforcePublishstring

When true, Docusign sends data to the designated Salesforce account through Connect. The default value is true.

This property is not used for the createHistoricalEnvelopePublishTransaction endpoint.

allUsersstring

When true, the tracked envelope and recipient events for all users, including users that are added a later time, are sent through Connect. The default value is false.

Note: If this property is false, make sure you set the userIds property to a non-empty array of user IDs.

This property is not used for the createHistoricalEnvelopePublishTransaction endpoint.

allUsersExceptstring

This flag enables you to toggle between including and excluding specified users from the configuration. When false, the users corresponding to the IDs in userIds will be included in the configuration. Conversely, when true, the users will be excluded from the configuration. The default value is false.

This property is not used for the createHistoricalEnvelopePublishTransaction endpoint.

configurationTypestring

The type of the configuration. Valid values:

custom: Creates an account-level configuration
customrecipient: Creates a Recipient Connect configuration
salesforce
eOriginal

This property is required.

connectIdstring

The Docusign-generated ID for the Connect configuration.

This property is read-only.

deliveryModestring

The delivery mode of the configuration. Valid values:

SIM
Aggregate

This property is required.

disabledBystring

enableLogstring

When true, Connect logging is turned on. Docusign recommends that you enable this functionality to help troubleshoot any issues.

You can have a maximum of 100 active logs in your account. You can view the entries in active logs in the Logs tab in the Connect console.

This property is required.

enableOAuthPerConfigurationstring

envelopeEventsstring[]

A list of envelope-level event statuses that will trigger Connect to send updates to the endpoint specified in the url property.

When using any of the legacy event message formats, you must include either the envelopeEvents property or the recipientEvents property. If you are instead using the JSON SIM event model, use the events property.

The possible event statuses are:

Sent
Delivered
Completed
Declined
Voided

Note: These values are case-sensitive.

This property is not used for the createHistoricalEnvelopePublishTransaction endpoint.

eventsstring[]

A comma-separated list of envelope-level event statuses that will trigger Connect to send updates to the endpoint specified in the urlToPublishTo property.

Set this property when you are using the JSON SIM event model. If you are instead using any of the legacy event message formats, set either the envelopeEvents property or the recipientEvents property.

The possible event statuses are:

envelope-created
envelope-sent
envelope-resent
envelope-delivered
envelope-completed
envelope-declined
envelope-voided
recipient-authenticationfailed
recipient-autoresponded
recipient-declined
recipient-delivered
recipient-completed
recipient-sent
recipient-resent
template-created
template-modified
template-deleted
envelope-corrected
envelope-purge
envelope-deleted
envelope-discard
recipient-reassign
recipient-delegate
recipient-finish-later
click-agreed
click-declined

This property is not used for the createHistoricalEnvelopePublishTransaction endpoint.

externalFolderIdstring

The ID of an external folder.

This property is not used for the createHistoricalEnvelopePublishTransaction endpoint.

externalFolderLabelstring

The label for an external folder.

This property is not used for the createHistoricalEnvelopePublishTransaction endpoint.

groupIdsstring[]

includeCertificateOfCompletionstring

When true, the Connect Service includes the Certificate of Completion with completed envelopes.

This property is not used for the createHistoricalEnvelopePublishTransaction endpoint.

includeCertSoapHeaderstring

includeDocumentFieldsstring

When true, the document fields associated with the envelope's documents are included in the notification messages. Document fields are optional custom name-value pairs added to documents using the API.

This property is not used for the createHistoricalEnvelopePublishTransaction endpoint.

includeDocumentsstring

Reserved for Docusign.

includeEnvelopeVoidReasonstring

When true, if the envelope is voided, the Connect Service notification will include the void reason, as entered by the person that voided the envelope.

This property is not used for the createHistoricalEnvelopePublishTransaction endpoint.

includeHMACstring

When true, Connect will use HMAC to verify the request.

This property is required.

includeOAuthstring

includeSenderAccountasCustomFieldstring

When true, Connect will include the sender account as custom field in the data.

This property is not used for the createHistoricalEnvelopePublishTransaction endpoint.

includeTimeZoneInformationstring

When true, Connect will include the envelope time zone information.

This property is not used for the createHistoricalEnvelopePublishTransaction endpoint.

integratorManagedstring

namestring

The name of the Connect configuration.

This property is required.

passwordstring

The password for the Connect configuration.

This property is not used for the createHistoricalEnvelopePublishTransaction endpoint.

pausePublishstring

recipientEventsstring[]

An array of recipient event statuses that will trigger Connect to send notifications to your webhook listener at the URL endpoint specified in the url property.

The possible event statuses are:

Sent
AutoResponded
Delivered
Completed
Declined
AuthenticationFailed

Note: These values are case-sensitive.

This property is not used for the createHistoricalEnvelopePublishTransaction endpoint.

requireMutualTlsstring

When true, Mutual TLS authentication is enabled.

This property is not used for the createHistoricalEnvelopePublishTransaction endpoint.

requiresAcknowledgementstring

When true, event delivery acknowledgements are enabled for your Connect configuration.

Docusign Connect awaits a valid 200 response from your application acknowledging that it received a message. If you do not acknowledge receiving an event notification message within 100 seconds, Docusign treats the message as a failure and places it into a failure queue. It is imperative that you acknowledge successful receipt of Connect events as they occur by sending a 200 event back.

When true and Send Individual Messages (SIM) mode is activated

If the HTTP status response to a notification message is not in the range of 200-299, then the message delivery failed, and the configuration is marked as down.

The message will be queued and retried once per day. While a Connect configuration is marked down, subsequent notifications will not be tried. Instead, they will be immediately queued with the reason Pending. When a message succeeds, all queued messages for the configuration will be tried immediately, in order.

There is a maximum of ten retries. Alternately, you can use Republish Connect Information to manually republish the notification.

When true and SIM mode is not activated

If the HTTP Status response to a notification message is not in the range of 200-299, then the message delivery failed, and the message is queued.

The message will be retried after at least a day the next time a subsequent message is successfully sent to this configuration (subscription). Subsequent notifications will be tried when they occur. There is a maximum of ten retries. Alternately, you can use Republish Connect Information to manually republish the notification.

When false

When requiresAcknowledgement is set to false and you do not acknowledge receiving an event notification message within 100 seconds, Docusign treats the message as a failure and determines that the server is unavailable. It does not retry to send the notification message, and you must handle the failure manually.

This property is required.

salesforceApiVersionstring

The version of the Salesforce API that you are using.

This property is not used for the createHistoricalEnvelopePublishTransaction endpoint.

salesforceAuthcodestring

salesforceCallBackUrlstring

salesforceDocumentsAsContentFilesstring

When true, Docusign can use documents in your Salesforce account for sending and signing.

This property is not used for the createHistoricalEnvelopePublishTransaction endpoint.

senderOverridestring

senderSelectableItemsstring[]

This property sets the items that are available for selection when adding or editing Connect objects.

This property is not used for the createHistoricalEnvelopePublishTransaction endpoint.

signMessageWithX509Certificatestring

When true, Mutual TLS will be enabled for notifications. Mutual TLS must be initiated by the listener (the customer's web server) during the TLS handshake protocol.

This property is required.

soapNamespacestring

The namespace of the SOAP interface.

Note: If useSoapInterface is set to true, you must set this value.

This property is not used for the createHistoricalEnvelopePublishTransaction endpoint.

urlToPublishTostring

The web address of the listener or retrieving service endpoint. It must be an HTTPS URL.

This property is required.

userIdsstring[]

A comma-separated list of user IDs. This sets the users associated with the tracked envelope and recipient events. When a tracked event occurs for a set user, the a notification message is sent to your Connect listener.

By default, the users will be included in the configuration. If you want to exclude the users, set the allUsersExcept property to true.

Note: If allUsers is set to false, then you must provide a list of user IDs.

This property is not used for the createHistoricalEnvelopePublishTransaction endpoint.

userNamestring

The name of the user.

This property is not used for the createHistoricalEnvelopePublishTransaction endpoint.

useSoapInterfacestring

When true, the notifications are sent to your endpoint as SOAP requests.

This property is not used for the createHistoricalEnvelopePublishTransaction endpoint.

Response

Successful response.