Republish historical envelopes

POST

/v2.1/accounts/:accountId/connect/envelopes/publish/historical

POST

/restapi/v2.1/accounts/:accountId/connect/envelopes/publish/historical

curl -X POST https://demo.docusign.net/restapi/v2.1/accounts/ACCOUNT_ID/connect/envelopes/publish/historical \
     -H "Authorization: Bearer <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "config": {
    "allowEnvelopePublish": "sample string 1",
    "allowSalesforcePublish": "sample string 2",
    "allUsers": "sample string 3",
    "allUsersExcept": "sample string 4",
    "configurationType": "sample string 5",
    "connectId": "sample string 6",
    "deliveryMode": "sample string 7",
    "disabledBy": "sample string 8",
    "enableLog": "sample string 9",
    "enableOAuthPerConfiguration": "sample string 10",
    "envelopeEvents": [
      "sample string 1"
    ],
    "eventData": {
      "format": "sample string 1",
      "includeData": [
        "sample string 1"
      ],
      "version": "sample string 2"
    },
    "events": [
      "sample string 1"
    ],
    "externalFolderId": "sample string 11",
    "externalFolderLabel": "sample string 12",
    "groupIds": [
      "sample string 1"
    ],
    "includeCertificateOfCompletion": "sample string 13",
    "includeCertSoapHeader": "sample string 14",
    "includeDocumentFields": "sample string 15",
    "includeDocuments": "sample string 16",
    "includeEnvelopeVoidReason": "sample string 17",
    "includeHMAC": "sample string 18",
    "includeOAuth": "sample string 19",
    "includeSenderAccountasCustomField": "sample string 20",
    "includeTimeZoneInformation": "sample string 21",
    "integratorManaged": "sample string 22",
    "name": "sample string 23",
    "oAuthConfiguration": {
      "authorizationServerUrl": "sample string 1",
      "clientId": "sample string 2",
      "clientSecret": "sample string 3",
      "customParameters": {
        "key": "sample string 1"
      },
      "scope": "sample string 4"
    },
    "password": "sample string 24",
    "pausePublish": "sample string 25",
    "recipientEvents": [
      "sample string 1"
    ],
    "requireMutualTls": "sample string 26",
    "requiresAcknowledgement": "sample string 27",
    "salesforceApiVersion": "sample string 28",
    "salesforceAuthcode": "sample string 29",
    "salesforceCallBackUrl": "sample string 30",
    "salesforceCodeVerifier": "sample string 31",
    "salesforceDocumentsAsContentFiles": "sample string 32",
    "senderOverride": "sample string 33",
    "senderSelectableItems": [
      "sample string 1"
    ],
    "sfObjects": [
      {
        "active": "sample string 1",
        "description": "sample string 2",
        "id": "sample string 3",
        "insert": "sample string 4",
        "onCompleteOnly": "sample string 5",
        "selectFields": [
          {
            "dsAttribute": "sample string 1",
            "dsLink": "sample string 2",
            "dsNode": "sample string 3",
            "id": "sample string 4",
            "sfField": "sample string 5",
            "sfFieldName": "sample string 6",
            "sfFolder": "sample string 7",
            "sfLockedValue": "sample string 8"
          }
        ],
        "sfObject": "sample string 6",
        "sfObjectName": "sample string 7",
        "updateFields": [
          {}
        ]
      }
    ],
    "signMessageWithX509Certificate": "sample string 34",
    "soapNamespace": "sample string 35",
    "urlToPublishTo": "sample string 36",
    "userIds": [
      "sample string 1"
    ],
    "userName": "sample string 37",
    "useSoapInterface": "sample string 38"
  },
  "envelopes": [
    "sample string 1"
  ]
}'

