E-Signature

Void Envelope

Cancel an envelope that is already out.

The signing link stops working, so this is the operation to reach for when a document was sent in error - deleting it is not, because a sent envelope cannot be deleted at all. The audit trail is preserved.

post/envelopes/{envelope_id}/void

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/envelopes/{envelope_id}/void
  • Auth: HTTP bearer

Path parameters

envelope_idstring required

Envelope id (UUID).

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Response

Successful Response

dataEnvelopePayload required

An open envelope for the envelope detail.

Open on purpose: the detail carries its documents and its whole audit trail, and the audit trail gains event kinds as the product does. Closing it would silently drop an event a caller was relying on to know what happened.

Nothing secret rides in here: the signer and viewer tokens are the SIGNING LINK's credentials and the app's detail projection does not include them.

Changes

No recorded changes to this operation across all 2 revisions of this API.