Skip to main content
PATCH
/
sign
/
envelopes
/
{envelopeID}
Update Envelope
curl --request PATCH \
  --url https://api.gonitro.dev/sign/envelopes/{envelopeID} \
  --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.

Path Parameters

​
envelopeID
string<uuid>
required

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

Body

application/json
​
name
string

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

​
notification
object

Notification settings for the envelope. Optional field.

​
mode
enum<string>

Signing mode for the envelope. Optional field.

Available options:
sequential,
parallel

Response

Envelope updated successfully

​
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