Delete a Signature Request
DELETE/signature-requests/:SR_ID
Deletes a SignatureRequest by its ID.
Important: A SignatureRequest can only be deleted via the API if:
-
the
SignatureRequesthasstatus_overall=OPEN, and -
the API user has sufficient rights on the
SignatureRequest, e.g. when it was created by the API user.
Deleting a SignatureRequest does not necessarily remove it from the
system immediately.
WITHDRAWN
When the API user is the owner of the SignatureRequest and it is
still in status_overall=OPEN, the SignatureRequest will be
WITHDRAWN.
This means the SignatureRequest will transition to
status_overall=WITHDRAWN and all pending signatures will be marked with
status_code=WITHDRAWN. Sign and read rights for all signers will be
revoked, so invited signers can no longer read or sign the
SignatureRequest.
REMOVE AS PARTICIPANT
When the API user is a participant but not the owner of the
SignatureRequest, the DELETE request will only remove the API user as a
participant.
In this case, the system will remove the SignatureRequest and its related
documents once the last remaining user deletes it via the Skribble web
application.
DELETING
When the API user is the last user with access rights to the
SignatureRequest (e.g. after a WITHDRAW), the SignatureRequest and
its related documents will be permanently removed from the system.
Request
Responses
- 200
- 400
- 401
- 403
- 429
- 500
- 503
OK
Bad request
Unauthorized
Access denied
Too many requests
Internal server error
Service unavailable