Skip to main content
PUT
/
sign
/
envelopes
/
{envelopeID}
:cancel
Cancel Envelope by ID
curl --request PUT \
  --url https://api.gonitro.dev/sign/envelopes/{envelopeID}:cancel \
  --header 'Authorization: Bearer <token>'
{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "createdAt": "2025-11-05T12:51:23.163Z",
  "lastModifiedAt": "2025-11-05T12:51:23.163Z",
  "name": "string",
  "status": "cancelled"
}

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.

Response

Envelope cancelled 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