Withdraw a Signature Request
POST/signature-requests/:SR_ID/withdraw
Withdraws a SignatureRequest, for example when signing becomes unnecessary
or an error occurred during the invitation process. As the inviter, you can
explicitly withdraw the SignatureRequest. This removes all signers and
observers as participants and notifies them with a specified message.
Similar to deletion, the withdraw action can only be executed if:
-
The
SignatureRequesthasstatus_overall=OPEN -
The API user has sufficient rights on the
SignatureRequest, such as when it was created by the API user.
Note We recommend using the
deleteendpoint, which automatically determines the appropriate action. For example, if the API user does not have withdrawal rights, they may instead be removed as a participant, or the document may be deleted directly.Use the
withdrawendpoint specifically when you need to withdraw theSignatureRequestwhile keeping it in Skribble.
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 429
- 500
- 503
OK
Bad request
Unauthorized
Access denied
Not found
Too many requests
Internal server error
Service unavailable