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.
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.
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. The default is parallel.
The sender of the envelope. This overrides the account’s default sender.
email
string
The email address of the sender of the envelope. This overrides the account default sender email.
name
string
The name of the sender of the envelope. This overrides the account default sender name.
organization
string
The organization of the sender of the envelope.
metadata
object
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.
documents
array of Documents
required
A collection of documents to be signed, ranging from 1 to 10 documents.
title
string
The title of the document. It may be shown to recipients.
url
string
required
The URL where the document or template is located must be publicly accessible and from a valid source.
format
enum
The format of the document or template.
Available options are pdf and docx. The default is pdf.
data
object
The data to fill the template with.
Object keys must be alphanumeric.
fixed_positions
array of fixed positions
Fixed positions within a document where a place can be inserted.
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
required
The page number for this position.
top
number
required
The distance, in points (or 1/72th of an inch), from the top border of the page to the position.
left
number
required
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.
