Submits a batch of historical envelopes for republish to a webhook
This endpoint submits a batch of existing envelopes to a webhook of your choice. Set the webhook address with the urlToPublishTo request body parameter.
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.
Authorization
OAuth2 OAuth 2.0 access token obtained via Authorization Code Grant or JWT Grant.
In: header
Path Parameters
The external account number (int) or account ID GUID.
Request Body
application/json
The request body for the createHistoricalEnvelopePublishTransaction endpoint.
The connectCustomConfiguration object describes a Connect configuration for your account.
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 Body
application/json
application/json
curl -X POST "https://example.com/v2.1/accounts/string/connect/envelopes/publish/historical" \ -H "Content-Type: application/json" \ -d '{}'{ "applyConnectSettings": "string", "envelopeCount": "string", "envelopeLevelErrorRollups": [ { "count": "string", "errorType": "string" } ], "envelopePublishTransactionId": "string", "errorCount": "string", "fileLevelErrors": [ "string" ], "noActionRequiredEnvelopeCount": "string", "processedEnvelopeCount": "string", "processingStatus": "string", "resultsUri": "string", "submissionDate": "string", "submittedByUserInfo": { "accountId": "string", "accountName": "string", "activationAccessCode": "string", "email": "string", "errorDetails": { "errorCode": "string", "message": "string" }, "ipAddress": "string", "loginStatus": "string", "membershipId": "string", "sendActivationEmail": "string", "uri": "string", "userId": "string", "userName": "string", "userStatus": "string", "userType": "string" }, "submittedForPublishingEnvelopeCount": "string"}Sets a signature image, initials, or stamp PUT
Sets a signature image, initials, or stamp.
Returns sender fields for an envelope GET
Given an `envelopeId`, this method returns the sender fields found in that envelope's documents. After you retrieve the sender fields, use the [DocumentGeneration::updateEnvelopeDocGenFormFields](https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/documentgeneration/updateenvelopedocgenformfields/) method to populate the fields. If the specified envelope does not contain a document with sender fields, the method will return success (`200`) and an empty object (`{}`) in the response. ### Next steps - [Learn about document generation in the eSignature concepts guide.](https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/documents/document-generation/) - [Learn how to send an envelope with document generation in your preferred coding language](https://developers.docusign.com/docs/esign-rest-api/how-to/request-signature-email-document-generation/).