Booking

Books a real slot on an event type's calendar for an invitee. FREE EVENT TYPES are confirmed immediately: the invitee and the host are emailed/texted a confirmation from the organization's OWN Mailgun/Twilio, reminders are scheduled, and the contact may be enrolled in 'appointment booked' automations. PAID EVENT TYPES (require_payment on, with a price) ARE NOT CONFIRMED HERE — exactly as on the public booking page, the slot is held unconfirmed, nothing is sent to the invitee, and this returns `checkout_url`: a Stripe Checkout link on the business's own account. Give that link to the invitee; the meeting is only confirmed, and the confirmation only sent, once Stripe reports them paid. The requested time is re-validated against live availability, so it fails if the slot was just taken; a round-robin host is assigned automatically. Matches or creates the contact from the invitee's email/phone. Provide the start exactly as one of the ISO UTC starts returned by booking.get_availability.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/booking.book_appointment \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "event_type_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11",
    "start": "2026-09-17T15:00:00Z"
  }'

Over MCP the same operation is the tool booking_book_appointment at https://app.chirply.io/api/mcp, same bearer token, same input.

Cancels a booked appointment and immediately notifies the invitee of the cancellation by email/SMS from the organization's own Mailgun/Twilio, drops its pending reminders, and fires 'appointment canceled' automations. This frees the slot for someone else. Owners and admins only. To move an appointment to a new time instead, use booking.reschedule_appointment.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/booking.cancel_appointment \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "appointment_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool booking_cancel_appointment at https://app.chirply.io/api/mcp, same bearer token, same input.

Start linking a host's own Google Calendar or Microsoft 365 / Outlook account, so their real commitments block booking slots and meetings booked here are written onto their calendar. This does NOT complete the link on its own: connecting requires the account holder to approve access on the provider's own consent screen, so what comes back is the URL that starts that flow. Open it in a browser where the host is already signed in to this account — the link acts as whoever is signed in, so it connects THAT person's calendar, and it grants this account ongoing read/write access to their calendar until it is disconnected. Any member may connect their own; use booking.list_calendar_connections to see what is already linked.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/booking.connect_calendar \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "provider": "google"
  }'

Over MCP the same operation is the tool booking_connect_calendar at https://app.chirply.io/api/mcp, same bearer token, same input.

Start Zoom OAuth authorization for the signed-in host. Returns a browser URL; nothing connects until the host approves Zoom access. Enables automatic meeting creation for opted-in event types, subject to the host's Zoom plan. Requires the platform OAuth app; use booking.save_zoom_credentials for your own Server-to-Server OAuth app instead.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

No parameters — POST an empty body.

Example

curl -X POST https://app.chirply.io/api/v1/actions/booking.connect_zoom \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{}'

Over MCP the same operation is the tool booking_connect_zoom at https://app.chirply.io/api/mcp, same bearer token, same input.

Create a new bookable event type (a meeting people can book), and return its public booking URL. Nothing is sent to anyone and nobody is charged by this call — but if `is_active` is left on (the default) the event type's public booking page goes live immediately and strangers holding the link can book real time on a host's calendar from that moment. Owners and admins only, matching the Calendars editor. Hosts must be members of this account; when `host_user_ids` is omitted the calling user hosts it, and an API key (which has no user) must name at least one host.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/booking.create_event_type \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Example"
  }'

Over MCP the same operation is the tool booking_create_event_type at https://app.chirply.io/api/mcp, same bearer token, same input.

Permanently deletes an appointment and its reminders, including canceled appointments, after removing its linked Google/Outlook Calendar events. Cannot be undone. If calendar cleanup fails the appointment is kept for retry. Does not issue refunds or send Chirply cancellation messages; use booking.cancel_appointment to notify the invitee. Owners and admins only.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/booking.delete_appointment \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "appointment_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool booking_delete_appointment at https://app.chirply.io/api/mcp, same bearer token, same input.

Delete a bookable event type. Its public booking page stops working immediately and it disappears from the Calendars list. This is a soft delete — the record is retained so appointments already booked against it keep their history, and nothing already on anyone's calendar is cancelled or refunded (cancel those separately with booking.cancel_appointment if that's what you mean). There is no undo in the app.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/booking.delete_event_type \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "event_type_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool booking_delete_event_type at https://app.chirply.io/api/mcp, same bearer token, same input.

