Void Envelope
POST/openapi/v1/envelopes/void
Actively cancel an envelope that has not yet completed and stop the signing flow. A voided envelope cannot be recovered. By default, an email notification is sent to recipients who have not finished signing.
Void constraint: Only envelopes in sent (in progress) status can be voided. Envelopes in draft / completed / declined / voided status cannot be voided.
Request Parameters
Header Parameters
AuthorizationRequiredstring
Bearer <access_token>
X-Operator-User-IdRequiredstring
Operator user ID (required). Must be the envelope sender or an admin of the envelope's space.
Request Body
application/jsonEnvelopeIdRequiredstring
Envelope ID (required)
VoidReasonRequiredstring
Reason for voiding (required). Shown to recipients to explain the cancellation.
Request Example
{
"EnvelopeId": "SGEV1234567890",
"VoidReason": "Cancelled at customer's request"
}Response Parameters
Response.Data
EnvelopeIdOptionalstring
Envelope ID
StatusOptionalstring
New envelope status, fixed to voided on success
VoidedAtOptionalstring
Void timestamp in RFC3339 format. Example: 2024-01-15T14:30:45Z
VoidReasonOptionalstring
Void reason
Response Example
{
"Response": {
"RequestId": "req-abc123",
"Error": null,
"Data": {
"EnvelopeId": "SGEV1234567890",
"Status": "voided",
"VoidedAt": "2024-01-15T14:30:45Z",
"VoidReason": "Cancelled at customer's request"
}
}
}Error Codes
| Error Code | Description |
|---|---|
INVALID_REQUEST | Invalid parameters (e.g. EnvelopeId is empty) |
OPENAPI.OPERATOR_USER_ID_REQUIRED | Missing X-Operator-User-Id header |
OPENAPI.OPERATOR_USER_NOT_FOUND | Operator is not a member of this space |
ENVELOPE.VOID_REASON_EMPTY | Void reason is empty |
ENVELOPE.VOID_REASON_TOO_LONG | Void reason exceeds the length limit |
ENVELOPE.VOID_NOT_ALLOWED | Envelope status does not allow voiding |
NOT_FOUND | Envelope does not exist |
FORBIDDEN | Operator is neither the envelope sender nor a space admin |
INTERNAL_ERROR | Internal service error |