{
  "applyConnectSettings": "sample string 1",
  "envelopeCount": "sample string 2",
  "envelopeLevelErrorRollups": [
    {
      "count": "sample string 1",
      "errorType": "sample string 2"
    }
  ],
  "envelopePublishTransactionId": "sample string 3",
  "errorCount": "sample string 4",
  "fileLevelErrors": [
    "sample string 1"
  ],
  "noActionRequiredEnvelopeCount": "sample string 5",
  "processedEnvelopeCount": "sample string 6",
  "processingStatus": "sample string 7",
  "resultsUri": "sample string 8",
  "submissionDate": "sample string 9",
  "submittedByUserInfo": {
    "accountId": "sample string 1",
    "accountName": "sample string 2",
    "activationAccessCode": "sample string 3",
    "email": "sample string 4",
    "errorDetails": {
      "errorCode": "sample string 1",
      "message": "sample string 2"
    },
    "ipAddress": "sample string 5",
    "loginStatus": "sample string 6",
    "membershipId": "sample string 7",
    "sendActivationEmail": "sample string 8",
    "uri": "sample string 9",
    "userId": "sample string 10",
    "userName": "sample string 11",
    "userStatus": "sample string 12",
    "userType": "sample string 13"
  },
  "submittedForPublishingEnvelopeCount": "sample string 10"
}

This endpoint submits a batch of existing envelopes to a webhook of your choice. Set the webhook address with the urlToPublishTo request body parameter.

You can publish up to a maximum of 9999 envelopes per hour.

This endpoint does not call an existing Connect configuration or create a new Connect listener to monitor new activity. It simply uses an ad hoc configuration to submit existing envelopes. You must include all the configuration data in the request body.

The envelope data will always be transmitted in JSON format. XML, Salesforce, and eOriginal configuration types are not supported.

Your request should match the following format:

{
    "envelopes": ["4280f274-xxxx-xxxx-xxxx-b218b7eeda08", "8373a938-xxxx-xxxx-xxxx-e992a2abae01"],
    "config": {
        "configurationType":"custom",
        "name": "Test",
        "urlToPublishTo":"YOUR-WEBHOOK-URL",
        "allowEnvelopePublish": "true",
        "enableLog": "true",
        "requiresAcknowledgement": "true",
        "IncludeHMAC": "true",
        "SignMessageWithX509Cert": "true",
        "deliveryMode": "SIM",
        "eventData": {
            "version": "restv2.1",
            "format": "json",
            "includedata": ["tabs","payment_tabs","custom_fields","powerform","recipients","folders","extensions","attachments", "prefill_tabs", "documents"]
        }
    }
}

If the request succeeds, it returns a 201 (Created) HTTP response code and the response body property processingStatus will be set to processing. You can then view the status of each historical republish request in the Bulk Actions Log.

Authentication

AuthorizationBearer

OAuth 2.0 access token (JWT or auth-code grant). Sent as Authorization: Bearer <token> on every request except GET /v2.1 and GET /service_information, which are public discovery endpoints.

Path parameters

accountIdstringRequired

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

Request

This endpoint expects an object: connectHistoricalEnvelopeRepublish

configobjectOptional

The connectCustomConfiguration object describes a Connect configuration for your account.

envelopeslist of stringsOptional

An array of envelope IDs as comma-separated strings. This property is required.

For example: ["4280f274-xxxx-xxxx-xxxx-b218b7eeda08","9586h293-xxxx-xxxx-xxxx-m923b8opre71","2347w948-xxxx-xxxx-xxxx-t096b8krno89"]

Response

Successful response.

applyConnectSettingsstringOptional

envelopeCountstringOptional

envelopeLevelErrorRollupslist of objectsOptional

envelopePublishTransactionIdstringOptional

The ID of the publish transaction.

errorCountstringOptional

fileLevelErrorslist of stringsOptional

noActionRequiredEnvelopeCountstringOptional

processedEnvelopeCountstringOptional

processingStatusstringOptional

The status of the transaction. Valid values:

unprocessed
processing
complete
fatal_error

resultsUristringOptional

submissionDatestringOptional

submittedByUserInfoobjectOptional

submittedForPublishingEnvelopeCountstringOptional

Errors

400

Bad Request Error