Cancel a booking
Cancels a confirmed booking, releases its slot, and clears any reminder claim.
/api/scheduling/bookings/{id}Cancels a confirmed booking, releases its slot, and clears any reminder claim. Visitor bearer callers may cancel only bookings linked to their own conversation. Missing bookings return 404; an already cancelled booking returns 422, while completed and no-show bookings return 409.
Endpoint requirements
- Credentials
- Use either
Bearer API keyorX-API-Key header. - Required scope
scheduling:write- Module
- Automation & API module (
api_access) - Organization and site scope
- Requests can access only resources owned by the authenticated organization. The API does not reveal whether an identifier belongs to another organization or site.
- Retry behavior
- Convergent write: Cancellation is a terminal transition from confirmed to cancelled. Repeating a completed cancellation returns 422; attempting to cancel a completed or no-show booking returns 409. After an ambiguous timeout, read the booking list before retrying.
Path Parameters
Path parameter. Unique identifier of this resource.
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$uuidHeader Parameters
DA-4035: selects the active site (project) for project-scoped operations. Accepts a site UUID, or the literal all to aggregate across every accessible site on read-only aggregate routes (single-or-all-read). Mutations and single-site routes reject all. Path-owned project routes (/api/projects/{projectId}/…) resolve the site from the URL and ignore this header. Conflicting selectors across header/query/body/path return PROJECT_CONTEXT_CONFLICT (400); an archived site returns PROJECT_ARCHIVED (410).
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
{ "booking": { "id": "22222222-2222-4222-8222-222222222222", "orgId": "33333333-3333-4333-8333-333333333333", "projectId": "11111111-1111-4111-8111-111111111111", "visitorEmail": "[email protected]", "visitorName": "Ada Lovelace", "date": "2030-06-15", "timeSlot": "10:00", "timezone": "Europe/Warsaw", "conversationId": "11111111-1111-4111-8111-111111111111", "status": "cancelled", "createdAt": "2030-05-01T08:00:00.000Z", "updatedAt": "2030-05-01T08:00:00.000Z" }}Request examples
curl
curl --request DELETE \
'https://api.convor.io/api/scheduling/bookings/22222222-2222-4222-8222-222222222222' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer convor_sk_...'JavaScript
const response = await fetch("https://api.convor.io/api/scheduling/bookings/22222222-2222-4222-8222-222222222222", {
method: "DELETE",
headers: {
"Accept": "application/json",
"Authorization": "Bearer convor_sk_..."
},
});
const contentType = response.headers.get("content-type") ?? "";
const data = response.status === 204
? null
: contentType.includes("json")
? await response.json()
: contentType.startsWith("text/")
? await response.text()
: await response.blob();
if (!response.ok) {
const message = typeof data === "object" && data !== null
&& "error" in data && typeof data.error === "object"
&& data.error !== null && "message" in data.error
? String(data.error.message)
: "Convor API request failed (" + response.status + ")";
throw new Error(message);
}
console.log(data);Was this page helpful?