Skip to main content
POST
/
signing-requests
/
{id}
/
cancel
Cancel a signing request
curl --request POST \
  --url https://api.firma.dev/functions/v1/signing-request-api/signing-requests/{id}/cancel \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reason": "No longer needed",
  "notify_signers": true
}
'
{
  "message": "<string>",
  "signing_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "cancelled_on": "2023-11-07T05:31:56Z",
  "notify_signers": true
}

Authorizations

​
Authorization
string
header
required

API key for authentication. Use your API key directly without any prefix (e.g., 'your-api-key'). Bearer prefix is optional but not required.

Path Parameters

​
id
string<uuid>
required

Signing request ID

Body

application/json
​
reason
string

Optional cancellation reason

Maximum string length: 500
​
notify_signers
boolean
default:true

Whether to notify signers of cancellation

Response

Signing request cancelled successfully

​
message
string
​
signing_request_id
string<uuid>
​
cancelled_on
string<date-time>
​
notify_signers
boolean