Appointment availability and booking management
Appointment availability and booking management
DELETE Cancel a booking — Cancels one booking in the current organization by setting its status to cancelled. Use this when a visitor or operator needs to release a confirmed time slot.POST Create a booking — Creates a confirmed booking for a visitor in the current organization.GET Get available time slots for a date — Returns available 30-minute booking slots for one date in the current organization.GET List bookings for a conversation — Lists all bookings for one conversation in the current organization. The conversationId query is required.GET List confirmed bookings for a specific date — Returns all confirmed bookings for one date in the current organization, ordered by time slot.POST Reschedule a booking to a new slot — Moves a confirmed booking to a new date and 30-minute time slot without creating a new booking record. The booking ID and conversation link stay the same.POST Set booking outcome (completed / no-show) — Records the final outcome of a confirmed booking in the current organization.Was this page helpful?
Update multilingual category content
Partially updates one organization-owned category key, icon, sort order, or complete supplied locale variants. Uniqueness and localization lifecycle constraints are revalidated before the updated category is returned. Access requires an active organization administrator session or an organization API key with the `knowledge-base:write` scope. API-key calls also require the automation API module. Data is isolated to the authenticated organization; identifiers from another organization or site are not disclosed.
Cancel a booking
Cancels one booking in the current organization by setting its status to `cancelled`. Use this when a visitor or operator needs to release a confirmed time slot. Widget visitors may cancel only bookings linked to their own conversation; operators may cancel any organization booking. The booking must belong to the current organization. Missing bookings return `404`, and bookings that are already cancelled return `422`. Authenticate with an organization API key sent in `X-API-Key` or as a Bearer token and carrying the exact `scheduling:write` scope. API-key access also requires the Automation & API module (`automation_api`). Authorized dashboard sessions remain supported where the route already permits them. The request is isolated to the authenticated organization. Resource and site/project identifiers must belong to that organization; out-of-scope identifiers are not disclosed. The operation releases the confirmed slot and clears any reminder claim. Visitor bearer callers may cancel only bookings linked to their own conversation. Retry behavior: Cancellation is a terminal transition from `confirmed` to `cancelled`. A repeated request or an attempt to cancel `completed` or `no_show` returns `422`; after an ambiguous timeout, read the booking list before retrying.