Skip to main content
POST
Create a booking

Authorizations

Authorization
string
header
required

API key (fam_..., created under Settings → API Keys) or an OAuth 2.0 access token (fam_at_...). REST operations also require API Access for the credential's workspace. Keys can be restricted to scopes such as assistants:read, calls:write, campaigns:write, automations:read, dashboards:read, dashboards:write, leads:write, segments:write, loop:read, loop:write, phone_numbers:write, sip_trunks:write, knowledge:write, voices:read, billing:read, billing:write, settings:write, platform:read, platform:write; a *:write scope implies the matching *:read. Automation and dashboard endpoints also accept the legacy calls:* scope. Keys without scope restrictions have full access within the workspace's available capabilities.

Body

application/json
event_type_id
string<uuid>
required

Event type ID.

start
string<date-time>
required

Start time in ISO 8601 UTC — must be a value returned by List free slots, unless allow_outside_availability is set.

name
string
required

Invitee name.

Required string length: 1 - 128
email
string

Invitee email — required when the event type requires it (e.g. a Google Meet/Teams location).

phone
string

International format, e.g. +4915123456789. Required when the event type requires it.

notes
string

Notes attached to the booking.

Maximum string length: 2000
answers
object

Answers to the event type's custom booking questions, keyed by BookingField.id.

timezone
string

IANA time zone used for the invitee's confirmation email and calendar invite; does not affect how start is parsed. Default the workspace time zone.

hour_cycle
enum<string>

Time format used in the invitee's confirmation email; default 24h.

Available options:
12h,
24h
allow_outside_availability
boolean
default:false

Set true to book outside the event type's open times (staff override). Any future time within the next 2 years is accepted; the time must not overlap another confirmed booking of the same event type. Guests on the public booking page only ever see open times.

Response

The created booking.

data
object
required