Signature requests

Cancel a signature request

Closes signing links and tells invited recipients. Canceling twice is harmless.

post/v1/signature-requests/{id}/cancel/

Request

  • Base URL: https://api.pdfbetter.com
  • URL: https://api.pdfbetter.com/v1/signature-requests/{id}/cancel/
  • Auth: HTTP bearer

Path parameters

idstring required

Headers

Idempotency-Keystring

Any unique string (≤ 255 chars). The first successful response is replayed for 24 hours for the same key and request.

Request body

reasonstring

Response

Cancel a signature request

object'signature_request' required
idstring required
documentIdstring required
titlestring required
messagestring nullable required
status'draft' | 'sent' | 'completed' | 'declined' | 'canceled' | 'expired' required
routing'sequential' | 'parallel' required
reminderEveryDaysinteger nullable required
expiresAtstring nullable required

ISO 8601 timestamp (UTC)

sentAtstring nullable required

ISO 8601 timestamp (UTC)

completedAtstring nullable required

ISO 8601 timestamp (UTC)

createdAtstring required

ISO 8601 timestamp (UTC)

fieldCountinteger required
hasCompletedFileboolean required
hasCertificateboolean required

Changes

No recorded changes to this operation across all 1 revision of this API.