DocuSign: Send, void, or modify a draft envelope Purge documents from a completed envelope
DocuSign esignature.esignatureEnvelopesPutEnvelope: arguments, response, policy and SDK examples.
← Esignature operations · Get started
Operation docusign.esignature_envelopes_putenvelope
Provider route: PUT /restapi/v2.1/accounts/{accountId}/envelopes/{envelopeId}. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/docusign with npm, or alter-sdk-docusign with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { DocuSignIntegration } from "@alter-ai/docusign";
async function execute(input: Parameters<DocuSignIntegration["esignature"]["esignatureEnvelopesPutEnvelope"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new DocuSignIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.esignature.esignatureEnvelopesPutEnvelope(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_docusign import DocuSignIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = DocuSignIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.esignature.esignature_envelopes_put_envelope(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.accountId | string | Required within parent | |
path.envelopeId | string | Required within parent | |
query | object | Optional | Additional keys: not allowed |
query.advanced_update | string | Optional | |
query.recycle_on_void | string | Optional | |
query.resend_envelope | string | Optional | |
body | Model | Optional | Expand Send, void, or modify a draft envelope Purge documents from a completed envelope — request body — body |
Referenced models: Send, void, or modify a draft envelope Purge documents from a completed envelope — request body — body
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Updates an existing template — response body |
Referenced models: Updates an existing template — response body
Schemas
Section titled “Schemas”149 more schemas are linked from the tables above, on the schema pages.
Updates an existing template — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
bulkEnvelopeStatus | Model | Optional | Expand Creates an envelope — response body — bulk Envelope Status An object that describes the status of the bulk send envelopes. |
envelopeId | string | Optional | The envelope ID of the envelope status that failed to post. |
errorDetails | Model | Optional | Expand Locks a template — response body — error Details This object describes errors that occur. It is only valid for responses and ignored in requests. |
listCustomFieldUpdateResults | array | Optional | |
listCustomFieldUpdateResults[] | Model | Each item | Expand Gets a list of custom fields — response body — list Custom Fields item |
lockInformation | Model | Optional | Expand Locks an envelope — response body Provides lock information about an envelope that a user has locked. |
purgeState | string | Optional | Shows the current purge state for the envelope. Valid values: - `unpurged`: There has been no successful request to purge documents. - `documents_queued`: The envelope documents have been added to the purge queue, but have not been purged. - `documents_dequeued`: The envelope documents have been taken out of the purge queue. - `documents_purged`: The envelope documents have been successfully purged. - `documents_and_metadata_queued`: The envelope documents and metadata have been added to the purge queue, but have not yet been purged. - `documents_and_metadata_purged`: The envelope documents and metadata have been successfully purged. - `documents_and_metadata_and_redact_queued`: The envelope documents and metadata have been added to the purge queue, but have not yet been purged, nor has personal information been redacted. - `documents_and_metadata_and_redact_purged`: The envelope documents and metadata have been successfully purged, and personal information has been redacted. **Related topics** - [Purging documents (eSingature Concepts)](/docs/esign-rest-api/esign101/concepts/documents/purging/) - [Purging documents in an envelope (blog post)](https://www.docusign.com/blog/developers/purging-documents-envelope) |
recipientUpdateResults | array | Optional | An array of `recipientUpdateResults` objects that contain details about the recipients. |
recipientUpdateResults[] | Model | Each item | Expand Updates an existing template — response body — recipient Update Results item |
tabUpdateResults | Model | Optional | Expand Adds tabs for a recipient — esignature esignature Recipients Post Recipient Tabs — response body |
textCustomFieldUpdateResults | array | Optional | |
textCustomFieldUpdateResults[] | Model | Each item | Expand Gets a list of custom fields — response body — text Custom Fields item |
Referenced models: Locks an envelope — response body, Adds tabs for a recipient — esignature esignature Recipients Post Recipient Tabs — response body, Creates an envelope — response body — bulk Envelope Status, Locks a template — response body — error Details, Gets a list of custom fields — response body — list Custom Fields item, Updates an existing template — response body — recipient Update Results item, Gets a list of custom fields — response body — text Custom Fields item
Locks an envelope — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Envelope locks let you lock an envelope to prevent any changes while you are updating an envelope. |
errorDetails | Model | Optional | Expand Locks a template — response body — error Details This object describes errors that occur. It is only valid for responses and ignored in requests. |
lockDurationInSeconds | string | Optional | The number of seconds until the lock expires when there is no activity on the envelope. The default value is 300 seconds. The maximum value is 1,800 seconds. The lock duration can be extended. |
lockToken | string | Optional | A unique identifier provided to the owner of the lock. You must use this token with subsequent calls to prove ownership of the lock. |
lockType | string | Optional | The type of lock. Currently `edit` is the only supported type. |
lockedByApp | string | Optional | The human-readable name of the application that is locking the envelope or template. This value displays to the user in error messages when lock conflicts occur. |
lockedByUser | Model | Optional | Expand Gets a specific template associated with a specified account — response body — owner A complex type containing information about the user that has the envelope or template locked. |
lockedUntilDateTime | string | Optional | The date and time that the lock expires. |
useScratchPad | string | Optional | When **true,** a scratchpad is used to edit information. |
Referenced models: Locks a template — response body — error Details, Gets a specific template associated with a specified account — response body — owner
Creates an envelope — response body — bulk Envelope Status
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
batchId | string | Optional | Specifies an identifier which can be used to retrieve a more detailed status of individual bulk recipient batches. |
batchSize | string | Optional | The number of items returned in this response. |
bulkEnvelopes | array | Optional | A list of bulk envelope objects. |
bulkEnvelopes[] | Model | Each item | Expand Creates an envelope — response body — bulk Envelope Status bulk Envelopes item |
bulkEnvelopesBatchUri | string | Optional | URI at which you can retrieve the batch envelopes. |
endPosition | string | Optional | The last index position in the result set. |
failed | string | Optional | The number of entries with a status of failed. |
nextUri | string | Optional | The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. |
previousUri | string | Optional | The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. |
queued | string | Optional | The number of entries with a status of queued. |
resultSetSize | string | Optional | The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`. |
sent | string | Optional | The number of entries with a status of sent. |
startPosition | string | Optional | The starting index position of the current result set. |
submittedDate | string | Optional | The date on which the bulk envelope was created. |
totalSetSize | string | Optional | The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`. |
Referenced models: Creates an envelope — response body — bulk Envelope Status bulk Envelopes item
Locks a template — response body — error Details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object describes errors that occur. It is only valid for responses and ignored in requests. |
errorCode | string | Optional | The code associated with the error condition. |
message | string | Optional | A brief message describing the error condition. |
Gets a list of custom fields — response body — list Custom Fields item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object represents a list custom field from which envelope creators and senders can select custom data. |
configurationType | string | Optional | If you are using merge fields, this property specifies the type of the merge field. The only supported value is `salesforce`. |
errorDetails | Model | Optional | Expand Locks a template — response body — error Details This object describes errors that occur. It is only valid for responses and ignored in requests. |
fieldId | string | Optional | The ID of the custom field. |
listItems | array | Optional | An array of strings that represents the options in a list. Maximum length: 2048 characters, but each individual option string can only be a maximum of 100 characters. |
listItems[] | string | Each item | |
name | string | Optional | The name of the custom field. |
required | string | Optional | When **true,** senders are required to select an option from the list before they can send the envelope. |
show | string | Optional | When **true,** the field displays in the **Envelope Custom Fields** section when a user creates or sends an envelope. |
value | string | Optional | The value of the custom field. This is the value that the user who creates or sends the envelope selects from the list. |
Referenced models: Locks a template — response body — error Details
Gets the status of a single envelope — response body — envelope Custom Metadata
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
envelopeCustomMetadataDetails | array | Optional | |
envelopeCustomMetadataDetails[] | Model | Each item | Expand Updates an existing brand — response body — colors item |
Referenced models: Updates an existing brand — response body — colors item
Returns tabs on a template — response body — ssn Tabs item connected Object Details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
recordId | string | Optional |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: docusign.esignature_envelopes_putenvelope. Catalog operation: esignature:Envelopes_PutEnvelope. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.