Cancel signature request
Cancels a request that is waiting for signatures.
POST https://cotlet.dev/api/v1/yousign/signature-requests/{signature_request_id}/cancel
write Confirm
Works on a request in Approval or In progress. Participants are notified and can no longer open the signature page, and a cancelled request cannot be reactivated. The documents stay downloadable and the request can be duplicated. By default you confirm each call; you can switch that off for this tool.
Parameters
| Name | Type | Description |
|---|---|---|
| signature_request_id string required | string | Signature request ID from list_signature_requests or create_signature_request. |
| reason string required | string | The reason, chosen from the list Yousign offers under Cancel request. |
| message string | string | Optional custom message shown to the signers. |
Request
curl -X POST https://cotlet.dev/api/v1/yousign/signature-requests/signature_request_8c41d2/cancel \
-H "Authorization: Bearer $COTLET_API_KEY" \
-H "Content-Type: application/json" \
-d '{"reason":"reason"}'result = client.call("yousign", "cancel_signature_request", {"signature_request_id":"signature_request_8c41d2","reason":"reason"})const result = await cotlet.call('yousign', 'cancel_signature_request', {"signature_request_id":"signature_request_8c41d2","reason":"reason"});cotlet call yousign cancel_signature_request --data '{"signature_request_id":"signature_request_8c41d2","reason":"reason"}'Example response
{
"id": "2a7f9e10-3b4c-4d85-a6e1-7c90d2b8f351",
"name": "Lease renewal",
"status": "Cancelled",
"reason": "Terms changed",
"notified": 2
}