Skip to content

DocuSign: Creates an envelope

DocuSign esignature.esignatureEnvelopesPostEnvelopes: arguments, response, policy and SDK examples.

← Esignature operations · Get started

Operation docusign.esignature_envelopes_postenvelopes

Provider route: POST /restapi/v2.1/accounts/{accountId}/envelopes. Alter supplies the connection’s credentials and routing.

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"]["esignatureEnvelopesPostEnvelopes"]>[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.esignatureEnvelopesPostEnvelopes(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from 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_post_envelopes(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.accountIdstringRequired within parent
queryobjectOptionalAdditional keys: not allowed
query.cdse_modestringOptional
query.change_routing_orderstringOptional
query.completed_documents_onlystringOptional
query.merge_roles_on_draftstringOptional
bodyModelOptionalExpand Creates an envelope — request body — body

Referenced models: Creates an envelope — request body — body

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Creates an envelope — response body

Referenced models: Creates an envelope — response body

159 more schemas are linked from the tables above, on the schema pages.

Creates an envelope — response body
FieldTypePresenceDescription and constraints
$objectRootThis object describes an envelope.
bulkEnvelopeStatusModelOptionalExpand Creates an envelope — response body — bulk Envelope Status
An object that describes the status of the bulk send envelopes.
envelopeIdstringOptionalThe envelope ID of the envelope status that failed to post.
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
recipientSigningUristringOptional
recipientSigningUriErrorstringOptional
statusstringOptionalIndicates the envelope status. Valid values are:

* `completed`: The recipients have finished working with the envelope: the documents are signed and all required tabs are filled in.
* `created`: The envelope is created as a draft. It can be modified and sent later.
* `declined`: The envelope has been declined by the recipients.
* `delivered`: The envelope has been delivered to the recipients.
* `sent`: The envelope will be sent to the recipients after the envelope is created.
* `signed`: The envelope has been signed by the recipients.
* `voided`: The envelope is no longer valid and recipients cannot access or sign the envelope.
statusDateTimestringOptionalThe DateTime that the envelope changed status (i.e. was created or sent.)
uristringOptionalA URI containing the user ID.

Referenced models: Creates an envelope — response body — bulk Envelope Status, Locks a template — response body — error Details

Creates an envelope — response body — bulk Envelope Status
FieldTypePresenceDescription and constraints
$objectRoot
batchIdstringOptionalSpecifies an identifier which can be used to retrieve a more detailed status of individual bulk recipient batches.
batchSizestringOptionalThe number of items returned in this response.
bulkEnvelopesarrayOptionalA list of bulk envelope objects.
bulkEnvelopes[]ModelEach itemExpand Creates an envelope — response body — bulk Envelope Status bulk Envelopes item
bulkEnvelopesBatchUristringOptionalURI at which you can retrieve the batch envelopes.
endPositionstringOptionalThe last index position in the result set.
failedstringOptionalThe number of entries with a status of failed.
nextUristringOptionalThe 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.
previousUristringOptionalThe 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.
queuedstringOptionalThe number of entries with a status of queued.
resultSetSizestringOptionalThe 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`.
sentstringOptionalThe number of entries with a status of sent.
startPositionstringOptionalThe starting index position of the current result set.
submittedDatestringOptionalThe date on which the bulk envelope was created.
totalSetSizestringOptionalThe 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
FieldTypePresenceDescription and constraints
$objectRootThis object describes errors that occur. It is only valid for responses and ignored in requests.
errorCodestringOptionalThe code associated with the error condition.
messagestringOptionalA brief message describing the error condition.
Gets a list of custom fields — response body
FieldTypePresenceDescription and constraints
$objectRootAn `accountCustomField` is an envelope custom field that you set at the account level.
Applying custom fields enables account administrators to group and manage envelopes.
listCustomFieldsarrayOptionalAn array of list custom fields.
listCustomFields[]ModelEach itemExpand Gets a list of custom fields — response body — list Custom Fields item
textCustomFieldsarrayOptionalAn array of text custom fields.
textCustomFields[]ModelEach itemExpand Gets a list of custom fields — response body — text Custom Fields item

Referenced models: Gets a list of custom fields — response body — list Custom Fields item, Gets a list of custom fields — response body — text Custom Fields item

Locks an envelope — response body
FieldTypePresenceDescription and constraints
$objectRootEnvelope locks let you lock an envelope to prevent any changes while you are updating an envelope.
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
lockDurationInSecondsstringOptional
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.
lockTokenstringOptionalA unique identifier provided to the owner of the lock. You must use this token with subsequent calls to prove ownership of the lock.
lockTypestringOptionalThe type of lock. Currently `edit` is the only supported type.
lockedByAppstringOptionalThe 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.
lockedByUserModelOptionalExpand 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.
lockedUntilDateTimestringOptionalThe date and time that the lock expires.
useScratchPadstringOptionalWhen **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

Updates an envelope attachment in a draft or in-process envelope — request body — body
FieldTypePresenceDescription and constraints
$objectRootContains information about an attachment.
accessControlstringOptionalValid values are `sender` and `senderAndAllRecipients`.
attachmentIdstringOptionalThe unique identifier for the attachment.
attachmentTypestringOptionalSpecifies the type of the attachment for the recipient.
datastringOptionalA Base64-encoded representation of the attachment that is used to upload and download the file. File attachments may be up to 50 MB in size.
labelstringOptionalA label for the attachment. Potential values include:

- `guidedForm`: [Guided forms](https://www.docusign.com/products/guided-forms) provide a step-by-step, mobile-ready experience to help signers easily complete long or complex forms.
- `eventNotifications`: A list of envelope-level event statuses that trigger Connect to send updates to the endpoint specified in the `url` property.
namestringOptionalThe name of the attachment.
remoteUrlstringOptionalThe URL of a previously staged chunked upload. Using a chunked upload enables you to stage a large, chunkable temp file. You then use the `remoteUrl` property to reference the chunked upload as the content in attachment and document-related requests. The `remoteUrl` property cannot be used for downloads.
Gets the status of a single envelope — response body — envelope Custom Metadata
FieldTypePresenceDescription and constraints
$objectRoot
envelopeCustomMetadataDetailsarrayOptional
envelopeCustomMetadataDetails[]ModelEach itemExpand Updates an existing brand — response body — colors item

Referenced models: Updates an existing brand — response body — colors item

Gets the status of a single envelope — response body — envelope Metadata
FieldTypePresenceDescription and constraints
$objectRoot
allowAdvancedCorrectstringOptionalSpecifies if the Advanced Correct feature is enabled for the envelope. This feature enables you to correct the details of in process envelopes that you sent or are shared with you. It offers more functionality than the Correct feature.
allowCorrectstringOptionalSpecifies if the Correct feature is enabled for the envelope. This feature enables you to correct the details of in process envelopes that you sent or are shared with you, including the recipient, envelope, and document information.
enableSignWithNotarystringOptionalSpecifies if Docusign eNotary service is enabled for the envelope.
Creates an envelope — request body — body composite Templates item server Templates item
FieldTypePresenceDescription and constraints
$objectRoot
sequencestringOptionalSpecifies the order in which templates are overlaid.
templateIdstringOptionalThe unique identifier of the template. If this is not provided, Docusign will generate a value.

SDK function policy ID: docusign.esignature_envelopes_postenvelopes. Catalog operation: esignature:Envelopes_PostEnvelopes. 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.

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.