Connect Events

Republishes Connect information for multiple envelopes

PUT
/v2.1/accounts/{accountId}/connect/envelopes/retry_queue

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.

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.

Request Body

application/json

A list of failed envelope IDs to retry.

envelopeIds?array<string>

An array of envelope GUIDs.

Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec

synchronous?string

Must be false. Setting this property to any other value will result in errors.

Response Body

application/json

application/json

curl -X PUT "https://example.com/v2.1/accounts/string/connect/envelopes/retry_queue" \  -H "Content-Type: application/json" \  -d '{}'
{  "retryQueue": [    {      "configId": "string",      "configUrl": "string",      "envelopeId": "string",      "status": "string",      "statusMessage": "string"    }  ]}