Skip to main content

​
Input

​
string
required
The title of this envelope. This may be shown to recipients.
​
string
A message to include in emails to recipients.
​
string
Custom label given to the envelope for easier identification. Labels are for internal use and are not shown to recipients.
​
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.
​
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.
​
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.
​
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.
​
string
The name of the sender. This overrides the account default sender name.
​
string
The name of the sender of the envelope. This overrides the account default sender email.
​
string
Extra properties for extensibility.
​
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.
​
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.
​
array of string
Use to classify envelopes and filter webhook notifications.

​
Output

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