Skip to main content
POST
Cancel an appointment request
Cancels one appointment request by the appointmentRequestId from Request an Appointment or List Appointment Requests. Only a pending request can be cancelled: once Turris operations starts filing it with the state, this endpoint refuses. The call takes no request body. Needs the Appointment product feature.

What You Get Back

200 with the request, its status now canceled, canceledAt set to the time of the cancel and canceledBy.type api_client. The fields are the ones Get an Appointment Request returns.
The request is kept. Get an Appointment Request returns it with status canceled from then on, and it stays in List Appointment Requests. A cancelled request no longer counts as open, so it does not block a later Request an Appointment call for the same agent or agency, state and carrier.

Refusals

If Turris operations moves the request on at the moment you cancel, the cancel loses: the answer is 409 with the status the request moved to, and the request goes ahead.

Calling It Again

Send an idempotency-key header to make a network retry safe. A successful cancel is replayed with 200 and the same body for one hour. A 409 is not stored, so a retry with the same key runs again. A key reused for a different request answers 400. See Idempotency. Without a key, a retry after a cancel that went through answers 409 with details.status canceled. If you retried because the first call timed out, that answer means the cancel worked.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

idempotency-key
string

UUID to ensure idempotent request processing

Example:

"550e8400-e29b-41d4-a716-446655440000"

x-idempotency-key
string

Alternative UUID header for idempotent request processing

Example:

"550e8400-e29b-41d4-a716-446655440000"

Path Parameters

appointmentRequestId
string
required

Appointment request ID, as returned by the List Appointment Requests endpoint

Example:

"6672b1c2d3e4f5a6b7c8d9e0"

Response

The appointment request, now canceled

data
object
required
requestId
string
required

Unique request identifier

Example:

"dev-2c5e7cf2-9acf-4c8c-ab2f-b81f39d775a8"

timestamp
string
required

Response timestamp

Example:

"2025-11-12T20:49:03.293Z"