Disconnect a linked external calendar (Google or Outlook) by its connection id, removing this account's stored access for that calendar. After this, its busy times no longer block booking slots — so times the host is actually busy start being offered to invitees — and new meetings are no longer written to it. Restoring sync means going through the provider's consent screen again: booking.connect_calendar returns that link. Does not delete any existing calendar events. A member can only disconnect their own calendar; managers (and API keys) can disconnect any in the account.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/booking.disconnect_calendar \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "connection_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool booking_disconnect_calendar at https://app.chirply.io/api/mcp, same bearer token, same input.

Remove this host's encrypted Zoom credentials from the account. Future bookings using automatic Zoom links cannot be completed until the host reconnects or the event switches to a pasted link. Existing Zoom meetings are kept; this does not delete rooms or cancel appointments. Signed-in users can disconnect only themselves; API keys must name an account host.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/booking.disconnect_zoom \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "user_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool booking_disconnect_zoom at https://app.chirply.io/api/mcp, same bearer token, same input.

Fetch one appointment by id — the event, host, contact, invitee details, start/end time, location, status and payment state, plus the invitee's manage (reschedule/cancel) URL. Read-only.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/booking.get_appointment \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "appointment_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool booking_get_appointment at https://app.chirply.io/api/mcp, same bearer token, same input.

List the open, bookable time slots for an event type over a date range — exactly what an invitee would see on the public booking page, computed live from the hosts' working hours, existing appointments, buffers and minimum notice. Returns slots grouped by day, each an ISO UTC start/end. Read-only; reserves nothing. The range may span at most 62 days.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/booking.get_availability \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "event_type_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11",
    "from": "example",
    "to": "example"
  }'

Over MCP the same operation is the tool booking_get_availability at https://app.chirply.io/api/mcp, same bearer token, same input.

Fetch one bookable event type by id — its full configuration (kind, duration, buffers, min-notice, location, booking form, reminders, price), the users hosting it, and the shareable public booking URL. This is everything the edit screen shows, so it is what you read before calling booking.update_event_type. Read-only.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/booking.get_event_type \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "event_type_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool booking_get_event_type at https://app.chirply.io/api/mcp, same bearer token, same input.

List this organization's booked appointments, soonest first, optionally filtered by date range, status (confirmed, canceled, completed, no_show), event type, or contact. Read-only; changes nothing.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/booking.list_appointments \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "from": "example",
    "to": "example"
  }'

Over MCP the same operation is the tool booking_list_appointments at https://app.chirply.io/api/mcp, same bearer token, same input.

List the external calendars (Google Calendar, Microsoft 365 / Outlook) connected for scheduling — for each: the provider, the connected account's email, whether it feeds busy times into availability (inbound) and receives booked meetings (outbound), when it last synced, and any current sync error. Access tokens are NEVER returned. When called by a specific user (Copilot) only that user's own connections are shown; an API key sees the whole account. Read-only.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/booking.list_calendar_connections \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "limit": 25,
    "offset": 0
  }'

Over MCP the same operation is the tool booking_list_calendar_connections at https://app.chirply.io/api/mcp, same bearer token, same input.

Lists this account's connected domains and their readiness for publishing event types. Returns hostname, status and supported roles; does not change DNS or spend money.

Parameters

No parameters — POST an empty body.

Example

curl -X POST https://app.chirply.io/api/v1/actions/booking.list_domains \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{}'

Over MCP the same operation is the tool booking_list_domains at https://app.chirply.io/api/mcp, same bearer token, same input.

List this organization's bookable event types (meeting types) — for each: name, public URL slug, kind (one_on_one, group, collective, round_robin), duration in minutes, price, and the shareable public booking URL an invitee visits to pick a time. Read-only; changes nothing and sends nothing. By default only active types are returned.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/booking.list_event_types \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "include_inactive": false
  }'

Over MCP the same operation is the tool booking_list_event_types at https://app.chirply.io/api/mcp, same bearer token, same input.

List the saved weekly availability schedules in this account — for each: its name, whether it is the owner's default, the timezone it is interpreted in, and the full set of working hours keyed by weekday (sun–sat), each day a list of "HH:MM"–"HH:MM" windows. Read this BEFORE calling booking.set_availability: that capability REPLACES the whole week, so editing Tuesday without first reading Monday through Sunday would wipe them. By default you get the calling user's own schedules, which is exactly what the My availability screen shows; an API key with no user attached sees the whole account. Read-only.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/booking.list_schedules \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "owner_user_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11",
    "all_users": false
  }'

Over MCP the same operation is the tool booking_list_schedules at https://app.chirply.io/api/mcp, same bearer token, same input.

