Skip to main content
POST
@firma-dev/sdk

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

Signing request cancellation result

message
string
required
signing_request_id
string<uuid>
required
cancelled_on
string<date-time>
required
notify_signers
boolean
emails_sent
integer

Number of cancellation notification emails sent to signers