Dropbox Sign/signatureRequestCancel

Preview only · details below

Dropbox SignDropbox Sign eSignature API

POST/signature_request/cancel/{signature_request_id}

Cancel Incomplete Signature Request

Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`.

Manage accounts, signature requests, templates, teams, bulk sends, file downloads, fax, and event callbacks through the complete Dropbox Sign v3 API; the Hub provides documentation and a local SDK/CLI only.

Request

operationId
signatureRequestCancel
Server
https://api.hellosign.com/v3
Authentication
api_key, oauth2

Request parameters

signature_request_id

pathstringrequired

The id of the incomplete SignatureRequest to cancel.

fa5c8a0b0f492d768749333ad6fcc214c111e967

Responses

200

unknownapplication/json

successful operation

4XX

ErrorResponseapplication/json

failed_operation

Properties: error