Cancel contract request
Cancels an in-progress contract request, stopping the signing process and
notifying any pending signers.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Cancel an in-progress contract request. The endpoint stops the signing process, marks every still-pending participant as canceled, transitions the request to canceled, and best-effort archives the document at the signing provider. It returns the updated contract request.
Authentication & access
- Requires a client API token:
Authorization: Bearer <token>. - The caller must hold the
contracts.requests.cancelpermission and have the OWNER or OPERATIONS role. - Contract signing must be enabled for the client. If it is disabled the request returns
403.
Path parameters
| Parameter | Description |
|---|---|
request_id | ID of the contract request to cancel. Must belong to your client. |
Preconditions
The contract request must not already be in a terminal state. A request whose status is completed, canceled, declined, or expired cannot be canceled and returns 400.
What cancellation does
- Each participant still in a non-terminal state (
created,pending,sent, oropened) is set tocanceled. - The overall request
statusis set tocanceledandcanceled_atis recorded. - The associated signing submission is archived at the signing provider on a best-effort basis. If that archival call fails it is logged and ignored — the cancellation still succeeds.
Response
200 — Returns the updated ContractRequestResponse with status set to canceled, canceled_at populated, and each affected participant reflecting its canceled status.
Error responses
| Status | When |
|---|---|
400 | The contract request is already in a terminal state (completed, canceled, declined, or expired) |
403 | Contract signing is disabled for the client |
404 | No contract request with this request_id exists under your client |
Standard 401 (authentication), 403 (insufficient permission or role), and 429 (rate limit) responses apply to every endpoint and are documented in the Error reference.