ConnectEvents: retryForEnvelope

Republishes Connect information for the specified envelope.

Request

HTTP request

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

Parameters

Parameter name Value Description
Path parameters
accountId string

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

envelopeId string

The envelope's GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec

Responses

Code Description Reference
200 OK Successful response.
400 Bad Request Error encountered.

SDK Method

Connect::retryEventForEnvelope

Definitions Expand All | Collapse All

connectFailureResult

configId string

Reserved: TBD

configUrl string

Reserved: TBD

envelopeId string

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

status string

Indicates the envelope status. Valid values are:

  • sent - The envelope is sent to the recipients.
  • created - The envelope is saved as a draft and can be modified and sent later.
statusMessage string

connectFailureResults

retryQueue
[connectFailureResult]

errorDetails

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

errorCode string

An error code associated with the error.

message string

A short error message.

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>