Cancel a booking

POST/api/v1/bookings/{id}/cancel

scope bookings:write

Cancels a scheduled or confirmed booking and frees its slot. The booking is kept, with status: "cancelled" and the reason you recorded. A booking that is already completed, cancelled or marked no-show returns 409 conflict with reason: "invalid_transition". If the account has a booking message switched on in Bookings → Settings (a confirmation, a reminder, a cancellation notice), it is sent to the contact exactly as it would be for a booking made in the dashboard.

Path parameters

Name	Type	Description
`id`required	`string (uuid)`	Booking id

Body

application/json

Name	Type	Description
`reason`optional	`string \| null`	Why it was cancelled. Shown to the team

Request

curl -X POST "https://your-crm.example.com/api/v1/bookings/c0ffee00-1234-4abc-9def-000000000001/cancel" \
  -H "Authorization: Bearer $RAABTA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "reason": "Customer asked to cancel"
  }'

Response · 200 OK

{
  "data": {
    "id": "c0ffee00-1234-4abc-9def-000000000001",
    "contact_id": "9d7e4c11-5a2b-4f7c-8e3d-2a1b0c9d8e7f",
    "assignee_user_id": "2f3e4d5c-6b7a-4c8d-9e0f-1a2b3c4d5e6f",
    "type": {
      "id": "b00c1e00-1234-4abc-9def-000000000002",
      "name": "Consultation"
    },
    "title": "Consultation",
    "location": "Clinic, Room 2",
    "notes": "Wants to discuss a website redesign",
    "starts_at": "2026-09-05T10:00:00.000Z",
    "ends_at": "2026-09-05T10:30:00.000Z",
    "status": "cancelled",
    "source": "api",
    "cancel_reason": "Customer asked to cancel",
    "completed_at": null,
    "created_at": "2026-09-02T10:05:00.000Z",
    "updated_at": "2026-09-03T08:00:00.000Z"
  }
}

Response

Wrapped in { data: … }

Name	Type	Description
`id`required	`string (uuid)`	UUID
`contact_id`required	`string (uuid) \| null`	The contact this booking is for
`assignee_user_id`required	`string (uuid) \| null`	The member who owns the slot
`type`required	`object \| null`	The booking type, when one is set
`type.id`required	`string (uuid)`	UUID
`type.name`required	`string`
`title`required	`string \| null`	Snapshotted from the type name at booking time
`location`required	`string \| null`	Snapshotted from the type at booking time
`notes`required	`string \| null`	Free text recorded with the booking
`starts_at`required	`string (date-time)`	ISO 8601 timestamp
`ends_at`required	`string (date-time)`	ISO 8601 timestamp
`status`required	`string (enum)`	Where the booking is in its life`scheduledconfirmedcompletedno_showcancelled`
`source`required	`string (enum)`	Who booked it: staff in the dashboard, the AI assistant, the public booking page, or this API`staffaipublicapi`
`cancel_reason`required	`string \| null`	What was recorded when it was cancelled
`completed_at`required	`string (date-time) \| null`	When it was marked completed
`created_at`required	`string (date-time)`	ISO 8601 timestamp
`updated_at`required	`string (date-time)`	ISO 8601 timestamp

Errors

Status	Code	When
400	`bad_request`	The request could not be parsed: malformed JSON, an invalid cursor, or a query parameter of the wrong shape.
400	`validation_error`	The body or query failed validation. `details` lists each failing field with a `path` and a `message`.
401	`unauthorized`	No usable API key: the Authorization header is missing or malformed, or the key is unknown, revoked or expired. The three are deliberately indistinguishable.
403	`forbidden`	The key is valid but lacks the scope this endpoint requires, or the request came from an address outside the key’s IP allowlist. The message says which.
403	`account_suspended`	The account this key belongs to is suspended. Rotating the key will not help; contact support.
404	`not_found`	No such resource in this account. A resource that exists in another account also returns this.
409	`conflict`	The request conflicts with current state: a duplicate phone number on create, an invalid state transition, or an idempotent request that is still in flight.
422	`unprocessable`	The request was well-formed but cannot be carried out. `reason` is a stable string saying why (for example `outside_window` or `stage_not_in_pipeline`).
429	`rate_limited`	The per-key budget, or the per-IP budget for failed authentication, is exhausted. Honour `Retry-After` before retrying.
500	`internal`	Something failed on our side. Safe to retry with the same Idempotency-Key; quote `request_id` if it persists.