Required fields may vary based on the event type's configuration.
Before creating an event, verify availability using the availability endpoint.
Validate any required custom fields (guests, phone, questions) by checking the event type's settings first.
date
string<date>
required
The event date in YYYY-MM-DD format.
name
string
required
Invitee's full name.
email
string<email>
required
Invitee's email address.
timeZone
string
required
Invitee's IANA timezone identifier.
Example:
"Europe/Paris"
start
string<time>
required
Start time in HH:mm format (in the specified timeZone).
Example:
"09:00"
eventTypeId
string
The scheduling page's id, as GET /event-types returns it. Replaces ownerSlug, eventTypeSlug and sharedLink.
ownerSlug
string
The slug of the scheduling page owner, can be a user or a team. Required with eventTypeSlug unless eventTypeId or sharedLink is sent.
eventTypeSlug
string
The slug of the scheduling page.
duration
integer
Optional. Meeting duration in minutes, one of the durations the scheduling page offers. When omitted, or when the page does not offer it, the booking takes the page's default duration.
phone
string
Invitee's phone number (required for "PHONE_CALL" location type).
guests
string<email>[]
Array of additional guest email addresses.
location
string
The location type the invitee books. If the scheduling page offers one or more locations, this field is required, and the request fails with 422 when it is absent. If the scheduling page offers no location, omit it.
Send the type the scheduling page is configured with. A type the page does not offer fails with 422.
Accepted values:
"IN_PERSON": Physical in-person meeting (requires locationOptions with address and details).
"PHONE_CALL": Phone call meeting (requires locationOptions.callType and phone field).
"CUSTOM": Free-text location. The scheduling page holds the text, so send no locationOptions.
"GOOGLE_MEET", "MICROSOFT_TEAMS", "MICROSOFT_SKYPE", "ZOOM", "WEBEX", "DEMODESK", "ALFAVIEW", "WHATSAPP", "WHEREBY", "JITSI": The scheduling page holds the account or the link, so send no locationOptions.
locationOptions
object
Additional location details, required for certain location types:
For in-person meetings (location: "IN_PERSON"): provide address and details.
For phone call meetings (location: "PHONE_CALL"): provide callType (e.g. "I_WILL_CALL").
Hide child attributes
locationOptions.address
string
locationOptions.details
string
locationOptions.callType
string
locationKey
string
Optional. The per-location stable key from the scheduling page's location resource (key field, e.g. loc_42, or room_<resourceId> for a room). Pins the exact location row when the scheduling page offers several locations of the same type; recommended whenever it is available, and the only reliable way to target a specific same-type location on a paid scheduling page (where paid option values are withheld until payment).
Example:
"loc_42"
question_answers
object[]
Array of question-answer pairs for custom invitee questions configured on the scheduling page.
Hide child attributes
question_answers.question_id
integer
The numeric ID of the question (obtain from scheduling page settings).
question_answers.answer
stringstring[]
The answer to the question. A string for single-answer questions, or an array of strings for multi-select questions.
customQueryParams
object
Custom URL parameters to pass through.
utm
object
UTM tracking parameters.
Hide child attributes
utm.utm_campaign
string
utm.utm_source
string
utm.utm_medium
string
utm.utm_content
string
utm.utm_term
string
sharedLink
string
The shared link token, required when booking via a shared or collective scheduling link.
hostEmail
string<email>
Round Robin only. Books the event with this host instead of the one Round Robin would pick. The host must be one of the scheduling page's hosts and free at the requested time. An email that is not a host of the page returns 404; a host who is busy returns 400; a host who has reached their booking limit for the day returns 422. overrideLevel books such a host anyway, as far as the level allows. Ignored for other scheduling page types.
Example:
"marco.rossi@horizondigital.de"
hostSlug
string
Round Robin only. The host's slug, as an alternative to hostEmail. When both are sent, hostEmail wins.
overrideLevel
enum<integer>
Books a time the scheduling page does not offer, as far as the level allows. Use it for a booking a team member makes, never for an invitee choosing a time.
1: only the times the scheduling page offers, plus a start off its time grid that falls inside them.
2: also times the scheduling page's settings block: working hours, buffers, minimum notice, booking limits, the booking window and time off.
3: also times an entry in a host's connected calendar blocks.
4: no availability check on the host: also books on top of the host's other Zeeg bookings, so the host is double-booked.
No level books a time in the past, in a busy room, or a group event without enough free seats. A refused time returns 400 with data.blockedReason naming what blocks it, for example calendar when level 3 would open it. Needs a token whose user may edit the scheduling page; otherwise the request returns 403. Works for One-on-One, Group, Round Robin and Collective scheduling pages; with hostEmail, a Round Robin booking goes to that host, otherwise to the host the time is least blocked for.
Available options:
1,
2,
3,
4
Example:
2
Response
OK
A scheduled event resource. This is the single canonical shape returned by all scheduled-event endpoints and embedded in the AI agent call webhook payload.
uri
string<uri>
required
Public API URI of the scheduled event resource.
uuid
string
required
Zeeg event identifier (zg-XXX format)
Example:
"zg-O69bac566950c6"
title
string
required
Title of the scheduled event.
type
string
required
Event type kind (e.g. ONE_ON_ONE, GROUP, ROUND_ROBIN).
startTime
string<date-time>
required
ISO 8601 UTC start time of the booked event.
endTime
string<date-time>
required
ISO 8601 UTC end time of the booked event.
duration
integer
required
Event duration in minutes.
status
string
required
Booking status (e.g. confirmed, cancelled).
eventTypeUri
string<uri>
required
Public API URI of the event type this booking was made against.
maxActiveInvitees
integer
required
Maximum number of active invitees the event allows.
activeInviteesCount
integer
required
Current number of active (non-cancelled) invitees.
invitees
object[]
required
Invitees booked on the scheduled event.
Hide child attributes
invitees.fullName
string | null
required
Full name of the invitee.
invitees.email
string<email> | null
required
Email address of the invitee.
invitees.timeZone
string | null
required
IANA time zone of the invitee.
invitees.noShow
boolean
required
Whether the invitee has been marked as a no-show. Always present.
invitees.scheduledAt
string<date-time> | null
required
ISO 8601 UTC timestamp when the invitee booked.
invitees.uuid
string
Zeeg attendee identifier (zg-XXX format)
Example:
"zg-O69bac566950c6"
invitees.salutation
string | null
Salutation for the invitee, if collected.
invitees.guests
string[]
Email addresses of additional guests the invitee added. An empty array when the invitee added none.
invitees.cancellation
object
Cancellation details. All fields are null when the invitee is not cancelled.
Hide child attributes
invitees.cancellation.cancelledAt
string<date-time> | null
ISO 8601 UTC timestamp when the invitee was cancelled.
invitees.cancellation.cancelledBy
string | null
Identifier of who cancelled the booking.
invitees.cancellation.cancellerType
string | null
Type of canceller (e.g. host, invitee).
invitees.cancellation.cancellationReason
string | null
Reason given for the cancellation.
invitees.payment
object | null
Payment details for the booking, or null when no payment applies.
Hide child attributes
invitees.payment.gateway
string
Payment provider, e.g. stripe or paypal.
invitees.payment.price
number
invitees.payment.currency
string
invitees.payment.transactionId
string | null
invitees.payment.createdAt
string<date-time>
invitees.payment.status
enum<string>
pending until the transaction completes.
Available options:
pending,
success
invitees.noShowAt
string<date-time> | null
ISO 8601 UTC timestamp when the invitee was marked as a no-show, or null when they were not.
invitees.utm
object
UTM tracking parameters captured at booking time. Always holds these five keys, in snake_case; a key holds null when the booking did not carry a value for it.
Hide child attributes
invitees.utm.utm_campaign
string | null
required
invitees.utm.utm_source
string | null
required
invitees.utm.utm_medium
string | null
required
invitees.utm.utm_content
string | null
required
invitees.utm.utm_term
string | null
required
invitees.adAttribution
object | null
Ad-click identifiers captured at booking time, keyed by provider. Only the keys that were actually captured are present; null when none were captured.
Hide child attributes
invitees.adAttribution.gclid
string | null
Google Ads click ID.
invitees.adAttribution.gbraid
string | null
Google click ID for iOS app-to-web clicks. Mutually exclusive with gclid per click.
invitees.adAttribution.wbraid
string | null
Google click ID for web-to-app clicks. Mutually exclusive with gclid per click.
invitees.adAttribution.fbclid
string | null
Meta click ID.
invitees.adAttribution.fbp
string | null
Meta browser ID cookie (_fbp) captured at booking time.
invitees.adAttribution.fbc
string | null
Meta click cookie (_fbc) captured at booking time.
invitees.adAttribution.landingUrl
string | null
Full URL of the host page the booking widget was embedded on.
invitees.customQueryParams
object
Custom query parameters captured at booking time, keyed by the c__-prefixed parameter name. An empty object when the booking captured none.
Example:
{ "c__ref": "nl-2026-04" }
invitees.questions
object[] | null
Booking questions answered by the invitee.
Hide child attributes
invitees.questions.answer
string
invitees.questions.answer_type
string
invitees.questions.question
string
invitees.agentBookingReference
string | null
Reference code for bookings made via the AI agent; null otherwise.
invitees.cancelUrl
string<uri> | null
Public URL the invitee uses to cancel this booking. null once the booking is cancelled.
invitees.rescheduleUrl
string<uri> | null
Public URL the invitee uses to reschedule this booking. null once the booking is cancelled.
invitees.rescheduled
boolean
True once this booking has been superseded by a reschedule. A rescheduled booking reports status: cancelled for backward compatibility; rescheduled and nextRescheduling are how a caller tells a reschedule apart from an actual cancellation.
invitees.rescheduling
object | null
Present when this booking is the result of a reschedule. null when this booking was not itself created by rescheduling an earlier one.
Hide child attributes
invitees.rescheduling.oldStartAt
string<date-time> | null
ISO 8601 UTC start time the previous booking held before the reschedule.
invitees.rescheduling.newStartAt
string<date-time> | null
ISO 8601 UTC start time the new booking was moved to.
invitees.rescheduling.rescheduledAt
string<date-time>
ISO 8601 UTC timestamp when the reschedule was performed.
invitees.rescheduling.previousEventUuid
string | null
uuid of the superseded booking (zg-XXX format). Use it directly as the uuid path parameter of GET /scheduled-events/{uuid} to fetch that booking.
Example:
"zg-O69bad4047abf0"
invitees.rescheduling.previousInviteeUuid
string | null
uuid of the invitee on the superseded booking. No public endpoint accepts an invitee uuid as a path parameter.
Example:
"zg-O69bac566950c6"
invitees.rescheduling.reason
string | null
Reason given for the reschedule, if any.
invitees.rescheduling.rescheduledBy
string | null
Who performed the reschedule (e.g. host, invitee).
invitees.rescheduling.reschedulerFullName
string | null
Full name of the person who performed the reschedule, when known.
invitees.nextRescheduling
object | null
Present when this booking has been superseded by a later reschedule. null when the booking has not been rescheduled.
Hide child attributes
invitees.nextRescheduling.oldStartAt
string<date-time> | null
ISO 8601 UTC start time the previous booking held before the reschedule.
invitees.nextRescheduling.newStartAt
string<date-time> | null
ISO 8601 UTC start time the new booking was moved to.
invitees.nextRescheduling.rescheduledAt
string<date-time>
ISO 8601 UTC timestamp when the reschedule was performed.
invitees.nextRescheduling.previousEventUuid
string | null
uuid of the superseded booking (zg-XXX format). Use it directly as the uuid path parameter of GET /scheduled-events/{uuid} to fetch that booking.
Example:
"zg-O69bad4047abf0"
invitees.nextRescheduling.previousInviteeUuid
string | null
uuid of the invitee on the superseded booking. No public endpoint accepts an invitee uuid as a path parameter.
Example:
"zg-O69bac566950c6"
invitees.nextRescheduling.reason
string | null
Reason given for the reschedule, if any.
invitees.nextRescheduling.rescheduledBy
string | null
Who performed the reschedule (e.g. host, invitee).
invitees.nextRescheduling.reschedulerFullName
string | null
Full name of the person who performed the reschedule, when known.
teamName
string | null
required
Name of the team that owns the scheduling page the booking was made on, or null for a personal scheduling page. The key is always present. This is the same value the invitee.scheduled webhook sends as teamName for the same booking.
Example:
"Sales"
createdAt
string<date-time>
required
ISO 8601 UTC timestamp when the booking was created.
location
object | null
Meeting location for the booking.
Hide child attributes
location.type
string
required
Location type (e.g. google_meet, zoom, phone, in_person).
location.joinUrl
string<uri> | null
Join URL for the meeting, when applicable.
guests
string[]
Email addresses of additional guests added across all invitees. An empty array when none were added.
hosts
object[] | null
Hosts assigned to the scheduled event.
Hide child attributes
hosts.firstName
string | null
required
Host's first name.
hosts.email
string<email> | null
required
Host's email address.
hosts.slug
string | null
required
Host's public profile slug.
hosts.url
string<uri>
required
Host's public profile URL.
hosts.lastName
string
Host's last name. Empty string when not set.
hosts.avatarUrl
string<uri> | null
URL of the host's avatar image, if set.
updatedAt
string<date-time>
ISO 8601 UTC timestamp when the booking was last updated.
{"docsConfig":{"theme":"luma","$schema":"https://mintlify.com/docs.json","name":"Zeeg Developer Hub","description":"Zeeg Developer Hub: REST API reference, guides, and webhooks for building scheduling, booking, and AI-agent integrations on the Zeeg platform.","colors":{"primary":"#6C63FF","light":"#8B83FF","dark":"#4F46E5"},"logo":"https://mintcdn.com/zeeg/9voKLLkajreclhp4/images/Zeeglogo(Original).svg?fit=max\u0026auto=format\u0026n=9voKLLkajreclhp4\u0026q=85\u0026s=321632804eda4b3cff044941f9ccadda","favicon":"https://mintcdn.com/zeeg/9voKLLkajreclhp4/images/favicon.ico?fit=max\u0026auto=format\u0026n=9voKLLkajreclhp4\u0026q=85\u0026s=ee885974552f141091cdd615c5c15345","api":{"openapi":"openapi.yaml","params":{"expanded":"all"},"playground":{"display":"interactive","proxy":false},"examples":{"defaults":"required"},"mdx":{"auth":{"method":"bearer"},"server":"https://api.zeeg.me/v2"}},"appearance":{"default":"system"},"background":{"decoration":"gradient","color":{"dark":"#0f1117"}},"navbar":{"links":[{"href":"https://app.zeeg.me","label":"Dashboard"}],"primary":{"type":"button","label":"Get API Key","href":"https://app.zeeg.me/account/settings/api-access"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/zeeg","x":"https://www.twitter.com/zeeg_me","youtube":"https://www.youtube.com/@zeeg_me","instagram":"https://www.instagram.com/zeeg.me"},"links":[{"header":"Product","items":[{"label":"Pricing","href":"https://zeeg.me/en/pricing"},{"label":"Help Center","href":"https://zeeg.me/en/help"},{"label":"System Status","href":"https://status.zeeg.me"}]},{"header":"Legal","items":[{"label":"Terms of Service","href":"https://zeeg.me/en/legal/terms"},{"label":"Privacy Policy","href":"https://zeeg.me/en/legal/privacy"},{"label":"Imprint","href":"https://zeeg.me/en/legal/imprint"}]}]},"search":{"prompt":"Search endpoints, guides, and more..."},"seo":{"metatags":{"og:site_name":"Zeeg Developer Hub","og:type":"website","og:locale":"en_US","og:url":"https://developer.zeeg.me","twitter:card":"summary_large_image","twitter:site":"@zeeg_me","author":"Zeeg","robots":"index, follow","googlebot":"index, follow"},"indexing":"all"},"fonts":{"family":"Inter"},"icons":{"library":"fontawesome"},"styling":{"eyebrows":"section","latex":false},"integrations":{"gtm":{"tagId":"GTM-5XJGGJP"}},"errors":{"404":{"redirect":false,"title":"Page not found","description":"The page you're looking for doesn't exist. Try the [API Reference](/api/workspaces-teams/check-logged-in-user) or [Quickstart](/quickstart)."}},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"interaction":{"drilldown":true},"metadata":{"timestamp":true},"markdown":{"schema":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"zeeg","hasAudioNarration":false,"actualSubdomain":"zeeg","customDomains":["developer.zeeg.me"],"gitSource":{"type":"github","owner":"zeeg","repo":"api-docs","deployBranch":"master","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6af74cc3bc8b11b040099d92","clientVersion":"0.0.4131","searchFilterCounts":[{"language":"default","tag":"API Reference","count":208},{"language":"default","tag":"CRM","count":27},{"language":"default","tag":"Availability Schedule","count":15},{"language":"default","tag":"Scheduling Pages","count":15},{"language":"default","tag":"Guides","count":14},{"language":"default","tag":"Routing Forms","count":12},{"language":"default","tag":"Workspaces \u0026 Teams","count":12},{"language":"default","tag":"Forms","count":8},{"language":"default","tag":"Documentation","count":8},{"language":"default","tag":"Objects","count":7}],"searchSettings":{"maxResults":10}},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api/scheduling-pages/create-an-event","slug":"/api/scheduling-pages/create-an-event","pageMetadata":{"title":"Create an Event","description":"Programmatically book a scheduled event on a Zeeg scheduling page by providing an invitee, a chosen time slot, and any required custom answers.","openapi":"POST /event","href":"/api/scheduling-pages/create-an-event"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Programmatically book a scheduled event on a Zeeg scheduling page by providing an invitee, a chosen time slot, and any required custom answers.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create an Event","description":"Programmatically book a scheduled event on a Zeeg scheduling page by providing an invitee, a chosen time slot, and any required custom answers.","openapi":"POST /event","href":"/api/scheduling-pages/create-an-event"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Create an event","tags":["Scheduling Pages"],"operationId":"post-event","description":"Programmatically book a scheduled event on a Zeeg scheduling page by providing an invitee, a chosen time slot, and any required custom answers.","security":["bab93ec9-8b9f-4734-958d-60c7afbc85a3"],"requestBody":"115635e2-4610-4793-b112-623aa115eb8f","responses":{"200":"ee0e0706-30d5-456f-a598-67248d90a84d","400":"02f8af1a-2348-4a0e-89bc-e0c6e09fc1ab","401":"19d2dd24-0d76-4c56-ada1-82f5b576f4d4","403":"ca892cdf-7938-4a26-a1f6-02936c2ff96a","404":"07380dc3-7cc0-4533-a644-437aecd33604","422":"0620395e-7515-4d26-9f9b-aeb81fd02f8d"},"method":"post","type":"path","servers":["ee2a58d5-385b-4901-a1cd-b8b0b78a60fc"],"path":"/event","baseUrlOptions":["https://api.zeeg.me/v2"],"title":"Create an event","codeSamples":[],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated","disableProxy":true},"dependencies":{"parameters":{},"requestBody":{"description":"- Required fields may vary based on the event type's configuration.\n- Before creating an event, verify availability using the availability endpoint.\n- Validate any required custom fields (guests, phone, questions) by checking the event type's settings first.","content":{"application/json":{"schema":{"type":"object","required":["date","name","email","timeZone","start"],"properties":{"date":{"type":"string","format":"date","description":"The event date in YYYY-MM-DD format.","isRequired":true,"uniqueKey":"date","typeLabel":"string\u003cdate>"},"name":{"type":"string","description":"Invitee's full name.","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"email":{"type":"string","format":"email","description":"Invitee's email address.","isRequired":true,"uniqueKey":"email","typeLabel":"string\u003cemail>"},"timeZone":{"type":"string","description":"Invitee's IANA timezone identifier.","example":"Europe/Paris","isRequired":true,"uniqueKey":"timeZone","typeLabel":"string"},"start":{"type":"string","format":"time","description":"Start time in HH:mm format (in the specified `timeZone`).","example":"09:00","isRequired":true,"uniqueKey":"start","typeLabel":"string\u003ctime>"},"eventTypeId":{"type":"string","description":"The scheduling page's id, as `GET /event-types` returns it. Replaces `ownerSlug`, `eventTypeSlug` and `sharedLink`.","uniqueKey":"eventTypeId","typeLabel":"string"},"ownerSlug":{"type":"string","description":"The slug of the scheduling page owner, can be a user or a team. Required with `eventTypeSlug` unless `eventTypeId` or `sharedLink` is sent.","uniqueKey":"ownerSlug","typeLabel":"string"},"eventTypeSlug":{"type":"string","description":"The slug of the scheduling page.","uniqueKey":"eventTypeSlug","typeLabel":"string"},"duration":{"type":"integer","description":"Optional. Meeting duration in minutes, one of the durations the scheduling page offers. When omitted, or when the page does not offer it, the booking takes the page's default duration.","uniqueKey":"duration","typeLabel":"integer"},"phone":{"type":"string","description":"Invitee's phone number (required for `\"PHONE_CALL\"` location type).","uniqueKey":"phone","typeLabel":"string"},"guests":{"type":"array","description":"Array of additional guest email addresses.","items":{"type":"string","format":"email","uniqueKey":"guests.items.[INDEX]","typeLabel":"string\u003cemail>"},"uniqueKey":"guests","typeLabel":"string\u003cemail>[]"},"location":{"type":"string","description":"The location type the invitee books. If the scheduling page offers one or more locations, this field is required, and the request fails with `422` when it is absent. If the scheduling page offers no location, omit it.\nSend the type the scheduling page is configured with. A type the page does not offer fails with `422`.\nAccepted values:\n- `\"IN_PERSON\"`: Physical in-person meeting (requires `locationOptions` with address and details).\n- `\"PHONE_CALL\"`: Phone call meeting (requires `locationOptions.callType` and `phone` field).\n- `\"CUSTOM\"`: Free-text location. The scheduling page holds the text, so send no `locationOptions`.\n- `\"GOOGLE_MEET\"`, `\"MICROSOFT_TEAMS\"`, `\"MICROSOFT_SKYPE\"`, `\"ZOOM\"`, `\"WEBEX\"`, `\"DEMODESK\"`, `\"ALFAVIEW\"`, `\"WHATSAPP\"`, `\"WHEREBY\"`, `\"JITSI\"`: The scheduling page holds the account or the link, so send no `locationOptions`.","uniqueKey":"location","typeLabel":"string"},"locationOptions":{"type":"object","description":"Additional location details, required for certain location types:\n- For in-person meetings (`location: \"IN_PERSON\"`): provide `address` and `details`.\n- For phone call meetings (`location: \"PHONE_CALL\"`): provide `callType` (e.g. `\"I_WILL_CALL\"`).","properties":{"address":{"type":"string","uniqueKey":"locationOptions.address","typeLabel":"string"},"details":{"type":"string","uniqueKey":"locationOptions.details","typeLabel":"string"},"callType":{"type":"string","uniqueKey":"locationOptions.callType","typeLabel":"string"}},"uniqueKey":"locationOptions","typeLabel":"object"},"locationKey":{"type":"string","example":"loc_42","description":"Optional. The per-location stable key from the scheduling page's location resource (`key` field, e.g. `loc_42`, or `room_\u003cresourceId>` for a room). Pins the exact location row when the scheduling page offers several locations of the same type; recommended whenever it is available, and the only reliable way to target a specific same-type location on a paid scheduling page (where paid option values are withheld until payment).","uniqueKey":"locationKey","typeLabel":"string"},"question_answers":{"type":"array","description":"Array of question-answer pairs for custom invitee questions configured on the scheduling page.","items":{"type":"object","properties":{"question_id":{"type":"integer","description":"The numeric ID of the question (obtain from scheduling page settings).","uniqueKey":"question_answers.items.[INDEX].question_id","typeLabel":"integer"},"answer":{"oneOf":[{"type":"string","description":"The answer to the question. A string for single-answer questions, or an array of strings for multi-select questions.","uniqueKey":"question_answers.items.[INDEX].answer.oneOf.0","typeLabel":"string"},{"type":"array","items":{"type":"string","uniqueKey":"question_answers.items.[INDEX].answer.oneOf.1.items.[INDEX]","typeLabel":"string"},"description":"The answer to the question. A string for single-answer questions, or an array of strings for multi-select questions.","uniqueKey":"question_answers.items.[INDEX].answer.oneOf.1","typeLabel":"string[]"}],"uniqueKey":"question_answers.items.[INDEX].answer","typeLabel":"string | string[]"}},"uniqueKey":"question_answers.items.[INDEX]","typeLabel":"object"},"uniqueKey":"question_answers","typeLabel":"object[]"},"customQueryParams":{"type":"object","description":"Custom URL parameters to pass through.","uniqueKey":"customQueryParams","typeLabel":"object"},"utm":{"type":"object","description":"UTM tracking parameters.","properties":{"utm_campaign":{"type":"string","uniqueKey":"utm.utm_campaign","typeLabel":"string"},"utm_source":{"type":"string","uniqueKey":"utm.utm_source","typeLabel":"string"},"utm_medium":{"type":"string","uniqueKey":"utm.utm_medium","typeLabel":"string"},"utm_content":{"type":"string","uniqueKey":"utm.utm_content","typeLabel":"string"},"utm_term":{"type":"string","uniqueKey":"utm.utm_term","typeLabel":"string"}},"uniqueKey":"utm","typeLabel":"object"},"sharedLink":{"type":"string","description":"The shared link token, required when booking via a shared or collective scheduling link.","uniqueKey":"sharedLink","typeLabel":"string"},"hostEmail":{"type":"string","format":"email","description":"Round Robin only. Books the event with this host instead of the one Round Robin would pick. The host must be one of the scheduling page's hosts and free at the requested time. An email that is not a host of the page returns `404`; a host who is busy returns `400`; a host who has reached their booking limit for the day returns `422`. `overrideLevel` books such a host anyway, as far as the level allows. Ignored for other scheduling page types.","example":"marco.rossi@horizondigital.de","uniqueKey":"hostEmail","typeLabel":"string\u003cemail>"},"hostSlug":{"type":"string","description":"Round Robin only. The host's slug, as an alternative to `hostEmail`. When both are sent, `hostEmail` wins.","uniqueKey":"hostSlug","typeLabel":"string"},"overrideLevel":{"type":"integer","enum":[1,2,3,4],"description":"Books a time the scheduling page does not offer, as far as the level allows. Use it for a booking a team member makes, never for an invitee choosing a time.\n- `1`: only the times the scheduling page offers, plus a start off its time grid that falls inside them.\n- `2`: also times the scheduling page's settings block: working hours, buffers, minimum notice, booking limits, the booking window and time off.\n- `3`: also times an entry in a host's connected calendar blocks.\n- `4`: no availability check on the host: also books on top of the host's other Zeeg bookings, so the host is double-booked.\n\nNo level books a time in the past, in a busy room, or a group event without enough free seats. A refused time returns `400` with `data.blockedReason` naming what blocks it, for example `calendar` when level `3` would open it. Needs a token whose user may edit the scheduling page; otherwise the request returns `403`. Works for One-on-One, Group, Round Robin and Collective scheduling pages; with `hostEmail`, a Round Robin booking goes to that host, otherwise to the host the time is least blocked for.","example":2,"uniqueKey":"overrideLevel","typeLabel":"enum\u003cinteger>"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Round Robin booking with a chosen host":{"title":"Round Robin booking with a chosen host","value":{"eventTypeId":"80f46bf5-eb01-4c07-960e-a9a3e18aae5e","date":"2026-04-15","start":"09:00","name":"Sophie Laurent","email":"sophie.laurent@northwind.io","timeZone":"Europe/Paris","hostEmail":"marco.rossi@horizondigital.de"}},"Booking with question answers":{"title":"Booking with question answers","value":{"ownerSlug":"lena-meier","eventTypeSlug":"30min-discovery-call","date":"2026-04-15","duration":30,"name":"Sophie Laurent","email":"sophie.laurent@northwind.io","guests":["alex.chen@northwind.io"],"location":"GOOGLE_MEET","timeZone":"Europe/Paris","start":"09:00","question_answers":[{"question_id":1,"answer":"Product demo and pricing options"}],"customQueryParams":{},"utm":{"utm_campaign":"spring_launch","utm_source":"linkedin","utm_medium":"social"}}},"In-person meeting":{"title":"In-person meeting","value":{"ownerSlug":"lena-meier","eventTypeSlug":"product-demo","date":"2026-04-20","start":"14:30","location":"IN_PERSON","locationOptions":{"address":"Horizon Digital GmbH Office","details":"Reception on the 3rd floor, ask for Lena."},"duration":60,"name":"Sophie Laurent","email":"sophie.laurent@northwind.io","phone":"+49 170 9876543","timeZone":"Europe/Paris"}},"Phone call meeting":{"title":"Phone call meeting","value":{"ownerSlug":"lena-meier","eventTypeSlug":"30min-discovery-call","date":"2026-04-22","start":"10:00","location":"PHONE_CALL","locationOptions":{"callType":"I_WILL_CALL"},"phone":"+49 170 9876543","duration":30,"name":"Sophie Laurent","email":"sophie.laurent@northwind.io","timeZone":"Europe/Paris"}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"ee0e0706-30d5-456f-a598-67248d90a84d":{"description":"OK","content":{"application/json":{"schema":{"type":"object","required":["uri","uuid","title","type","startTime","endTime","duration","status","eventTypeUri","maxActiveInvitees","activeInviteesCount","invitees","teamName","createdAt"],"properties":{"uri":{"type":"string","format":"uri","description":"Public API URI of the scheduled event resource.","isRequired":true,"uniqueKey":"uri","typeLabel":"string\u003curi>"},"uuid":{"type":"string","description":"Zeeg event identifier (zg-XXX format)","example":"zg-O69bac566950c6","isRequired":true,"uniqueKey":"uuid","typeLabel":"string"},"title":{"type":"string","description":"Title of the scheduled event.","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"type":{"type":"string","description":"Event type kind (e.g. `ONE_ON_ONE`, `GROUP`, `ROUND_ROBIN`).","isRequired":true,"uniqueKey":"type","typeLabel":"string"},"startTime":{"type":"string","format":"date-time","description":"ISO 8601 UTC start time of the booked event.","isRequired":true,"uniqueKey":"startTime","typeLabel":"string\u003cdate-time>"},"endTime":{"type":"string","format":"date-time","description":"ISO 8601 UTC end time of the booked event.","isRequired":true,"uniqueKey":"endTime","typeLabel":"string\u003cdate-time>"},"duration":{"type":"integer","description":"Event duration in minutes.","isRequired":true,"uniqueKey":"duration","typeLabel":"integer"},"status":{"type":"string","description":"Booking status (e.g. `confirmed`, `cancelled`).","isRequired":true,"uniqueKey":"status","typeLabel":"string"},"eventTypeUri":{"type":"string","format":"uri","description":"Public API URI of the event type this booking was made against.","isRequired":true,"uniqueKey":"eventTypeUri","typeLabel":"string\u003curi>"},"maxActiveInvitees":{"type":"integer","description":"Maximum number of active invitees the event allows.","isRequired":true,"uniqueKey":"maxActiveInvitees","typeLabel":"integer"},"activeInviteesCount":{"type":"integer","description":"Current number of active (non-cancelled) invitees.","isRequired":true,"uniqueKey":"activeInviteesCount","typeLabel":"integer"},"invitees":{"type":"array","items":{"type":"object","required":["fullName","email","timeZone","scheduledAt","noShow"],"properties":{"fullName":{"oneOf":[{"type":"string","description":"Full name of the invitee.","isRequired":true,"uniqueKey":"invitees.items.[INDEX].fullName.oneOf.0","typeLabel":"string"},{"type":"null","description":"Full name of the invitee.","isRequired":true,"uniqueKey":"invitees.items.[INDEX].fullName.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"invitees.items.[INDEX].fullName","typeLabel":"string | null"},"email":{"oneOf":[{"type":"string","format":"email","description":"Email address of the invitee.","isRequired":true,"uniqueKey":"invitees.items.[INDEX].email.oneOf.0","typeLabel":"string\u003cemail>"},{"type":"null","format":"email","description":"Email address of the invitee.","isRequired":true,"uniqueKey":"invitees.items.[INDEX].email.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"invitees.items.[INDEX].email","typeLabel":"string\u003cemail> | null"},"timeZone":{"oneOf":[{"type":"string","description":"IANA time zone of the invitee.","isRequired":true,"uniqueKey":"invitees.items.[INDEX].timeZone.oneOf.0","typeLabel":"string"},{"type":"null","description":"IANA time zone of the invitee.","isRequired":true,"uniqueKey":"invitees.items.[INDEX].timeZone.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"invitees.items.[INDEX].timeZone","typeLabel":"string | null"},"noShow":{"type":"boolean","description":"Whether the invitee has been marked as a no-show. Always present.","isRequired":true,"uniqueKey":"invitees.items.[INDEX].noShow","typeLabel":"boolean"},"scheduledAt":{"oneOf":[{"type":"string","format":"date-time","description":"ISO 8601 UTC timestamp when the invitee booked.","isRequired":true,"uniqueKey":"invitees.items.[INDEX].scheduledAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"ISO 8601 UTC timestamp when the invitee booked.","isRequired":true,"uniqueKey":"invitees.items.[INDEX].scheduledAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"invitees.items.[INDEX].scheduledAt","typeLabel":"string\u003cdate-time> | null"},"uuid":{"type":"string","description":"Zeeg attendee identifier (zg-XXX format)","example":"zg-O69bac566950c6","uniqueKey":"invitees.items.[INDEX].uuid","typeLabel":"string"},"salutation":{"oneOf":[{"type":"string","description":"Salutation for the invitee, if collected.","uniqueKey":"invitees.items.[INDEX].salutation.oneOf.0","typeLabel":"string"},{"type":"null","description":"Salutation for the invitee, if collected.","uniqueKey":"invitees.items.[INDEX].salutation.oneOf.1","typeLabel":"null"}],"uniqueKey":"invitees.items.[INDEX].salutation","typeLabel":"string | null"},"guests":{"type":"array","description":"Email addresses of additional guests the invitee added. An empty array when the invitee added none.","items":{"type":"string","uniqueKey":"invitees.items.[INDEX].guests.items.[INDEX]","typeLabel":"string"},"uniqueKey":"invitees.items.[INDEX].guests","typeLabel":"string[]"},"cancellation":{"type":"object","properties":{"cancelledAt":{"oneOf":[{"type":"string","format":"date-time","description":"ISO 8601 UTC timestamp when the invitee was cancelled.","uniqueKey":"invitees.items.[INDEX].cancellation.cancelledAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"ISO 8601 UTC timestamp when the invitee was cancelled.","uniqueKey":"invitees.items.[INDEX].cancellation.cancelledAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"invitees.items.[INDEX].cancellation.cancelledAt","typeLabel":"string\u003cdate-time> | null"},"cancelledBy":{"oneOf":[{"type":"string","description":"Identifier of who cancelled the booking.","uniqueKey":"invitees.items.[INDEX].cancellation.cancelledBy.oneOf.0","typeLabel":"string"},{"type":"null","description":"Identifier of who cancelled the booking.","uniqueKey":"invitees.items.[INDEX].cancellation.cancelledBy.oneOf.1","typeLabel":"null"}],"uniqueKey":"invitees.items.[INDEX].cancellation.cancelledBy","typeLabel":"string | null"},"cancellerType":{"oneOf":[{"type":"string","description":"Type of canceller (e.g. host, invitee).","uniqueKey":"invitees.items.[INDEX].cancellation.cancellerType.oneOf.0","typeLabel":"string"},{"type":"null","description":"Type of canceller (e.g. host, invitee).","uniqueKey":"invitees.items.[INDEX].cancellation.cancellerType.oneOf.1","typeLabel":"null"}],"uniqueKey":"invitees.items.[INDEX].cancellation.cancellerType","typeLabel":"string | null"},"cancellationReason":{"oneOf":[{"type":"string","description":"Reason given for the cancellation.","uniqueKey":"invitees.items.[INDEX].cancellation.cancellationReason.oneOf.0","typeLabel":"string"},{"type":"null","description":"Reason given for the cancellation.","uniqueKey":"invitees.items.[INDEX].cancellation.cancellationReason.oneOf.1","typeLabel":"null"}],"uniqueKey":"invitees.items.[INDEX].cancellation.cancellationReason","typeLabel":"string | null"}},"description":"Cancellation details. All fields are `null` when the invitee is not cancelled.","uniqueKey":"invitees.items.[INDEX].cancellation","typeLabel":"object"},"payment":{"oneOf":[{"type":"object","description":"Payment details for the booking, or `null` when no payment applies.","properties":{"gateway":{"type":"string","description":"Payment provider, e.g. `stripe` or `paypal`.","uniqueKey":"invitees.items.[INDEX].payment.oneOf.0.gateway","typeLabel":"string"},"price":{"type":"number","uniqueKey":"invitees.items.[INDEX].payment.oneOf.0.price","typeLabel":"number"},"currency":{"type":"string","uniqueKey":"invitees.items.[INDEX].payment.oneOf.0.currency","typeLabel":"string"},"transactionId":{"oneOf":[{"type":"string","uniqueKey":"invitees.items.[INDEX].payment.oneOf.0.transactionId.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"invitees.items.[INDEX].payment.oneOf.0.transactionId.oneOf.1","typeLabel":"null"}],"uniqueKey":"invitees.items.[INDEX].payment.oneOf.0.transactionId","typeLabel":"string | null"},"createdAt":{"type":"string","format":"date-time","uniqueKey":"invitees.items.[INDEX].payment.oneOf.0.createdAt","typeLabel":"string\u003cdate-time>"},"status":{"type":"string","enum":["pending","success"],"description":"`pending` until the transaction completes.","uniqueKey":"invitees.items.[INDEX].payment.oneOf.0.status","typeLabel":"enum\u003cstring>"}},"uniqueKey":"invitees.items.[INDEX].payment.oneOf.0","typeLabel":"object"},{"type":"null","description":"Payment details for the booking, or `null` when no payment applies.","properties":{"gateway":{"type":"string","description":"Payment provider, e.g. `stripe` or `paypal`."},"price":{"type":"number"},"currency":{"type":"string"},"transactionId":{"oneOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"status":{"type":"string","enum":["pending","success"],"description":"`pending` until the transaction completes."}},"uniqueKey":"invitees.items.[INDEX].payment.oneOf.1","typeLabel":"null"}],"uniqueKey":"invitees.items.[INDEX].payment","typeLabel":"object | null"},"noShowAt":{"oneOf":[{"type":"string","format":"date-time","description":"ISO 8601 UTC timestamp when the invitee was marked as a no-show, or `null` when they were not.","uniqueKey":"invitees.items.[INDEX].noShowAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"ISO 8601 UTC timestamp when the invitee was marked as a no-show, or `null` when they were not.","uniqueKey":"invitees.items.[INDEX].noShowAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"invitees.items.[INDEX].noShowAt","typeLabel":"string\u003cdate-time> | null"},"utm":{"type":"object","required":["utm_campaign","utm_source","utm_medium","utm_term","utm_content"],"properties":{"utm_campaign":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"invitees.items.[INDEX].utm.utm_campaign.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"invitees.items.[INDEX].utm.utm_campaign.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"invitees.items.[INDEX].utm.utm_campaign","typeLabel":"string | null"},"utm_source":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"invitees.items.[INDEX].utm.utm_source.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"invitees.items.[INDEX].utm.utm_source.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"invitees.items.[INDEX].utm.utm_source","typeLabel":"string | null"},"utm_medium":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"invitees.items.[INDEX].utm.utm_medium.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"invitees.items.[INDEX].utm.utm_medium.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"invitees.items.[INDEX].utm.utm_medium","typeLabel":"string | null"},"utm_content":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"invitees.items.[INDEX].utm.utm_content.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"invitees.items.[INDEX].utm.utm_content.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"invitees.items.[INDEX].utm.utm_content","typeLabel":"string | null"},"utm_term":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"invitees.items.[INDEX].utm.utm_term.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"invitees.items.[INDEX].utm.utm_term.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"invitees.items.[INDEX].utm.utm_term","typeLabel":"string | null"}},"description":"UTM tracking parameters captured at booking time. Always holds these five keys, in `snake_case`; a key holds `null` when the booking did not carry a value for it.","uniqueKey":"invitees.items.[INDEX].utm","typeLabel":"object"},"adAttribution":{"oneOf":[{"type":"object","properties":{"gclid":{"oneOf":[{"type":"string","description":"Google Ads click ID.","uniqueKey":"invitees.items.[INDEX].adAttribution.oneOf.0.gclid.oneOf.0","typeLabel":"string"},{"type":"null","description":"Google Ads click ID.","uniqueKey":"invitees.items.[INDEX].adAttribution.oneOf.0.gclid.oneOf.1","typeLabel":"null"}],"uniqueKey":"invitees.items.[INDEX].adAttribution.oneOf.0.gclid","typeLabel":"string | null"},"gbraid":{"oneOf":[{"type":"string","description":"Google click ID for iOS app-to-web clicks. Mutually exclusive with `gclid` per click.","uniqueKey":"invitees.items.[INDEX].adAttribution.oneOf.0.gbraid.oneOf.0","typeLabel":"string"},{"type":"null","description":"Google click ID for iOS app-to-web clicks. Mutually exclusive with `gclid` per click.","uniqueKey":"invitees.items.[INDEX].adAttribution.oneOf.0.gbraid.oneOf.1","typeLabel":"null"}],"uniqueKey":"invitees.items.[INDEX].adAttribution.oneOf.0.gbraid","typeLabel":"string | null"},"wbraid":{"oneOf":[{"type":"string","description":"Google click ID for web-to-app clicks. Mutually exclusive with `gclid` per click.","uniqueKey":"invitees.items.[INDEX].adAttribution.oneOf.0.wbraid.oneOf.0","typeLabel":"string"},{"type":"null","description":"Google click ID for web-to-app clicks. Mutually exclusive with `gclid` per click.","uniqueKey":"invitees.items.[INDEX].adAttribution.oneOf.0.wbraid.oneOf.1","typeLabel":"null"}],"uniqueKey":"invitees.items.[INDEX].adAttribution.oneOf.0.wbraid","typeLabel":"string | null"},"fbclid":{"oneOf":[{"type":"string","description":"Meta click ID.","uniqueKey":"invitees.items.[INDEX].adAttribution.oneOf.0.fbclid.oneOf.0","typeLabel":"string"},{"type":"null","description":"Meta click ID.","uniqueKey":"invitees.items.[INDEX].adAttribution.oneOf.0.fbclid.oneOf.1","typeLabel":"null"}],"uniqueKey":"invitees.items.[INDEX].adAttribution.oneOf.0.fbclid","typeLabel":"string | null"},"fbp":{"oneOf":[{"type":"string","description":"Meta browser ID cookie (`_fbp`) captured at booking time.","uniqueKey":"invitees.items.[INDEX].adAttribution.oneOf.0.fbp.oneOf.0","typeLabel":"string"},{"type":"null","description":"Meta browser ID cookie (`_fbp`) captured at booking time.","uniqueKey":"invitees.items.[INDEX].adAttribution.oneOf.0.fbp.oneOf.1","typeLabel":"null"}],"uniqueKey":"invitees.items.[INDEX].adAttribution.oneOf.0.fbp","typeLabel":"string | null"},"fbc":{"oneOf":[{"type":"string","description":"Meta click cookie (`_fbc`) captured at booking time.","uniqueKey":"invitees.items.[INDEX].adAttribution.oneOf.0.fbc.oneOf.0","typeLabel":"string"},{"type":"null","description":"Meta click cookie (`_fbc`) captured at booking time.","uniqueKey":"invitees.items.[INDEX].adAttribution.oneOf.0.fbc.oneOf.1","typeLabel":"null"}],"uniqueKey":"invitees.items.[INDEX].adAttribution.oneOf.0.fbc","typeLabel":"string | null"},"landingUrl":{"oneOf":[{"type":"string","description":"Full URL of the host page the booking widget was embedded on.","uniqueKey":"invitees.items.[INDEX].adAttribution.oneOf.0.landingUrl.oneOf.0","typeLabel":"string"},{"type":"null","description":"Full URL of the host page the booking widget was embedded on.","uniqueKey":"invitees.items.[INDEX].adAttribution.oneOf.0.landingUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"invitees.items.[INDEX].adAttribution.oneOf.0.landingUrl","typeLabel":"string | null"}},"description":"Ad-click identifiers captured at booking time, keyed by provider. Only the keys that were actually captured are present; `null` when none were captured.","uniqueKey":"invitees.items.[INDEX].adAttribution.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"gclid":{"oneOf":[{"type":"string","description":"Google Ads click ID."},{"type":"null","description":"Google Ads click ID."}]},"gbraid":{"oneOf":[{"type":"string","description":"Google click ID for iOS app-to-web clicks. Mutually exclusive with `gclid` per click."},{"type":"null","description":"Google click ID for iOS app-to-web clicks. Mutually exclusive with `gclid` per click."}]},"wbraid":{"oneOf":[{"type":"string","description":"Google click ID for web-to-app clicks. Mutually exclusive with `gclid` per click."},{"type":"null","description":"Google click ID for web-to-app clicks. Mutually exclusive with `gclid` per click."}]},"fbclid":{"oneOf":[{"type":"string","description":"Meta click ID."},{"type":"null","description":"Meta click ID."}]},"fbp":{"oneOf":[{"type":"string","description":"Meta browser ID cookie (`_fbp`) captured at booking time."},{"type":"null","description":"Meta browser ID cookie (`_fbp`) captured at booking time."}]},"fbc":{"oneOf":[{"type":"string","description":"Meta click cookie (`_fbc`) captured at booking time."},{"type":"null","description":"Meta click cookie (`_fbc`) captured at booking time."}]},"landingUrl":{"oneOf":[{"type":"string","description":"Full URL of the host page the booking widget was embedded on."},{"type":"null","description":"Full URL of the host page the booking widget was embedded on."}]}},"description":"Ad-click identifiers captured at booking time, keyed by provider. Only the keys that were actually captured are present; `null` when none were captured.","uniqueKey":"invitees.items.[INDEX].adAttribution.oneOf.1","typeLabel":"null"}],"uniqueKey":"invitees.items.[INDEX].adAttribution","typeLabel":"object | null"},"customQueryParams":{"type":"object","description":"Custom query parameters captured at booking time, keyed by the `c__`-prefixed parameter name. An empty object when the booking captured none.","example":{"c__ref":"nl-2026-04"},"uniqueKey":"invitees.items.[INDEX].customQueryParams","typeLabel":"object"},"questions":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"answer":{"type":"string","uniqueKey":"invitees.items.[INDEX].questions.oneOf.0.items.[INDEX].answer","typeLabel":"string"},"answer_type":{"type":"string","uniqueKey":"invitees.items.[INDEX].questions.oneOf.0.items.[INDEX].answer_type","typeLabel":"string"},"question":{"type":"string","uniqueKey":"invitees.items.[INDEX].questions.oneOf.0.items.[INDEX].question","typeLabel":"string"}},"uniqueKey":"invitees.items.[INDEX].questions.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"Booking questions answered by the invitee.","uniqueKey":"invitees.items.[INDEX].questions.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"answer":{"type":"string"},"answer_type":{"type":"string"},"question":{"type":"string"}}},"description":"Booking questions answered by the invitee.","uniqueKey":"invitees.items.[INDEX].questions.oneOf.1","typeLabel":"null"}],"uniqueKey":"invitees.items.[INDEX].questions","typeLabel":"object[] | null"},"agentBookingReference":{"oneOf":[{"type":"string","description":"Reference code for bookings made via the AI agent; `null` otherwise.","uniqueKey":"invitees.items.[INDEX].agentBookingReference.oneOf.0","typeLabel":"string"},{"type":"null","description":"Reference code for bookings made via the AI agent; `null` otherwise.","uniqueKey":"invitees.items.[INDEX].agentBookingReference.oneOf.1","typeLabel":"null"}],"uniqueKey":"invitees.items.[INDEX].agentBookingReference","typeLabel":"string | null"},"cancelUrl":{"oneOf":[{"type":"string","format":"uri","description":"Public URL the invitee uses to cancel this booking. `null` once the booking is cancelled.","uniqueKey":"invitees.items.[INDEX].cancelUrl.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"Public URL the invitee uses to cancel this booking. `null` once the booking is cancelled.","uniqueKey":"invitees.items.[INDEX].cancelUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"invitees.items.[INDEX].cancelUrl","typeLabel":"string\u003curi> | null"},"rescheduleUrl":{"oneOf":[{"type":"string","format":"uri","description":"Public URL the invitee uses to reschedule this booking. `null` once the booking is cancelled.","uniqueKey":"invitees.items.[INDEX].rescheduleUrl.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"Public URL the invitee uses to reschedule this booking. `null` once the booking is cancelled.","uniqueKey":"invitees.items.[INDEX].rescheduleUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"invitees.items.[INDEX].rescheduleUrl","typeLabel":"string\u003curi> | null"},"rescheduled":{"type":"boolean","description":"True once this booking has been superseded by a reschedule. A rescheduled booking reports `status: cancelled` for backward compatibility; `rescheduled` and `nextRescheduling` are how a caller tells a reschedule apart from an actual cancellation.","uniqueKey":"invitees.items.[INDEX].rescheduled","typeLabel":"boolean"},"rescheduling":{"oneOf":[{"type":"object","description":"Present when this booking is the *result* of a reschedule. `null` when this booking was not itself created by rescheduling an earlier one.","properties":{"oldStartAt":{"oneOf":[{"type":"string","format":"date-time","description":"ISO 8601 UTC start time the previous booking held before the reschedule.","uniqueKey":"invitees.items.[INDEX].rescheduling.oneOf.0.oldStartAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"ISO 8601 UTC start time the previous booking held before the reschedule.","uniqueKey":"invitees.items.[INDEX].rescheduling.oneOf.0.oldStartAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"invitees.items.[INDEX].rescheduling.oneOf.0.oldStartAt","typeLabel":"string\u003cdate-time> | null"},"newStartAt":{"oneOf":[{"type":"string","format":"date-time","description":"ISO 8601 UTC start time the new booking was moved to.","uniqueKey":"invitees.items.[INDEX].rescheduling.oneOf.0.newStartAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"ISO 8601 UTC start time the new booking was moved to.","uniqueKey":"invitees.items.[INDEX].rescheduling.oneOf.0.newStartAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"invitees.items.[INDEX].rescheduling.oneOf.0.newStartAt","typeLabel":"string\u003cdate-time> | null"},"rescheduledAt":{"type":"string","format":"date-time","description":"ISO 8601 UTC timestamp when the reschedule was performed.","uniqueKey":"invitees.items.[INDEX].rescheduling.oneOf.0.rescheduledAt","typeLabel":"string\u003cdate-time>"},"previousEventUuid":{"oneOf":[{"type":"string","description":"uuid of the superseded booking (zg-XXX format). Use it directly as the `uuid` path parameter of `GET /scheduled-events/{uuid}` to fetch that booking.","example":"zg-O69bad4047abf0","uniqueKey":"invitees.items.[INDEX].rescheduling.oneOf.0.previousEventUuid.oneOf.0","typeLabel":"string"},{"type":"null","description":"uuid of the superseded booking (zg-XXX format). Use it directly as the `uuid` path parameter of `GET /scheduled-events/{uuid}` to fetch that booking.","example":"zg-O69bad4047abf0","uniqueKey":"invitees.items.[INDEX].rescheduling.oneOf.0.previousEventUuid.oneOf.1","typeLabel":"null"}],"uniqueKey":"invitees.items.[INDEX].rescheduling.oneOf.0.previousEventUuid","typeLabel":"string | null"},"previousInviteeUuid":{"oneOf":[{"type":"string","description":"uuid of the invitee on the superseded booking. No public endpoint accepts an invitee uuid as a path parameter.","example":"zg-O69bac566950c6","uniqueKey":"invitees.items.[INDEX].rescheduling.oneOf.0.previousInviteeUuid.oneOf.0","typeLabel":"string"},{"type":"null","description":"uuid of the invitee on the superseded booking. No public endpoint accepts an invitee uuid as a path parameter.","example":"zg-O69bac566950c6","uniqueKey":"invitees.items.[INDEX].rescheduling.oneOf.0.previousInviteeUuid.oneOf.1","typeLabel":"null"}],"uniqueKey":"invitees.items.[INDEX].rescheduling.oneOf.0.previousInviteeUuid","typeLabel":"string | null"},"reason":{"oneOf":[{"type":"string","description":"Reason given for the reschedule, if any.","uniqueKey":"invitees.items.[INDEX].rescheduling.oneOf.0.reason.oneOf.0","typeLabel":"string"},{"type":"null","description":"Reason given for the reschedule, if any.","uniqueKey":"invitees.items.[INDEX].rescheduling.oneOf.0.reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"invitees.items.[INDEX].rescheduling.oneOf.0.reason","typeLabel":"string | null"},"rescheduledBy":{"oneOf":[{"type":"string","description":"Who performed the reschedule (e.g. `host`, `invitee`).","uniqueKey":"invitees.items.[INDEX].rescheduling.oneOf.0.rescheduledBy.oneOf.0","typeLabel":"string"},{"type":"null","description":"Who performed the reschedule (e.g. `host`, `invitee`).","uniqueKey":"invitees.items.[INDEX].rescheduling.oneOf.0.rescheduledBy.oneOf.1","typeLabel":"null"}],"uniqueKey":"invitees.items.[INDEX].rescheduling.oneOf.0.rescheduledBy","typeLabel":"string | null"},"reschedulerFullName":{"oneOf":[{"type":"string","description":"Full name of the person who performed the reschedule, when known.","uniqueKey":"invitees.items.[INDEX].rescheduling.oneOf.0.reschedulerFullName.oneOf.0","typeLabel":"string"},{"type":"null","description":"Full name of the person who performed the reschedule, when known.","uniqueKey":"invitees.items.[INDEX].rescheduling.oneOf.0.reschedulerFullName.oneOf.1","typeLabel":"null"}],"uniqueKey":"invitees.items.[INDEX].rescheduling.oneOf.0.reschedulerFullName","typeLabel":"string | null"}},"uniqueKey":"invitees.items.[INDEX].rescheduling.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"invitees.items.[INDEX].rescheduling.oneOf.1","typeLabel":"null"}],"uniqueKey":"invitees.items.[INDEX].rescheduling","typeLabel":"object | null"},"nextRescheduling":{"oneOf":[{"type":"object","description":"Present when this booking has been superseded by a later reschedule. `null` when the booking has not been rescheduled.","properties":{"oldStartAt":{"oneOf":[{"type":"string","format":"date-time","description":"ISO 8601 UTC start time the previous booking held before the reschedule.","uniqueKey":"invitees.items.[INDEX].nextRescheduling.oneOf.0.oldStartAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"ISO 8601 UTC start time the previous booking held before the reschedule.","uniqueKey":"invitees.items.[INDEX].nextRescheduling.oneOf.0.oldStartAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"invitees.items.[INDEX].nextRescheduling.oneOf.0.oldStartAt","typeLabel":"string\u003cdate-time> | null"},"newStartAt":{"oneOf":[{"type":"string","format":"date-time","description":"ISO 8601 UTC start time the new booking was moved to.","uniqueKey":"invitees.items.[INDEX].nextRescheduling.oneOf.0.newStartAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"ISO 8601 UTC start time the new booking was moved to.","uniqueKey":"invitees.items.[INDEX].nextRescheduling.oneOf.0.newStartAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"invitees.items.[INDEX].nextRescheduling.oneOf.0.newStartAt","typeLabel":"string\u003cdate-time> | null"},"rescheduledAt":{"type":"string","format":"date-time","description":"ISO 8601 UTC timestamp when the reschedule was performed.","uniqueKey":"invitees.items.[INDEX].nextRescheduling.oneOf.0.rescheduledAt","typeLabel":"string\u003cdate-time>"},"previousEventUuid":{"oneOf":[{"type":"string","description":"uuid of the superseded booking (zg-XXX format). Use it directly as the `uuid` path parameter of `GET /scheduled-events/{uuid}` to fetch that booking.","example":"zg-O69bad4047abf0","uniqueKey":"invitees.items.[INDEX].nextRescheduling.oneOf.0.previousEventUuid.oneOf.0","typeLabel":"string"},{"type":"null","description":"uuid of the superseded booking (zg-XXX format). Use it directly as the `uuid` path parameter of `GET /scheduled-events/{uuid}` to fetch that booking.","example":"zg-O69bad4047abf0","uniqueKey":"invitees.items.[INDEX].nextRescheduling.oneOf.0.previousEventUuid.oneOf.1","typeLabel":"null"}],"uniqueKey":"invitees.items.[INDEX].nextRescheduling.oneOf.0.previousEventUuid","typeLabel":"string | null"},"previousInviteeUuid":{"oneOf":[{"type":"string","description":"uuid of the invitee on the superseded booking. No public endpoint accepts an invitee uuid as a path parameter.","example":"zg-O69bac566950c6","uniqueKey":"invitees.items.[INDEX].nextRescheduling.oneOf.0.previousInviteeUuid.oneOf.0","typeLabel":"string"},{"type":"null","description":"uuid of the invitee on the superseded booking. No public endpoint accepts an invitee uuid as a path parameter.","example":"zg-O69bac566950c6","uniqueKey":"invitees.items.[INDEX].nextRescheduling.oneOf.0.previousInviteeUuid.oneOf.1","typeLabel":"null"}],"uniqueKey":"invitees.items.[INDEX].nextRescheduling.oneOf.0.previousInviteeUuid","typeLabel":"string | null"},"reason":{"oneOf":[{"type":"string","description":"Reason given for the reschedule, if any.","uniqueKey":"invitees.items.[INDEX].nextRescheduling.oneOf.0.reason.oneOf.0","typeLabel":"string"},{"type":"null","description":"Reason given for the reschedule, if any.","uniqueKey":"invitees.items.[INDEX].nextRescheduling.oneOf.0.reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"invitees.items.[INDEX].nextRescheduling.oneOf.0.reason","typeLabel":"string | null"},"rescheduledBy":{"oneOf":[{"type":"string","description":"Who performed the reschedule (e.g. `host`, `invitee`).","uniqueKey":"invitees.items.[INDEX].nextRescheduling.oneOf.0.rescheduledBy.oneOf.0","typeLabel":"string"},{"type":"null","description":"Who performed the reschedule (e.g. `host`, `invitee`).","uniqueKey":"invitees.items.[INDEX].nextRescheduling.oneOf.0.rescheduledBy.oneOf.1","typeLabel":"null"}],"uniqueKey":"invitees.items.[INDEX].nextRescheduling.oneOf.0.rescheduledBy","typeLabel":"string | null"},"reschedulerFullName":{"oneOf":[{"type":"string","description":"Full name of the person who performed the reschedule, when known.","uniqueKey":"invitees.items.[INDEX].nextRescheduling.oneOf.0.reschedulerFullName.oneOf.0","typeLabel":"string"},{"type":"null","description":"Full name of the person who performed the reschedule, when known.","uniqueKey":"invitees.items.[INDEX].nextRescheduling.oneOf.0.reschedulerFullName.oneOf.1","typeLabel":"null"}],"uniqueKey":"invitees.items.[INDEX].nextRescheduling.oneOf.0.reschedulerFullName","typeLabel":"string | null"}},"uniqueKey":"invitees.items.[INDEX].nextRescheduling.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"invitees.items.[INDEX].nextRescheduling.oneOf.1","typeLabel":"null"}],"uniqueKey":"invitees.items.[INDEX].nextRescheduling","typeLabel":"object | null"}},"description":"One invitee of a scheduled event. The scheduled event embeds it in `invitees`, and the invitee endpoints return it as `resource`.","uniqueKey":"invitees.items.[INDEX]","typeLabel":"object"},"description":"Invitees booked on the scheduled event.","isRequired":true,"uniqueKey":"invitees","typeLabel":"object[]"},"teamName":{"oneOf":[{"type":"string","description":"Name of the team that owns the scheduling page the booking was made on, or `null` for a personal scheduling page. The key is always present. This is the same value the `invitee.scheduled` webhook sends as `teamName` for the same booking.","example":"Sales","isRequired":true,"uniqueKey":"teamName.oneOf.0","typeLabel":"string"},{"type":"null","description":"Name of the team that owns the scheduling page the booking was made on, or `null` for a personal scheduling page. The key is always present. This is the same value the `invitee.scheduled` webhook sends as `teamName` for the same booking.","example":"Sales","isRequired":true,"uniqueKey":"teamName.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"teamName","typeLabel":"string | null"},"createdAt":{"type":"string","format":"date-time","description":"ISO 8601 UTC timestamp when the booking was created.","isRequired":true,"uniqueKey":"createdAt","typeLabel":"string\u003cdate-time>"},"location":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Location type (e.g. `google_meet`, `zoom`, `phone`, `in_person`).","isRequired":true,"uniqueKey":"location.oneOf.0.type","typeLabel":"string"},"joinUrl":{"oneOf":[{"type":"string","format":"uri","description":"Join URL for the meeting, when applicable.","uniqueKey":"location.oneOf.0.joinUrl.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"Join URL for the meeting, when applicable.","uniqueKey":"location.oneOf.0.joinUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"location.oneOf.0.joinUrl","typeLabel":"string\u003curi> | null"}},"description":"Meeting location for the booking.","uniqueKey":"location.oneOf.0","typeLabel":"object"},{"type":"null","required":["type"],"properties":{"type":{"type":"string","description":"Location type (e.g. `google_meet`, `zoom`, `phone`, `in_person`)."},"joinUrl":{"oneOf":[{"type":"string","format":"uri","description":"Join URL for the meeting, when applicable."},{"type":"null","format":"uri","description":"Join URL for the meeting, when applicable."}]}},"description":"Meeting location for the booking.","uniqueKey":"location.oneOf.1","typeLabel":"null"}],"uniqueKey":"location","typeLabel":"object | null"},"guests":{"type":"array","description":"Email addresses of additional guests added across all invitees. An empty array when none were added.","items":{"type":"string","uniqueKey":"guests.items.[INDEX]","typeLabel":"string"},"uniqueKey":"guests","typeLabel":"string[]"},"hosts":{"oneOf":[{"type":"array","items":{"type":"object","required":["firstName","email","slug","url"],"properties":{"firstName":{"oneOf":[{"type":"string","description":"Host's first name.","isRequired":true,"uniqueKey":"hosts.oneOf.0.items.[INDEX].firstName.oneOf.0","typeLabel":"string"},{"type":"null","description":"Host's first name.","isRequired":true,"uniqueKey":"hosts.oneOf.0.items.[INDEX].firstName.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"hosts.oneOf.0.items.[INDEX].firstName","typeLabel":"string | null"},"email":{"oneOf":[{"type":"string","format":"email","description":"Host's email address.","isRequired":true,"uniqueKey":"hosts.oneOf.0.items.[INDEX].email.oneOf.0","typeLabel":"string\u003cemail>"},{"type":"null","format":"email","description":"Host's email address.","isRequired":true,"uniqueKey":"hosts.oneOf.0.items.[INDEX].email.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"hosts.oneOf.0.items.[INDEX].email","typeLabel":"string\u003cemail> | null"},"slug":{"oneOf":[{"type":"string","description":"Host's public profile slug.","isRequired":true,"uniqueKey":"hosts.oneOf.0.items.[INDEX].slug.oneOf.0","typeLabel":"string"},{"type":"null","description":"Host's public profile slug.","isRequired":true,"uniqueKey":"hosts.oneOf.0.items.[INDEX].slug.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"hosts.oneOf.0.items.[INDEX].slug","typeLabel":"string | null"},"url":{"type":"string","format":"uri","description":"Host's public profile URL.","isRequired":true,"uniqueKey":"hosts.oneOf.0.items.[INDEX].url","typeLabel":"string\u003curi>"},"lastName":{"type":"string","description":"Host's last name. Empty string when not set.","uniqueKey":"hosts.oneOf.0.items.[INDEX].lastName","typeLabel":"string"},"avatarUrl":{"oneOf":[{"type":"string","format":"uri","description":"URL of the host's avatar image, if set.","uniqueKey":"hosts.oneOf.0.items.[INDEX].avatarUrl.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"URL of the host's avatar image, if set.","uniqueKey":"hosts.oneOf.0.items.[INDEX].avatarUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"hosts.oneOf.0.items.[INDEX].avatarUrl","typeLabel":"string\u003curi> | null"}},"uniqueKey":"hosts.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"Hosts assigned to the scheduled event.","uniqueKey":"hosts.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","required":["firstName","email","slug","url"],"properties":{"firstName":{"oneOf":[{"type":"string","description":"Host's first name."},{"type":"null","description":"Host's first name."}]},"lastName":{"type":"string","description":"Host's last name. Empty string when not set."},"email":{"oneOf":[{"type":"string","format":"email","description":"Host's email address."},{"type":"null","format":"email","description":"Host's email address."}]},"slug":{"oneOf":[{"type":"string","description":"Host's public profile slug."},{"type":"null","description":"Host's public profile slug."}]},"url":{"type":"string","format":"uri","description":"Host's public profile URL."},"avatarUrl":{"oneOf":[{"type":"string","format":"uri","description":"URL of the host's avatar image, if set."},{"type":"null","format":"uri","description":"URL of the host's avatar image, if set."}]}}},"description":"Hosts assigned to the scheduled event.","uniqueKey":"hosts.oneOf.1","typeLabel":"null"}],"uniqueKey":"hosts","typeLabel":"object[] | null"},"updatedAt":{"type":"string","format":"date-time","description":"ISO 8601 UTC timestamp when the booking was last updated.","uniqueKey":"updatedAt","typeLabel":"string\u003cdate-time>"},"currentTime":{"type":"string","format":"date-time","description":"Current server time","uniqueKey":"currentTime","typeLabel":"string\u003cdate-time>"}},"description":"A scheduled event resource. This is the single canonical shape returned by all scheduled-event endpoints and embedded in the AI agent call webhook payload.","uniqueKey":"","typeLabel":"object"},"examples":{"Newly created event":{"title":"Newly created event","value":{"uri":"https://api.zeeg.me/v2/scheduled-events/zg-O69bac566950c6","uuid":"zg-O69bac566950c6","title":"30-Minute Discovery Call","type":"ONE_ON_ONE","startTime":"2026-04-15T07:00:00.000000Z","endTime":"2026-04-15T07:30:00.000000Z","duration":30,"status":"confirmed","eventTypeUri":"https://api.zeeg.me/v2/event-types/80f46bf5-eb01-4c07-960e-a9a3e18aae5e","location":{"type":"Google Meet","joinUrl":"https://meet.google.com/abc-defg-hij"},"maxActiveInvitees":1,"activeInviteesCount":1,"invitees":[{"uuid":"zg-O69bad4047abf0","salutation":null,"fullName":"Sophie Laurent","email":"sophie.laurent@northwind.io","guests":["alex.chen@northwind.io"],"timeZone":"Europe/Paris","cancellation":{"cancelledAt":null,"cancelledBy":null,"cancellerType":null,"cancellationReason":null},"payment":null,"questions":[{"answer":"Product demo and pricing options","answer_type":"STRING","question":"What would you like to discuss?"}],"noShow":false,"noShowAt":null,"scheduledAt":"2026-04-10T08:30:00.000000Z","utm":{"utm_campaign":"spring_launch","utm_source":"linkedin","utm_medium":"social","utm_content":null,"utm_term":null},"customQueryParams":{}}],"guests":["alex.chen@northwind.io"],"hosts":[{"firstName":"Lena","lastName":"Meier","email":"lena.meier@horizondigital.de","slug":"lena-meier","url":"https://zeeg.me/lena-meier","avatarUrl":null}],"teamName":"Sales","createdAt":"2026-04-10T08:30:00.000000Z","updatedAt":"2026-04-10T08:30:00.000000Z","currentTime":"2026-04-10T08:30:00+00:00"}}},"exampleType":"examples"}},"exampleType":"examples"},"02f8af1a-2348-4a0e-89bc-e0c6e09fc1ab":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","uniqueKey":"success","typeLabel":"boolean"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"},"data":{"type":"object","properties":{"reason":{"type":"string","enum":["TIMESLOT_UNAVAILABLE","ANSWERS_INVALID"],"description":"Why the booking was refused. `TIMESLOT_UNAVAILABLE` means the slot is no longer bookable; `ANSWERS_INVALID` means a required question is unanswered or an answer is invalid.","uniqueKey":"data.reason","typeLabel":"enum\u003cstring>"}},"uniqueKey":"data","typeLabel":"object"},"status":{"type":"integer","uniqueKey":"status","typeLabel":"integer"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Time slot not available":{"title":"Time slot not available","value":{"success":false,"message":"The requested time slot is not available for booking. Please select another time.","data":{"reason":"TIMESLOT_UNAVAILABLE"},"status":400}}},"exampleType":"examples"}},"exampleType":"examples"},"19d2dd24-0d76-4c56-ada1-82f5b576f4d4":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Unauthenticated.","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Unauthenticated":{"title":"Unauthenticated","value":{"message":"Unauthenticated."}}},"exampleType":"examples"}},"exampleType":"examples"},"ca892cdf-7938-4a26-a1f6-02936c2ff96a":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","uniqueKey":"error.type","typeLabel":"string"},"message":{"type":"string","uniqueKey":"error.message","typeLabel":"string"},"error_id":{"type":"string","uniqueKey":"error.error_id","typeLabel":"string"},"required_scopes":{"type":"array","items":{"type":"string","uniqueKey":"error.required_scopes.items.[INDEX]","typeLabel":"string"},"uniqueKey":"error.required_scopes","typeLabel":"string[]"}},"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Premium scope error":{"title":"Premium scope error","value":{"error":{"type":"insufficient_scope","message":"Premium scope access denied. Premium API scopes (Timetable, Booking) require a paid subscription. Please upgrade your plan.","error_id":"e4987ce8-c841-4e06-993e-20f1aff6e34b","required_scopes":["booking"]}}},"Missing scope":{"title":"Missing scope","value":{"error":{"type":"insufficient_scope","message":"Your token is missing the required scope(s). Include at least one of: booking.","error_id":"c5e14bb1-f1d3-461a-8100-82ac1dcf32c3","required_scopes":["booking"]}}}},"exampleType":"examples"}},"exampleType":"examples"},"07380dc3-7cc0-4533-a644-437aecd33604":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","uniqueKey":"error","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Event type not found":{"title":"Event type not found","value":{"error":"Entry for EventType not found"}}},"exampleType":"examples"}},"exampleType":"examples"},"0620395e-7515-4d26-9f9b-aeb81fd02f8d":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","uniqueKey":"message","typeLabel":"string"},"errors":{"type":"object","uniqueKey":"errors","typeLabel":"object"},"data":{"type":"object","properties":{"bookingUrl":{"type":"string","description":"For a scheduling page that takes a payment, the page where the invitee books and pays.","uniqueKey":"data.bookingUrl","typeLabel":"string"},"reason":{"type":"string","enum":["PHONE_REQUIRED","PAYMENT_REQUIRED","NEW_ACCOUNT_LIMIT","DAILY_LIMIT","HOST_AT_LIMIT","LOCATION_INVALID","WITHDRAWAL_CONSENT_REQUIRED"],"description":"The scheduling-page rule that refused the booking. Absent on a field validation error, which carries `errors` instead.","uniqueKey":"data.reason","typeLabel":"enum\u003cstring>"}},"uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Invalid date":{"title":"Invalid date","value":{"message":"The date field must be a valid date.","errors":{"date":["The date field must be a valid date."]}}},"Scheduling page takes a payment":{"title":"Scheduling page takes a payment","value":{"success":false,"message":"This scheduling page takes a payment. The event is booked and paid for on the page itself: https://zeeg.me/lena-meier/consultation","data":{"bookingUrl":"https://zeeg.me/lena-meier/consultation","reason":"PAYMENT_REQUIRED"},"status":422}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"bab93ec9-8b9f-4734-958d-60c7afbc85a3":{"bearer":{"type":"http","scheme":"bearer","description":"","scopes":[],"schemeName":"bearer"}}},"servers":{"ee2a58d5-385b-4901-a1cd-b8b0b78a60fc":{"url":"https://api.zeeg.me/v2","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"","scopes":[],"schemeName":"bearer"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearer","name":"Authorization"}],"title":"bearer"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"zeeg","siteName":"Zeeg Developer Hub","title":"Create an Event - Zeeg Developer Hub","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-04-29T14:35:49.106Z","gitLastModified":"2026-04-29T14:35:30.000Z","originalFileLocation":"api/scheduling-pages/create-an-event.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Programmatically book a scheduled event on a Zeeg scheduling page by providing an invitee, a chosen time slot, and any required custom answers.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Zeeg Developer Hub\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003cmeta data-mint-head name=\"robots\" content=\"index, follow\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/zeeg/ghjkS0QJHhQPDpab/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/zeeg/ghjkS0QJHhQPDpab/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/zeeg/ghjkS0QJHhQPDpab/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/zeeg/ghjkS0QJHhQPDpab/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/zeeg/ghjkS0QJHhQPDpab/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/zeeg/ghjkS0QJHhQPDpab/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/zeeg/ghjkS0QJHhQPDpab/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/zeeg/ghjkS0QJHhQPDpab/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/zeeg/ghjkS0QJHhQPDpab/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create an Event - Zeeg Developer Hub\">\u003cmeta data-mint-head property=\"og:description\" content=\"Programmatically book a scheduled event on a Zeeg scheduling page by providing an invitee, a chosen time slot, and any required custom answers.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Zeeg Developer Hub\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developer.zeeg.me/api/scheduling-pages/create-an-event\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://zeeg.mintlify.site/_mintlify/api/og/v2?division=Scheduling+Pages\u0026amp;title=Create+an+Event\u0026amp;description=Programmatically+book+a+scheduled+event+on+a+Zeeg+scheduling+page+by+providing+an+invitee%2C+a+chosen+time+slot%2C+and+any+required+custom+answers.\u0026amp;theme=902e11371c50c4af37ea8b4f\u0026amp;signature=a0b3902331caa3863202781fc47e6db8c483975ec62dd9a3565baf8b10a53ea0\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Create an Event - Zeeg Developer Hub\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Programmatically book a scheduled event on a Zeeg scheduling page by providing an invitee, a chosen time slot, and any required custom answers.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://zeeg.mintlify.site/_mintlify/api/og/v2?division=Scheduling+Pages\u0026amp;title=Create+an+Event\u0026amp;description=Programmatically+book+a+scheduled+event+on+a+Zeeg+scheduling+page+by+providing+an+invitee%2C+a+chosen+time+slot%2C+and+any+required+custom+answers.\u0026amp;theme=902e11371c50c4af37ea8b4f\u0026amp;signature=a0b3902331caa3863202781fc47e6db8c483975ec62dd9a3565baf8b10a53ea0\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/zeeg/ghjkS0QJHhQPDpab/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Zeeg Developer Hub\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#6C63FF\">\u003cmeta data-mint-head name=\"og:locale\" content=\"en_US\">\u003cmeta data-mint-head name=\"author\" content=\"Zeeg\">\u003cmeta data-mint-head name=\"googlebot\" content=\"index, follow\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developer.zeeg.me/api/scheduling-pages/create-an-event\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api/scheduling-pages/create-an-event.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developer.zeeg.me/#organization\",\"name\":\"Zeeg Developer Hub\",\"url\":\"https://developer.zeeg.me\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/zeeg/9voKLLkajreclhp4/images/Zeeglogo(Original).svg?fit=max\u0026auto=format\u0026n=9voKLLkajreclhp4\u0026q=85\u0026s=321632804eda4b3cff044941f9ccadda\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developer.zeeg.me#website\",\"name\":\"Zeeg Developer Hub\",\"url\":\"https://developer.zeeg.me\",\"publisher\":{\"@id\":\"https://developer.zeeg.me/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developer.zeeg.me/api/scheduling-pages/create-an-event#webpage\",\"url\":\"https://developer.zeeg.me/api/scheduling-pages/create-an-event\",\"name\":\"Create an Event\",\"description\":\"Programmatically book a scheduled event on a Zeeg scheduling page by providing an invitee, a chosen time slot, and any required custom answers.\",\"dateModified\":\"2026-04-29T14:35:30.000Z\",\"isPartOf\":{\"@id\":\"https://developer.zeeg.me#website\"},\"breadcrumb\":{\"@id\":\"https://developer.zeeg.me/api/scheduling-pages/create-an-event#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developer.zeeg.me/api/scheduling-pages/create-an-event#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Reference\",\"item\":\"https://developer.zeeg.me/api/scheduled-events/list-scheduled-events\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Scheduling Pages\",\"item\":\"https://developer.zeeg.me/api/scheduling-pages/list-scheduling-pages\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Create an Event\",\"item\":\"https://developer.zeeg.me/api/scheduling-pages/create-an-event\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developer.zeeg.me/api/scheduling-pages/create-an-event#apireference\",\"headline\":\"Create an Event\",\"name\":\"Create an Event\",\"description\":\"Programmatically book a scheduled event on a Zeeg scheduling page by providing an invitee, a chosen time slot, and any required custom answers.\",\"url\":\"https://developer.zeeg.me/api/scheduling-pages/create-an-event\",\"mainEntityOfPage\":{\"@id\":\"https://developer.zeeg.me/api/scheduling-pages/create-an-event#webpage\"},\"dateModified\":\"2026-04-29T14:35:30.000Z\",\"publisher\":{\"@id\":\"https://developer.zeeg.me/#organization\"},\"isPartOf\":{\"@id\":\"https://developer.zeeg.me#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Zeeg Developer Hub\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Zeeg Developer Hub\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api/scheduling-pages/create-an-event.md","siteName":"Zeeg Developer Hub","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"Guides","pages":[{"title":"Guides","href":"/guides/booking-flow"}]},{"tab":"API Reference","groups":[{"group":"API Reference","pages":[{"group":"Scheduled Events","expanded":false,"pages":[{"title":"List Scheduled Events","openapi":"GET /scheduled-events","href":"/api/scheduled-events/list-scheduled-events"},{"title":"Get a Scheduled Event","openapi":"GET /scheduled-events/{uuid}","href":"/api/scheduled-events/get-a-scheduled-event"},{"title":"Get Reschedule Availability","openapi":"GET /scheduled-events/{uuid}/reschedule-availability","href":"/api/scheduled-events/get-reschedule-availability"},{"title":"Reschedule a Scheduled Event","openapi":"PUT /scheduled-events/{uuid}/reschedule","href":"/api/scheduled-events/reschedule-a-scheduled-event"},{"title":"Cancel a Scheduled Event","openapi":"PUT /scheduled-events/{uuid}/cancel","href":"/api/scheduled-events/cancel-a-scheduled-event"},{"title":"Cancel a Scheduled Invitee","openapi":"PUT /scheduled-invitees/{uuid}/cancel","href":"/api/scheduled-events/cancel-a-scheduled-invitee"},{"title":"Handover a Scheduled Event","openapi":"PUT /scheduled-events/{uuid}/handover","href":"/api/scheduled-events/handover-a-scheduled-event"}]},{"group":"Scheduling Pages","expanded":false,"pages":[{"title":"List Scheduling Pages","openapi":"GET /event-types","href":"/api/scheduling-pages/list-scheduling-pages"},{"title":"Get a Scheduling Page","openapi":"GET /event-types/{uuid}","href":"/api/scheduling-pages/get-a-scheduling-page"},{"title":"Create a Scheduling Page","openapi":"POST /event-types","href":"/api/scheduling-pages/create-a-scheduling-page"},{"title":"Update a Scheduling Page","openapi":"PATCH /event-types/{uuid}","href":"/api/scheduling-pages/update-a-scheduling-page"},{"title":"Duplicate a Scheduling Page","openapi":"POST /event-types/{uuid}/duplicate","href":"/api/scheduling-pages/duplicate-a-scheduling-page"},{"title":"Delete a Scheduling Page","openapi":"DELETE /event-types/{uuid}","href":"/api/scheduling-pages/delete-a-scheduling-page"},{"title":"Get Scheduling Page Questions","openapi":"GET /event-types/{uuid}/questions","href":"/api/scheduling-pages/get-scheduling-page-questions"},{"title":"Replace Scheduling Page Questions","openapi":"PUT /event-types/{uuid}/questions","href":"/api/scheduling-pages/replace-scheduling-page-questions"},{"title":"Get Scheduling Page Notifications","openapi":"GET /event-types/{uuid}/notifications","href":"/api/scheduling-pages/get-scheduling-page-notifications"},{"title":"Update Scheduling Page Notifications","openapi":"PATCH /event-types/{uuid}/notifications","href":"/api/scheduling-pages/update-scheduling-page-notifications"},{"title":"Toggle Scheduling Page Status","openapi":"PUT /event-types/{uuid}/status","href":"/api/scheduling-pages/toggle-scheduling-page-status"},{"title":"Get a Single-Use Scheduling Link","openapi":"GET /event-types/{uuid}/single-use-link","href":"/api/scheduling-pages/get-a-single-use-scheduling-link"},{"title":"Get Available Time Slots","openapi":"GET /availability/{ownerSlug}/event-types/{eventTypeSlug}","href":"/api/scheduling-pages/get-available-time-slots"},{"title":"Get Available Time Slots by ID","description":"Query bookable time slots for a scheduling page by the id the list endpoint returns, with no owner slug to work out.","openapi":"GET /event-types/{uuid}/availability","href":"/api/scheduling-pages/get-available-time-slots-by-id"},{"title":"Create an Event","openapi":"POST /event","href":"/api/scheduling-pages/create-an-event"}]},{"group":"Availability Schedule","expanded":false,"pages":[{"title":"Get All Availability Schedules","description":"Retrieve all availability schedules belonging to the authenticated user, including weekly hours, time zone, and date overrides.","openapi":"GET /schedules","href":"/api/availability/get-all-availability-schedules"},{"title":"Get Default Availability Schedule","openapi":"GET /schedules/default","href":"/api/availability/get-default-availability-schedule"},{"title":"Update Default Availability Schedule","openapi":"PATCH /schedules/default","href":"/api/availability/update-default-availability-schedule"},{"title":"Get Availability Schedule by UUID","openapi":"GET /schedules/{uuid}","href":"/api/availability/get-availability-schedule-by-uuid"},{"title":"Update Availability Schedule by UUID","openapi":"PATCH /schedules/{uuid}","href":"/api/availability/update-availability-schedule-by-uuid"},{"title":"List Time-Off Periods","openapi":"GET /time-off","href":"/api/availability/list-time-off-periods"},{"title":"Create Time-Off Periods","openapi":"POST /time-off","href":"/api/availability/create-time-off-periods"},{"title":"Update Time-Off Period","openapi":"PATCH /time-off/{uuid}","href":"/api/availability/update-time-off-period"},{"title":"Delete Time-Off Period","openapi":"DELETE /time-off/{uuid}","href":"/api/availability/delete-time-off-period"},{"title":"List Holiday Categories","openapi":"GET /holidays/categories","href":"/api/holidays/list-holiday-categories"},{"title":"Preview Holidays for a Category","openapi":"GET /holidays/preview","href":"/api/holidays/preview-holidays"},{"title":"List Holiday Subscriptions","openapi":"GET /holidays/subscriptions","href":"/api/holidays/list-holiday-subscriptions"},{"title":"Create Holiday Subscriptions","openapi":"POST /holidays/subscriptions","href":"/api/holidays/create-holiday-subscriptions"},{"title":"Delete a Holiday Subscription","openapi":"DELETE /holidays/subscriptions/{id}","href":"/api/holidays/delete-holiday-subscription"},{"title":"Toggle Holiday Overrides","openapi":"PUT /holidays/subscriptions/{id}/overrides","href":"/api/holidays/toggle-holiday-overrides"}]},{"group":"Webhooks","expanded":false,"pages":[{"title":"Create Webhook Subscription","openapi":"POST /webhooks","href":"/api/webhooks/create-webhook-subscription"},{"title":"List Webhook Subscriptions","openapi":"GET /webhooks/scope/{scope}","href":"/api/webhooks/list-webhook-subscriptions"},{"title":"Get Webhook Subscription","openapi":"GET /webhooks/{uuid}","href":"/api/webhooks/get-webhook-subscription"},{"title":"Delete Webhook Subscription","openapi":"DELETE /webhooks/{uuid}","href":"/api/webhooks/delete-webhook-subscription"}]},{"group":"Notes","expanded":false,"pages":[{"title":"Create a Note","openapi":"POST /notes","href":"/api/notes/create-a-note"},{"title":"List Notes by Event","openapi":"GET /notes/event/{uuid}","href":"/api/notes/list-notes-by-event"},{"title":"Get a Note","openapi":"GET /notes/{id}","href":"/api/notes/get-a-note"},{"title":"Update a Note","openapi":"PUT /notes/{id}","href":"/api/notes/update-a-note"},{"title":"Delete a Note","openapi":"DELETE /notes/{id}","href":"/api/notes/delete-a-note"}]},{"group":"Workspaces \u0026 Teams","expanded":false,"pages":[{"title":"Check Logged-in User","openapi":"GET /whoami","href":"/api/workspaces-teams/check-logged-in-user"},{"title":"List Users in a Workspace","openapi":"GET /organizations/users","href":"/api/workspaces-teams/list-users-in-a-workspace"},{"title":"List Teams","openapi":"GET /teams","href":"/api/workspaces-teams/list-teams"},{"title":"Create a Team","openapi":"POST /teams","href":"/api/workspaces-teams/create-a-team"},{"title":"Update a Team","openapi":"PATCH /teams/{teamId}","href":"/api/workspaces-teams/update-a-team"},{"title":"Delete a Team","openapi":"DELETE /teams/{teamId}","href":"/api/workspaces-teams/delete-a-team"},{"title":"List Team Members","openapi":"GET /teams/{teamId}/members","href":"/api/workspaces-teams/list-team-members"},{"title":"Add a Team Member","openapi":"POST /teams/{teamId}/members","href":"/api/workspaces-teams/add-a-team-member"},{"title":"Remove a Team Member","openapi":"DELETE /teams/{teamId}/members/{memberId}","href":"/api/workspaces-teams/remove-a-team-member"},{"title":"Invite People to the Workspace","openapi":"POST /organizations/invitations","href":"/api/workspaces-teams/invite-people"},{"title":"List Pending Invitations","openapi":"GET /organizations/invitations","href":"/api/workspaces-teams/list-invitations"},{"title":"Revoke an Invitation","openapi":"DELETE /organizations/invitations/{invitationId}","href":"/api/workspaces-teams/revoke-an-invitation"}]},{"group":"AI Agent","expanded":false,"pages":[{"title":"Create Outbound Call","openapi":"POST /agents/{agentUuid}/outbound-calls","href":"/api/ai-agent/create-outbound-call"},{"title":"List AI Agents","openapi":"GET /agents","href":"/api/ai-agent/list-agents"},{"title":"List Agent Calls","openapi":"GET /agents/{agentUuid}/calls","href":"/api/ai-agent/list-agent-calls"},{"title":"Get Agent Call","openapi":"GET /agent-calls/{callId}","href":"/api/ai-agent/get-agent-call"}]},{"group":"Webhook Payloads","expanded":false,"pages":[{"title":"Event Webhook Payload","href":"/api/webhook-payloads/event-webhook-payload"},{"title":"Routing Form Webhook Payload","href":"/api/webhook-payloads/routing-form-webhook-payload"},{"title":"AI Agent Call Webhook Payload","href":"/api/webhook-payloads/ai-agent-call-webhook-payload"}]},{"group":"CRM","expanded":false,"pages":[{"title":"CRM Overview","href":"/api/crm/overview"},{"group":"Objects","pages":[{"title":"List CRM Objects","openapi":"GET /crm/objects","href":"/api/crm/list-crm-objects"},{"title":"Get a CRM Object","openapi":"GET /crm/objects/{slug}","href":"/api/crm/get-a-crm-object"},{"title":"Create a CRM Object","openapi":"POST /crm/objects","href":"/api/crm/create-a-crm-object"},{"title":"Update a CRM Object","openapi":"PATCH /crm/objects/{slug}","href":"/api/crm/update-a-crm-object"},{"title":"Delete a CRM Object","openapi":"DELETE /crm/objects/{slug}","href":"/api/crm/delete-a-crm-object"},{"title":"Add Attribute to CRM Object","openapi":"POST /crm/objects/{slug}/attributes","href":"/api/crm/add-attribute-to-crm-object"},{"title":"Update CRM Object Attribute","openapi":"PATCH /crm/objects/{slug}/attributes/{attributeKey}","href":"/api/crm/update-crm-object-attribute"}]},{"group":"Companies","pages":[{"title":"List CRM Companies","openapi":"GET /crm/companies","href":"/api/crm/list-crm-companies"},{"title":"Get a CRM Company","openapi":"GET /crm/companies/{id}","href":"/api/crm/get-a-crm-company"},{"title":"Create a CRM Company","openapi":"POST /crm/companies","href":"/api/crm/create-a-crm-company"},{"title":"Assert a CRM Company","openapi":"PUT /crm/companies","href":"/api/crm/assert-a-crm-company"},{"title":"Patch a CRM Company","openapi":"PATCH /crm/companies/{id}","href":"/api/crm/patch-a-crm-company"},{"title":"Delete a CRM Company","openapi":"DELETE /crm/companies/{id}","href":"/api/crm/delete-a-crm-company"}]},{"group":"People","pages":[{"title":"List CRM People","openapi":"GET /crm/people","href":"/api/crm/list-crm-people"},{"title":"Get a CRM Person","openapi":"GET /crm/people/{id}","href":"/api/crm/get-a-crm-person"},{"title":"Create a CRM Person","openapi":"POST /crm/people","href":"/api/crm/create-a-crm-person"},{"title":"Assert a CRM Person","openapi":"PUT /crm/people","href":"/api/crm/update-a-crm-person"},{"title":"Patch a CRM Person","openapi":"PATCH /crm/people/{id}","href":"/api/crm/patch-a-crm-person"},{"title":"Delete a CRM Person","openapi":"DELETE /crm/people/{id}","href":"/api/crm/delete-a-crm-person"}]},{"group":"Records","pages":[{"title":"List CRM Records","openapi":"GET /crm/{objectSlug}","href":"/api/crm/list-crm-records"},{"title":"Get a CRM Record","openapi":"GET /crm/{objectSlug}/{recordId}","href":"/api/crm/get-a-crm-record"},{"title":"Create a CRM Record","openapi":"POST /crm/{objectSlug}","href":"/api/crm/create-a-crm-record"},{"title":"Assert a CRM Record (Upsert)","openapi":"PUT /crm/{objectSlug}","href":"/api/crm/assert-a-crm-record"},{"title":"Patch a CRM Record","openapi":"PATCH /crm/{objectSlug}/{recordId}","href":"/api/crm/patch-a-crm-record"},{"title":"Delete a CRM Record","openapi":"DELETE /crm/{objectSlug}/{recordId}","href":"/api/crm/delete-a-crm-record"},{"title":"Update a CRM Record Relation","openapi":"PATCH /crm/{objectSlug}/{recordId}/relation","href":"/api/crm/update-relation-crm-record"}]}]},{"group":"Routing Forms","expanded":false,"pages":[{"title":"Routing Forms Overview","href":"/api/routing-forms/overview"},{"group":"Forms","pages":[{"title":"List Routing Forms","openapi":"GET /routing-forms","href":"/api/routing-forms/list-routing-forms"},{"title":"Get a Routing Form","openapi":"GET /routing-forms/{id}","href":"/api/routing-forms/get-a-routing-form"},{"title":"Create a Routing Form","openapi":"POST /routing-forms","href":"/api/routing-forms/create-a-routing-form"},{"title":"Update a Routing Form","openapi":"PATCH /routing-forms/{id}","href":"/api/routing-forms/update-a-routing-form"},{"title":"Duplicate a Routing Form","openapi":"POST /routing-forms/{id}/duplicate","href":"/api/routing-forms/duplicate-a-routing-form"},{"title":"Replace Routing Form Questions","openapi":"PUT /routing-forms/{id}/inputs","href":"/api/routing-forms/replace-routing-form-questions"},{"title":"Replace Routing Form Routes","openapi":"PUT /routing-forms/{id}/routes","href":"/api/routing-forms/replace-routing-form-routes"},{"title":"Delete a Routing Form","openapi":"DELETE /routing-forms/{id}","href":"/api/routing-forms/delete-a-routing-form"}]},{"group":"Submissions","pages":[{"title":"List Routing Form Submissions","openapi":"GET /routing-form-submissions","href":"/api/routing-forms/list-routing-form-submissions"},{"title":"Get a Routing Form Submission","openapi":"GET /routing-form-submissions/{id}","href":"/api/routing-forms/get-a-routing-form-submission"},{"title":"Delete a Routing Form Submission","openapi":"DELETE /routing-form-submissions/{id}","href":"/api/routing-forms/delete-a-routing-form-submission"}]}]}]}]}]},"basePath":"","title":"Create an Event - Zeeg Developer Hub","buildId":"dpl_5joLUXmnJgwqjrHAS4dxZrQTdxgh","deploymentId":"dpl_5joLUXmnJgwqjrHAS4dxZrQTdxgh","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-DPDWPCdE.js","utils-DyjUHyLo.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BWYE1cdS.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-COAzxpEw.js","snippetPresets-DNiD_S52.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","Page-DDHbuAIY.js","ApiExamples-CjwVt80x.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-ByHQMk7z.js","shallow-CaZuw1AO.js","getApiPlaygroundDisplay-DPVPOknm.js","CodeSnippet-B31CH-Mp.js","CodeSnippets-BxTYZWz6.js","getPastedJson-DhoAwiNO.js","icon-Dhq8z75J.js","MethodPill-DLXmKOwr.js","DuplicateIcon-jzdVwyRU.js","createIcon-eD0b3klN.js","DynamicMarkdown-BfddVCX7.js","SectionHeading-2pSCIo17.js","axios-vUo_bRtp.js","Markdown-DsWjhwJ4.js","clsx-B2t_mZQG.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CUljsAY7.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Cf70306N.js"]}