Skip to main content
POST
/
sign
/
envelopes
Create Envelope
curl --request POST \
  --url https://api.gonitro.dev/sign/envelopes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "notification": {
    "subject": "<string>",
    "body": "<string>"
  },
  "mode": "sequential"
}'
{
  "ID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2023-11-07T05:31:56Z",
  "lastModifiedAt": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "status": "drafted"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
name
string
required

The Envelope's name. It doesn't have to be unique.

Minimum length: 1
​
notification
object
required

The notification object defines the email sent to participants when an envelope is delivered for signing. It contains a subject and a body as nested parameters, and both fields support dynamic variables.

Dynamic Variables You can personalize notification emails by referencing dynamic variables in the subject or body. Available variables: envelope_name: The name of the envelope being signed. sender_name_or_email: The sender’s name, or their email address if the name is not available.

Syntax: To reference the variables, wrap them with $() in your message. Example: $(envelope_name)

notification object example:

{
    "notification": {
        "subject": "$(sender_name_or_email) is requesting your signature",
        "body": "Hi,\nPlease sign the $(envelope_name)\nThank you,\n$(sender_name_or_email)"
    }
}
​
mode
enum<string>
required

The Signing Mode in an enum that defines the signing order. It has two possible values:

  • sequential: Participants receive notifications one at a time, in the order they were added to the envelope. Each new notification is triggered once the previous participant has completed their signing.
  • parallel: All participants are notified at the same time and can sign the documents in the envelope independently, without waiting for others.
Available options:
sequential,
parallel

Response

When an envelope is created you will get a unique ID for it. You can add assets to the envelope later by referencing its unique ID using other endpoints in this API.

​
ID
string<uuid>

A unique UUIDv4 string that identifies the envelope in the Nitro system.

​
createdAt
string<date-time>

UTC timestamp indicating when the envelope was created.

​
lastModifiedAt
string<date-time>

UTC timestamp indicating the last time the envelope was updated. Matches createdAt at the time of creation.

​
name
string

The name of the envelope.

​
status
enum<string>

The internal status of the envelope. Defaults to drafted on creation.

Available options:
drafted,
sent,
processing,
sealed,
rejected,
cancelled,
deleted
⌘I