Read connected Zoom host emails and connection errors for scheduling. Returns only the caller's connection for signed-in users, or all hosts for an account API key. Never returns credentials, tokens, or host-only meeting URLs. Changes nothing and creates no meetings.

Parameters

No parameters — POST an empty body.

Example

curl -X POST https://app.chirply.io/api/v1/actions/booking.list_zoom_connections \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{}'

Over MCP the same operation is the tool booking_list_zoom_connections at https://app.chirply.io/api/mcp, same bearer token, same input.

Moves a booked appointment to a new time: the new slot is re-validated against live availability, a fresh appointment is created linked to the old one (reschedule_of) with its payment record carried over, the old one is canceled, and the invitee is emailed/texted the new time from the organization's own Mailgun/Twilio — the customer is always notified, never silently moved. Fires 'appointment rescheduled' automations. Owners and admins only. Provide the new start exactly as one of the ISO UTC starts returned by booking.get_availability, or set allow_outside_availability to book a time the engine wouldn't offer (the host still can't be double-booked). Refuses if the new slot is no longer open, or if the appointment was canceled or has already started.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/booking.reschedule_appointment \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "appointment_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11",
    "new_start": "2026-09-17T15:00:00Z"
  }'

Over MCP the same operation is the tool booking_reschedule_appointment at https://app.chirply.io/api/mcp, same bearer token, same input.

Connect your own Zoom Server-to-Server OAuth app to the calling host. Verifies account access, encrypts credentials at rest, and replaces any existing Zoom connection for that host. Allows opted-in event types to create real Zoom meetings automatically under that account's plan. No meeting is created by this action and secrets are never returned. API key callers must supply a host user ID in this account.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/booking.save_zoom_credentials \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "account_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11",
    "client_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11",
    "client_secret": "example",
    "host_email": "ada@example.com"
  }'

Over MCP the same operation is the tool booking_save_zoom_credentials at https://app.chirply.io/api/mcp, same bearer token, same input.

Record how an appointment actually went — 'completed' if it happened, 'no_show' if the invitee never turned up, or 'confirmed' to put it back the way it was. This is a PRIVATE record change: it sends the invitee nothing, changes no times, fires no automations, refunds nothing, and does not free the slot. It is the app's 'Mark completed' / 'Mark no-show' / 'Back to confirmed' menu. To actually call the meeting off and tell the invitee, use booking.cancel_appointment instead. Owners and admins only.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/booking.set_appointment_status \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "appointment_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11",
    "status": "completed"
  }'

Over MCP the same operation is the tool booking_set_appointment_status at https://app.chirply.io/api/mcp, same bearer token, same input.

Set YOUR OWN weekly booking availability — the recurring working hours the slot engine offers to invitees for events you host, interpreted in the account timezone from Business profile. Replaces your existing weekly hours (does not touch teammates' schedules or one-off date overrides). Personal to the calling user; API keys act as the user that issued them.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/booking.set_availability \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "hours": {}
  }'

Over MCP the same operation is the tool booking_set_availability at https://app.chirply.io/api/mcp, same bearer token, same input.

Changes the public hostname used in an event type's booking links and appointment-management links. Only active website/app domains connected to this account are allowed. Null restores the account default. Existing booking URLs remain available. Does not modify DNS, replace the domain's website, send messages, or spend money.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/booking.set_domain \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "event_type_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11",
    "domain_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool booking_set_domain at https://app.chirply.io/api/mcp, same bearer token, same input.

Turn an event type's PUBLIC booking page on or off. Switching it off takes the page down for everyone holding the link — nobody can book that meeting any more — without deleting the event type or any appointment already on the calendar; switching it back on republishes it instantly and strangers can book real time again. Owners and admins only.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/booking.set_event_type_active \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "event_type_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool booking_set_event_type_active at https://app.chirply.io/api/mcp, same bearer token, same input.

Change the configuration of an existing bookable event type. Only the fields you pass are changed; everything omitted is left exactly as it was. Existing appointments already on the calendar are NOT moved or re-priced — changes apply to future bookings. Changing duration, buffers, notice or hosts changes which times the public booking page offers from that moment on. Owners and admins only. Passing `questions`, `reminders` or `host_user_ids` REPLACES that whole list, so read the current one with booking.get_event_type first. To show or hide the public booking page, use booking.set_event_type_active — this capability deliberately cannot.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/booking.update_event_type \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "event_type_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool booking_update_event_type at https://app.chirply.io/api/mcp, same bearer token, same input.