Skip to main content
PATCH
Update Envelope

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