Signing Requests

Cancel a signing request

Cancels a signing request that hasn't been completed yet. Can only cancel requests that have been sent and are not already finished or cancelled.

post/signing-requests/{id}/cancel

Request

Base URL
https://api.firma.dev/functions/v1/signing-request-api
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/firma/apis/firma-partner-api/docs/signing-requests/:id/cancel/post.ts
A function with typed inputs. Its response is checked against the schema.

idstring uuid required

Signing request ID

reasonstring

Optional cancellation reason

notify_signersboolean

Whether to notify signers of cancellation

Signing request cancelled successfully

messagestring required

signing_request_idstring uuid required

cancelled_onstring date-time required

notify_signersboolean

emails_sentinteger

Number of cancellation notification emails sent to signers

No recorded changes to this operation across all 13 revisions of this API.