Skip to navigation

PublishConnectFailures

View as Markdown

PublishConnectFailures

PublishConnectFailures requests a list of Connect post failures for the set of envelopes included in the request.

Schema

NameSchema TypeDescription
AccountIdStringThe account ID associated with the requested Connect post failures.
SynchronousBooleanIf true, the system attempts to publish failed posts again and returns the status of the post attempt.
EnvelopeIdsArray of EnvelopeIdsThe array of EnvelopeiDs for the envelopes included in the request.

Sample Request XML

SOAPAction: "http://www.docusign.net/API/3.0/PublishConnectFailures"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap: Body>
<PublishConnectFailures xmlns="http://www.docusign.net/API/3.0">
<PublishConnectFailuresFilter>
<AccountId>string</AccountId>
<Synchronous>boolean</Synchronous>
<EnvelopeIds>
<EnvelopeId>string</EnvelopeId>
<EnvelopeId>string</EnvelopeId>
</EnvelopeIds>
</PublishConnectFailuresFilter>
</PublishConnectFailures>
</soap:Body>
</soap:Envelope>

This method returns PublishConnectFailuresResponse with an array of PublishConnectFailuresResult with the results shown below.

NameSchema TypeDescription
EnvelopeIdEnvelopeIdThe envelope ID associated with the Connect post.
ConfigIdStringThe identifier for the Connect configuration that failed. If an account has multiple Connect configurations, this value is used to to look up the Connect configuration for the failed post.
ConfigUrlStringthe web address of the listener of Retrieving Service end point for Connect.
StatusConnectPublishStatusThe status of the Connect post. The possible values are: Queued, Success, or Fail.
StatusMessageStringIf the ConnectPublishStatus is Queued or Success, the StatusMessage is empty. If the ConnectPublishStatus is Fail and the envelope is not part of the account, the StatusMessage is “Envelope Not In Account.”