Create an envelope
This operation creates an envelope and starts the signing process, sending the documents to the recipients.
Body Parameters
The title of the envelope, which is shown to recipients.
Additionally, you can use the label property to add an internal description that won’t be shown to recipients.
Custom label given to the envelope for easier identification. Labels are for internal use and are not shown to recipients.
A message to include in emails to recipients.
The order in which recipients sign the envelope. It can be parallel, where all recipients can sign simultaneously, or sequential, where recipients sign one after another. The default is parallel.
Learn more about Recipient Routing
The language for the signer interface and related emails.
Refer to the list of available languages. The default value is en (English).
The timestamp format for this envelope.
The sender of the envelope. This overrides the account’s default sender.
An array of up to 10 strings used to classify envelopes and filter webhook notifications.
Each topic can have up to 32 lowercase alphanumeric characters and underscores, and must start with a letter.
A set of up to 10 custom key-value pairs containing metadata about the envelope. This metadata will be included in API responses and webhook notifications.
A collection of documents to be signed, ranging from 1 to 10 documents.
A collection of people that sign the documents in an envelope, ranging from 1 to 10 recipients.
Returns
Returns a 201 Created status code along with an envelope object after successful creation, or an error otherwise.
Was this page helpful?