​
Input

​
Envelope Title
string
required
The title of this envelope. This may be shown to recipients.
​
Envelope Message
string
A message to include in emails to recipients.
​
Envelope Label
string
Custom label given to the envelope for easier identification. Labels are for internal use and are not shown to recipients.
​
Envelope Routing
string
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.
​
Language
string
The default language to be used in the signing ceremony and deliverables. If not specified, the account’s default language is used.Learn more about languages.
​
Time Zone
string
The time zone to be used for timestamps in deliverables. The names should be the timezone identifiers in the IANA Time Zone Database. If not specified, the account’s default timezone offset is used.Learn more about time zones.
​
Timestamp Format
string
The date and time format to be used in timestamps for deliverables. If not specified, the account’s default timestamp format is used.Learn more about time zones.
​
Sender Name
string
The name of the sender. This overrides the account default sender name.
​
Sender Email
string
The name of the sender of the envelope. This overrides the account default sender email.
​
Extra Properties
string
Extra properties for extensibility.
​
Envelope Mode
string
Envelope mode can be either live or test. In test mode, envelopes are non-binding, free, and do not send real emails. You can view these emails in the dashboard.
​
Envelope Attestation
string
Specifies the regulatory or compliance attestation applied to a completed envelope. Attestations are optional and used to ensure adherence to specific legal or regulatory standards. It can be none or mx_nom151.
  • mx_nom151: To comply with Mexican NOM-151, which governs the preservation of data integrity, a Constancia de Conservación is generated for the Deliverable.
​
Envelope Topics
array of string
Use to classify envelopes and filter webhook notifications.

​
Output

​
Envelope Title
string
The title of the envelope. This may be shown to recipients.
​
Envelope Message
string
A message to include in emails to recipients.
​
Sender Name
string
The email address of the sender of the envelope. This overrides the account default sender email.
​
Sender Email
string
The name of the sender of the envelope. This overrides the account default sender name.
​
Envelope ID
string
The ID of the envelope.
​
Envelope Mode
string
Whether the envelope is in live or test mode. Test mode envelopes are non-binding and not billed.
​
Envelope Attestation
string
Regulatory or compliance attestation.
​
Envelope Topic Item
string
Use to classify envelopes and filter webhook notifications.
​
Envelope Label
string
Custom label given to the envelope for easier identification. Labels are for internal use and are not shown to recipients.
​
Envelope Routing
string
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.
​
Time Zone
string
The time zone to be used for timestamps in deliverables.
​
Timestamp Format
string
The date and time format to be used in timestamps for deliverables.