API Reference

Create Envelope

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

Use this URI to create a new envelope object.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Create Envelope

The envelope input object.

string

Name of the envelope.

string

Message to the participants. Included in invite to sign email and on the signing webpage. 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 render the object's value for that key (empty when unset). Unknown tags are left as-is.

number
enum
Defaults to 0

Number of days between automatic reminder. Value of 0 results in no automatic reminder.

boolean
Defaults to false

Tells if the envelope is censoring participant SSN (Social Security Number).

boolean
Defaults to true

Tells if the envelope automatically will send out emails to participants.

metadata
object

This metadata field is a versatile storage option that allows you to save any string-based information related to an object, with a substantial limit of up to 4096 characters.

customFields
object

Key/value map of custom field values. Applied as a JSON Merge Patch (RFC 7396): a key with a non-null value sets it, a key with value null removes it, omitted keys are unchanged. Keys not matching a defined custom field are ignored; values are coerced to the field type. Same 4096-character limit as metadata.

Responses

Updated 2 months ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 months ago

Did this page help you?