The title of the envelope, which is shown to recipients.
label
string
Custom label given to the envelope for easier identification. Labels are for internal use and are not shown to
recipients.
message
string
A message to include in emails to recipients.
status
enum
The current status of the envelope.
Available options: draft, processing, in_progress, completed, failed, canceled
mode
enum
The mode affects both legal status and billing of an envelope. Live mode envelopes are legally binding and incur
charges, whereas test mode envelopes are non-binding and are not counted towards billing.
Available options: live, test
routing
enum
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.
A user-provided key that identifies a place within a document.
It must match to one of the keys in the document’s place list.
page
number
The page number for this position.
top
number
The distance, in points (or 1/72th of an inch), from the top border of the page to the position.
left
number
The distance, in points (or 1/72th of an inch), from the left border of the page to the position.
places
array of places
Defined areas within a document where a recipient either provides input, such as a signature, or where a constant or calculated value is added, like a completion date.
