Skip to main content

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 SignatureRequest has status_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 delete endpoint, 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 withdraw endpoint specifically when you need to withdraw the SignatureRequest while keeping it in Skribble.

Request

Responses

OK