Signatures

Void an envelope

Cancels an envelope that is out for signature: nobody can sign it any more, and the recipients see it as withdrawn. Cannot be undone, and cannot be done to one that has already ended (completed, declined or expired). Always record why.

post/api/v1/rest/firme/envelopes/{id}/void

Request

  • Base URL: https://api.custodo.ai
  • URL: https://api.custodo.ai/api/v1/rest/firme/envelopes/{id}/void
  • Auth: HTTP bearer

Path parameters

idstring uuid required

Headers

X-Tenant-Idstring uuid

The organisation to act in. An API key is bound to exactly one, so this is optional for a key and must match the one it was minted for.

Request body

reasonstring required

Why. Recorded in the evidence trail.

Response

Done. data is the tool’s own answer.

oktrue required
dataunknown required

Changes

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