作废信封
POST/openapi/v1/envelopes/void
主动撤销尚未完成的信封，停止签署流程。被撤销的信封不可恢复。默认通过邮件向尚未完成签署的接收人发送作废通知。
撤销限制：仅 sent（签署中）状态的信封可撤销；draft（草稿）/ completed（已完成）/ declined（已拒签）/ voided（已作废）的信封不可撤销。
请求参数
Header 参数
Authorization必填string
Bearer <access_token>
X-Operator-User-Id必填string
操作用户 ID（必填）。需为信封发起人或所属空间的管理员。
Body 请求体
application/jsonEnvelopeId必填string
信封 ID（必填）
VoidReason必填string
作废原因说明（必填），用于告知接收人撤销原因。
请求示例
{
"EnvelopeId": "SGEV1234567890",
"VoidReason": "客户要求撤销"
}响应参数
Response.Data
EnvelopeId选填string
信封 ID
Status选填string
信封新状态，作废成功后固定为 voided
VoidedAt选填string
作废时间，RFC3339 格式。示例：2024-01-15T14:30:45Z
VoidReason选填string
作废原因
响应示例
{
"Response": {
"RequestId": "req-abc123",
"Error": null,
"Data": {
"EnvelopeId": "SGEV1234567890",
"Status": "voided",
"VoidedAt": "2024-01-15T14:30:45Z",
"VoidReason": "客户要求撤销"
}
}
}错误码
| 错误码 | 说明 |
|---|---|
INVALID_REQUEST | 请求参数错误（EnvelopeId 为空等） |
OPENAPI.OPERATOR_USER_ID_REQUIRED | 缺少 X-Operator-User-Id Header |
OPENAPI.OPERATOR_USER_NOT_FOUND | 操作用户不是该空间的成员 |
ENVELOPE.VOID_REASON_EMPTY | 作废原因为空 |
ENVELOPE.VOID_REASON_TOO_LONG | 作废原因超过长度限制 |
ENVELOPE.VOID_NOT_ALLOWED | 信封状态不允许作废 |
NOT_FOUND | 信封不存在 |
FORBIDDEN | 操作用户既不是信封发起人，也不是空间管理员 |
INTERNAL_ERROR | 服务内部错误 |