ClearBookings - Home

Showing 25 of 40 from the live probe.

• Assign Booking Fields

  Attach, detach or replace the custom fields collected for an entity. Works at any level: organisation, listing (event), schedule (session), ticket, addon or variant. Use list_custom_fields to find field_id values. mode: - attach (default): add the listed fields, leaving existing assignments intact (updates required/ordering on any already present). - detach: remove the listed field_ids from the entity. - set: replace the entity's entire field set with exactly the list supplied (an

• Bulk Adjust Availability

  Bulk-adjust session availability across many (schedule × date) combinations: places_left, places_allocated, places_left_delta (signed), max_bookings (null clears), published (0/1/2). Quantity setters are mutually exclusive. selectors[] are unioned. Each selector picks sessions (schedule_ids[]? and/or time_range?) and a date range (dates {from, to?}); the adjustment applies to every matched session on every date in the range. ticket_id?: >0 = per-ticket quota (places_allocated only); 0/omitted =

• Contact Support

  Escalate the organiser's enquiry to the ClearBookings support team. Use this when you cannot resolve the request yourself — for example billing or payout questions, account access problems, anything financial you cannot action with your other tools, or a task for which no tool and no self-service path exists. This is a LAST RESORT, not a first response to difficulty: - If a tool call fails, first try to recover yourself. An invalid-ID error means YOU supplied a wrong ID — look the correct one

• Copy Event

  Duplicate an existing event. Useful for setting up a new occurrence of a recurring annual event (e.g. last year's Summer Camp → this year's), or for spawning a new event from a template. The copy is created unpublished by default. Its name has " [COPY]" appended unless the source is a template. After copying, use update_event to adjust dates, name, and any other fields that need to change for the new occurrence. By default (deepcopy=true) sessions, ticket types and add-ons are copied too. Set

• Create Article

  Create a new content article in the organiser's account. Two article types are supported: - Structured: provide schema_name (from list_article_types) and a content object matching that schema. schema_name is set once here and is immutable thereafter — update_article cannot change it. - Plain HTML: provide introtext (and optionally fulltext) as HTML strings. Content fidelity (mandatory): text content fields — description, abstract, introtext and titles — are stored VERBATIM from the source. Rep

• Create Event

  Create a new event listing. Always created as an unpublished draft. Confirm name, dates, venue, pricing approach, prices, and capacity with the user before calling — never default capacity to 0. Then use manage_schedules to add sessions and manage_tickets to add ticket types. See the archetypes and field-reference resources for session_model / pricing_model guidance.

• Create Time Slots

  Bulk-generate recurring timeslot sessions on an existing event from a schedule_definition. Use for appointment/timeslot-style events (Santa grottos, escape rooms, PT sessions, hot-desk bookings) where many short sessions repeat at regular intervals. The event must already exist with session_model="recurring".

• Delete Event

  Permanently delete an event and all of its sessions, ticket types, add-ons, and discounts. This action cannot be undone. Existing bookings for the event are NOT deleted — they remain in the system for record-keeping purposes, but the event page will no longer be accessible. Only use this tool when the organiser explicitly asks to delete an event. For hiding an event from customers, use update_event to set published = 0 instead.

• Delete Listing Entity

  Permanently delete a session, ticket type, add-on, or discount from an event. This action cannot be undone. Use the appropriate entity_type: - "schedule" — deletes a session (and its availability records) - "ticket" — deletes a ticket type - "addon" — deletes an add-on (and all its variants) - "discount" — deletes a discount scheme - "variant" — deletes a single variant from an add-on Only use this when the organiser explicitly asks to remove something. To temporarily hide an item from c

• Extract Document Images

  Extract embedded images from a PDF or .docx document and upload them to the organisation's attachments. Returns a manifest of URLs ready to assign to per-entry `image_url` fields in structured article schemas (speakers, exhibitors, etc.). Use when the document contains per-entry imagery the user will want carried into the structured article. Images are returned in document order, grouped by page (PDF) or by sequence (.docx); for PDFs, per-page text is also included to help associate each image w

• Get Account Summary

  Get an account-wide summary across ALL of the organiser's events: booking counts by status, revenue, booking trends, how many events exist and what state they are in, and total capacity currently on sale. Use for questions about the account as a whole ("how are sales going overall?", "how many events do I have running?", "what were my bookings last month?"). For a single event use get_booking_summary instead. Bookings occur ahead of the event: a date range refers to when bookings were MADE, not

