GOgonitro
Sign

Cancel Envelope by ID

Changed on

The Cancel Envelope by ID endpoint cancels the signing request for the envelope specified by its UUIDv4 identifier. This endpoint allows you to cancel an envelope and changes its status to Cancelled but keeps it available for reference and reuse after updates. In Cancelled status, no further signing operations can be done on the envelope.

Note: Only envelopes that have been sent for signing can be cancelled. Draft envelopes cannot be cancelled.

put/sign/envelopes/{envelopeID}:cancel

Request

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

Path parameters

envelopeIDstring uuid required

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

Response

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

mode'sequential' | 'parallel'

Signing mode for the envelope.

notificationsManagedBy'nitro' | 'sender'

Who notifies the participants of this envelope: nitro or sender. Defaults to nitro.

Changes