ConnectEvents: retryForEnvelopes

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.

Request

HTTP request

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

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

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

Responses

CodeDescriptionReference
200

Successful response.

connectFailureResults
400

Error encountered.

errorDetails

SDK Method

Connect::retryEventForEnvelopes

Definitions

connectFailureFilter

envelopeIds[array]

synchronousstring

connectFailureResult

configIdstring

Reserved for DocuSign.

configUrlstring

Reserved for DocuSign.

envelopeIdstring

The envelope ID of the envelope status that failed to post.

statusstring

Connection status.

statusMessagestring

Connection status message.

connectFailureResults
errorDetails

This object describes errors that occur. It is only valid for responses, and ignored in requests.

errorCodestring

A code associated with the error condition.

messagestring

A brief message describing the error condition.

Examples

Generic JSON Request/Response

Request
{
  "synchronous": "sample string 1",
  "envelopeIds": [
    "sample string 1"
  ]
}
Response
{
  "retryQueue": [
    {
      "envelopeId": "sample string 1",
      "configId": "sample string 2",
      "configUrl": "sample string 3",
      "status": "sample string 4",
      "statusMessage": "sample string 5"
    }
  ]
}
Generic XML Request/Response

Request
<connectFailureFilter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
  <envelopeIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
  </envelopeIds>
  <synchronous>sample string 1</synchronous>
</connectFailureFilter> 
Response
<connectFailureResults xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
  <retryQueue>
    <connectFailureResult>
      <configId>sample string 2</configId>
      <configUrl>sample string 3</configUrl>
      <envelopeId>sample string 1</envelopeId>
      <status>sample string 4</status>
      <statusMessage>sample string 5</statusMessage>
    </connectFailureResult>
  </retryQueue>
</connectFailureResults> 
}} />