• Get Article Schema

  Get the full JSON schema for a specific structured content type. Use this before extracting structured data from a document — it tells you exactly which fields are required, their types, and the expected format. The returned schema is the exact structure you must populate.

• Get Article

  Get the full content of a single article. For structured content articles (those with a schema_name), returns the decoded structured content object. For plain articles, returns the HTML introtext and fulltext. Use list_articles to find article IDs first.

• Get Availability

  Get availability (places remaining per session) for an event on one or more dates, or across a date range. Use this to answer questions like "how many spaces are left on 15 March?" or "which dates in June still have availability?". Each session also reports max_bookings (cap on the NUMBER OF BOOKINGS/groups it accepts, null = unrestricted), total_bookings so far, and max_bookings_reached — when true the session accepts no further bookings even if places_left is still positive, so report it as fu

• Get Booking Summary

  Get an aggregated booking summary for a SPECIFIC event, including booking counts, revenue, availability/capacity, booking trends over recent periods, and key dates (sales open/close, session dates). Use this to answer questions like "how are ticket sales going?" or "how many bookings did we get this week?". For questions about the whole account rather than one event, use get_account_summary instead. Bookings (sales) occur ahead of the event: a question about sales or bookings within a date range

• Get Event

  Get full details for a single event, including sessions (schedules), ticket types, add-ons, discounts, and plugins. Use this after list_events to drill into a specific event.

• Get Profile

  Get key account details for the organiser plus session context: the active organisation, the list of organisations the user can switch to, and the super-admin flag. Call this once at the start of a conversation unless the `session://current` resource has already been provided (in which case use that as the source of truth). Also call this if you have just called switch_organisation, since any previously-cached session context is now stale.

• List Api Fields

  List the writable fields of an entity, with their types, enums and descriptions. Use this to discover the less-common fields that create_event / update_event accept via their `extended_fields` argument — set only keys returned here. Each field reports whether it is settable on create (insertable) and/or update (updatable). Entities: listing, schedule, ticket, addon, variant, discount, discount_code, discount_member, customer, organisation, article.

• List Article Types

  List all available structured content types that can be generated for event article pages (e.g. agenda, speakers, exhibitors). Returns the type identifier, title, and description for each. Call this before get_article_schema to confirm available types.

• List Articles

  List the content articles available in the organiser's account. Returns the article ID, title, alias, published state, schema type (schema_name — null for plain HTML articles) and listing_id: the event whose page-builder layout the article is (null for a standalone content page such as an About or FAQ page). Use this to find existing articles before updating or adding content to them. Filter by schema_name (e.g. "page") and set standalone=true to leave out event page layouts.

• List Custom Fields

  List the organiser's custom field definitions — the catalogue of extra questions or data points that can be collected from customers during booking (e.g. dietary requirements, T-shirt size, a consent checkbox). Use the returned field_id with assign_booking_fields to attach a field at any level (organisation, event/listing, session/schedule, ticket, add-on). `context` indicates WHERE the value is captured: customer (kept on the customer record), invoice (kept on the booking), participant / parti

• List Events

  Search and list the organiser's events. Returns a paged list of listings with basic details. Use get_event to retrieve full details including sessions and tickets for a specific event.

• List Voucher Pools

  List the voucher / ticket-number pools this organisation owns OR vends for, or the codes within one pool. Omit pool_id to get all pools, each with code counts (total, available, allocated, unpublished) and a `relationship` of "owner" (your own pool) or "vendor" (a client's pool you supply codes for, shown with the client's `owner_organisation_name`). Use this before upload_voucher_codes to find a pool's id (so you add to it rather than creating a duplicate) or to check how many codes remain. P

• Manage Addons

  Create or update an add-on for an existing event. Add-ons are optional extras customers can purchase alongside their tickets (e.g. parking, a t-shirt, a meal, insurance). To create a new add-on omit addon_id. To update an existing add-on provide its addon_id. quantity_mode controls how the add-on quantity is determined: - "per_attendee" — optionally one per attendee - "all_attendees" — automatically one per attendee - "per_booking" — binary yes/no, one per booking - "selectable" — customer

• Manage Custom Fields

  Create, update, copy or delete a custom field definition (an extra question/data point collectable at booking). This manages the field itself — to attach it to an event, session, ticket, add-on or the organisation, use assign_booking_fields. Omit field_id to create. Provide field_id to update. Use action=delete or action=copy for those operations. Platform-standard fields cannot be modified.