Create envelope
POST/restapi/v2.1/accounts/:accountId/envelopes
Create a new envelope and optionally send it to recipients.
Set status: "created" for a draft envelope, or status: "sent" to create and
immediately send it: recipient routing is activated and non-embedded recipients are
notified by email. Embedded recipients (those with a clientUserId) are not emailed —
generate their signing URL with the recipient view endpoint. If the envelope cannot be
sent (for example, no documents or no signers), the request fails with a 400 error and
no envelope is created.
Signing fields declared inline on recipients.signers[].tabs (for example
signHereTabs, textTabs, checkboxTabs) are placed on the envelope at creation time.
Tabs declared on templateRoles[].tabs for a template-based envelope are not applied.
Request
Responses
- 201
- 400
- 401
Envelope created successfully
Response Headers
Correlation id for this request, returned on every response (success and error). Quote it when contacting support to pinpoint the exact request, and use it to correlate your own logs. It is the same 128-bit id as the trace-id segment of the traceparent header.
W3C Trace Context identifier for this request, returned on every response. Send your own traceparent on a request to have it adopted, so a multi-call workflow shares one trace. Format: 00-<32-hex trace-id>-<16-hex span-id>-<2-hex flags>.
Invalid request
Response Headers
Correlation id for this request, returned on every response (success and error). Quote it when contacting support to pinpoint the exact request, and use it to correlate your own logs. It is the same 128-bit id as the trace-id segment of the traceparent header.
W3C Trace Context identifier for this request, returned on every response. Send your own traceparent on a request to have it adopted, so a multi-call workflow shares one trace. Format: 00-<32-hex trace-id>-<16-hex span-id>-<2-hex flags>.
Unauthorized
Response Headers
Correlation id for this request, returned on every response (success and error). Quote it when contacting support to pinpoint the exact request, and use it to correlate your own logs. It is the same 128-bit id as the trace-id segment of the traceparent header.
W3C Trace Context identifier for this request, returned on every response. Send your own traceparent on a request to have it adopted, so a multi-call workflow shares one trace. Format: 00-<32-hex trace-id>-<16-hex span-id>-<2-hex flags>.