Create Envelope

post

https://api.resly.se/v2/envelopes

Creates an empty draft envelope (status DRAFT) with settings such as name, message, reminders and metadata. Nothing is sent. Next, add signers with Create Signer, upload PDF or Word files with Upload Content, and send it with Publish Envelope. To do all of this in one request, use Create and Publish Envelope.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Create Envelope

Envelope settings.

name

string

Name of the envelope.

globalMessage

string

Message to the participants, shown in the invitation email and on the signing page. Supports dynamic tags that are filled in per recipient: {{participant.name}} (name of the recipient), {{envelope.name}} (name of the envelope), {{responsible.name}} (name of the first responsible user), {{team.name}} (name of the team). Custom fields of type TEXT and TEXTAREA can be referenced as {{customField.}} and insert that custom field's value (empty when unset). Unknown tags are left as-is.

autoReminderInterval

number

enum

Defaults to 0

Days between automatic reminders to invited participants who have not signed yet, at most 5 reminders per participant. 0 turns automatic reminders off.

censorSsn

boolean

Defaults to false

When true, participant SSNs are partly masked in the signature appendix of the signed PDF.

autoSendOut

boolean

Defaults to true

When true, every participant gets an email with the signed document when the envelope is sealed. When false, only CC recipients (added in the Resly app) get it. Signing invitations are sent either way, according to each signer's inviteMethod.

metadata

object

Your own key/value data, such as an ID from your system. Returned unchanged on the envelope and in webhook payloads. At most 4096 characters as JSON.

customFields

object

Values for the custom fields defined in your team settings, keyed by field key. Unknown keys are ignored; values are converted to the field type. At most 4096 characters as JSON.

Responses

200Success.

400Invalid request. See code and errors.

401Missing or invalid API key.

403The API key is not allowed to perform this operation.

500Unexpected server error.