Skip to content

Create Envelope

POST
/envelopes

Create a DRAFT envelope. Nothing is emailed.

The documents are HTML the caller already holds - there is no upload step - which is what makes the whole flow scriptable. expires_in_days counts from creation, NOT from the moment it is sent, so a draft left sitting for a month has already used its window.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Create a DRAFT envelope. Nothing is emailed until it is sent.

Exactly one signer. The app’s model carries one signer_name / signer_email pair rather than a list, so this does too - a mirror that invented a list would accept a second signer that is silently dropped.

object
documents
required

At least one document - an empty envelope has nothing to sign.

Array<object>
>= 1 items

One document inside an envelope.

content_html IS the document - there is no upload step and no file. That is why this surface has no multipart endpoint: an envelope is created from HTML the caller already holds, which is what makes it scriptable.

object
content_html
required

The document body as HTML. Rendered to the PDF the signer sees.

string
>= 1 characters
title
required
string
>= 1 characters
expires_in_days

How long the signing link stays valid, counted from CREATION rather than from send.

integer
default: 30 >= 1 <= 365
message
Any of:
string
signer_contact_id
Any of:
integer
signer_email
required
string
>= 1 characters
signer_name
required
string
>= 1 characters
source_id
Any of:
string
source_type
Any of:
string
subject
required

Subject line the signer sees.

string
>= 1 characters

Responses

201

Successful Response

object
data
required

An open envelope for the envelope detail.

Open on purpose: the detail carries its documents and its whole audit trail, and the audit trail gains event kinds as the product does. Closing it would silently drop an event a caller was relying on to know what happened.

Nothing secret rides in here: the signer and viewer tokens are the SIGNING LINK’s credentials and the app’s detail projection does not include them.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string