GOgonitro
Sign

Update Envelope

Changed on

The Update Envelope endpoint modifies an envelope’s name, notification settings, or signing mode. All parameters are optional, so you can update any combination of these fields without affecting the others.

patch/sign/envelopes/{envelopeID}

Request

  • Base URL
    https://api.gonitro.dev
  • URL
    https://api.gonitro.dev/sign/envelopes/{envelopeID}
  • Auth
    HTTP bearer

Path parameters

envelopeIDstring uuid required

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

Request body

namestring

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

mode'sequential' | 'parallel'

Signing mode for the envelope. Optional field.

notificationsManagedBy'nitro' | 'sender'

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.

Response

Envelope updated successfully

IDstring uuid

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

createdAtstring date-time

UTC timestamp indicating when the envelope was created.

lastModifiedAtstring date-time

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

namestring

The name of the envelope.

status'drafted' | 'sent' | 'processing' | 'sealed' | 'rejected' | 'cancelled' | 'deleted'

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

Changes