Skip to content

Void Envelope

POST
/envelopes/{envelope_id}/void

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.

Authorizations

Parameters

Path Parameters

envelope_id
required

Envelope id (UUID).

string

Envelope id (UUID).

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
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.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string