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, and rejected with a 400 whenever the envelope ends up with its notifications managed by the sender — either because the same request sets notificationsManagedBy to sender, or because the envelope is already sender-managed and the request leaves it that way. Nitro would never render that copy.

mode
enum<string>

Signing mode for the envelope. Optional field.

Available options:
sequential,
parallel
notificationsManagedBy
enum<string>

Who notifies the participants of this envelope: nitro or sender. Optional field, and only available to API applications.

Switching back to nitro requires a notification in the same request when the envelope has none of its own, since Nitro would otherwise have no copy to send.

While an envelope is sender managed, a notification is refused: Nitro would never render it. Send the copy in the same request that hands the notifications back to nitro.

Available options:
nitro,
sender

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