Dropbox Sign/signatureRequestCancel

正在自动加载完整文档…

Dropbox SignDropbox Sign 电子签名 API

POST/signature_request/cancel/{signature_request_id}

取消不完整的签名请求

取消不完整的签名请求。此操作不可逆转。

请求将被取消,签名者将无法再签名。如果他们尝试访问签名请求,他们将收到 HTTP 410 状态代码,指示资源已被删除。取消是异步的,如果签名请求符合取消条件并且已成功排队,则成功调用此 Endpoint 将返回空的 200 OK 响应。

此 200 OK 响应并不表示签名请求本身已成功取消。取消是通过 signature_request_canceled 事件确认的。建议实现回调处理程序来监听signature_request_canceled事件。仅当取消成功完成时才会发送此回调。如果已配置回调处理程序,但在调用后 60 分钟内未收到事件,请检查 API 仪表板 中的请求状态,并在必要时重试取消。

要获得取消资格,签名请求必须已成功发送,且尚未由所有签名者签名,并且您必须是发送者或拥有发送该请求所使用的 API 应用程序。可以取消部分签名的签名请求。

注意: 要删除您对已完成的签名请求的访问权限,请使用 Endpoint:POST /signature_request/remove/[:signature_request_id]。

通过完整的 Dropbox Sign v3 API 管理账户、签名请求、模板、团队、批量发送、文件下载、传真和事件回调;可在网页调试面板中使用当前会话凭据发起单次请求。

请求

operationId
signatureRequestCancel
服务器
https://api.hellosign.com/v3
认证
api_key, oauth2

请求参数

signature_request_id

pathstring必填

要取消的不完整 SignatureRequest 的 ID。

example-signature-request-id

响应

200

unknownapplication/json

成功响应

4XX

ErrorResponseapplication/json

操作失败

字段: error