ConnectEvents: retryForEnvelope

Republishes Connect information for the specified envelope.

Request

HTTP request

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

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

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

envelopeIdstring

The envelope's GUID.

Example: 93be49ab-afa0-4adf-933c-f752070d71ec

Responses

CodeDescriptionReference
200

Successful response.

connectFailureResults
400

Error encountered.

errorDetails

SDK Method

Connect::retryEventForEnvelope

Definitions

connectFailureResult

This object contains details about a Connect failure result.

configIdstring

Reserved for DocuSign.

configUrlstring

Reserved for DocuSign.

envelopeIdstring

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

statusstring

The connection status.

statusMessagestring

A human-readable message describing the connection status.

connectFailureResults

retryQueue[connectFailureResult]

Details about a Connect failure result.

errorDetails

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

errorCodestring

The code associated with the error condition.

messagestring

A brief message describing the error condition.

Examples

Generic JSON Response

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

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> 
}} />