envelope

Void an envelope

Stops it for good; signers who got a link are told it was voided.

post/envelopes/{envelope_id}/void

Request

  • Base URL: https://localhost:4410/api/v1
  • URL: https://localhost:4410/api/v1/envelopes/{envelope_id}/void
  • Auth: HTTP bearer

Path parameters

envelope_idstring required

Request body

reasonstring required

Why, in the person's words; the signers see it.

Response

The result.

idstring required
document_idstring required
version_idstring required
titlestring required
messagestring nullable required
status'draft' | 'sent' | 'completed' | 'declined' | 'voided' | 'expired' required
orderedboolean required
pagesinteger required
signature_pageboolean required
urlstring required
codestring nullable required
result_sha256string nullable required
created_atstring date-time required
sent_atstring date-time nullable required
completed_atstring date-time nullable required
voided_atstring date-time nullable required
expires_atstring date-time nullable required
reminded_atstring date-time nullable required
needs_reviewboolean required
exclusion_overridestring nullable required
hold'funding' nullable required

Changes

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