Docusign eSignature API
Docusign Developer CenterGet a developer account
HomeAPI ReferenceSDKsContext Plugin
Connect Events

Gets the Connect failure log information

GET
/v2.1/accounts/{accountId}/connect/failures

Retrieves the Connect failure log information.

Use this method to determine which envelopes failed to post. You can then use ConnectEvents: retryForEnvelopes to create a republish request.

Authorization

OAuth2
AuthorizationBearer <token>

OAuth 2.0 access token obtained via Authorization Code Grant or JWT Grant.

In: header

Path Parameters

accountId*string

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

Query Parameters

from_date?string

The start date for a date range in UTC DateTime format.

Note: If this property is null, no date filtering is applied.

to_date?string

The end of a search date range in UTC DateTime format. When you use this parameter, only templates created up to this date and time are returned.

Note: If this property is null, the value defaults to the current date.

Response Body

application/json

application/json

curl -X GET "https://example.com/v2.1/accounts/string/connect/failures"
{  "failures": [    {      "accountId": "string",      "configUrl": "string",      "connectDebugLog": [        {          "connectConfig": "string",          "errorDetails": {            "errorCode": "string",            "message": "string"          },          "eventDateTime": "string",          "eventDescription": "string",          "payload": "string"        }      ],      "connectId": "string",      "created": "string",      "email": "string",      "envelopeId": "string",      "error": "string",      "failureId": "string",      "failureUri": "string",      "lastTry": "string",      "logId": "string",      "logUri": "string",      "retryCount": "string",      "retryUri": "string",      "status": "string",      "subject": "string",      "userName": "string"    }  ],  "logs": [    {      "accountId": "string",      "configUrl": "string",      "connectDebugLog": [        {          "connectConfig": "string",          "errorDetails": {            "errorCode": "string",            "message": "string"          },          "eventDateTime": "string",          "eventDescription": "string",          "payload": "string"        }      ],      "connectId": "string",      "created": "string",      "email": "string",      "envelopeId": "string",      "error": "string",      "failureId": "string",      "failureUri": "string",      "lastTry": "string",      "logId": "string",      "logUri": "string",      "retryCount": "string",      "retryUri": "string",      "status": "string",      "subject": "string",      "userName": "string"    }  ],  "totalRecords": "string",  "type": "string"}

Republishes Connect information for multiple envelopes PUT

Republishes Connect information for the specified set of envelopes. <ds-inlinemessage> To use this method, you must be an account administrator and Connect must be enabled on your account. </ds-inlinemessage> 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](https://developers.docusign.com/docs/esign-rest-api/reference/connect/connectevents/list/) retrieve the failure log.

Deletes a Connect failure log entry DELETE

Deletes a Connect failure log entry. To delete all the Connect failure log entries, specify `all` for the `failureId` path parameter. <ds-inlinemessage> To use this method, you must be an account administrator and Connect must be enabled on your account. </ds-inlinemessage>