sign

Void an envelope

Cancel a draft or sent envelope so every signing link stops working; free, CONSEQUENTIAL and irreversible. Sensitive write: it requires the human's approval to void. The charge is refunded in full only if no signer has opened their link yet.

post/v1/envelopes/{envelope_id}/void

Request

  • Base URL: https://api.noerrands.com/c/sign
  • URL: https://api.noerrands.com/c/sign/v1/envelopes/{envelope_id}/void
  • Auth: HTTP bearer

Path parameters

envelope_idstring required

The envelope id, "sg_..." from create_envelope.

Request body

reasonstring

Optional, shown to signers who open a dead link.

Response

Success.

envelope_idstring required
status'voided' required
refunded_centsinteger required
balance_centsinteger required

Changes

No recorded changes to this operation across all 1 revision of this API.