MCP tool reference
The current KrabiClaw MCP tools, their inputs, access requirements and effects, generated from the deployed server contract.
Chris Luke
612 min read
KrabiClaw’s MCP connects an AI assistant to your business website and operations. This reference describes the tools exposed by the running server. Access still depends on your business membership, role and enabled features. Your assistant may need a tool refresh before it can use recently added tools.
For setup, see Connect KrabiClaw to ChatGPT. For practical tasks, start with updating your menu, managing bookings, adding photos and video, publishing a post, or handling inquiries.
See what AI assistants can and cannot do for the overview and refreshing your tools if your connected assistant has an older list.
This reference is generated from the tool definitions running on this server. It updates when those definitions are deployed.
Reference fingerprint: sha256:dfc4d92a1f922d10c4d43e69dd597e2bceeca7539efa0e0aec8a3fa18d7c146d
Tools: 178.
Connect with the setup guide, then read what AI assistants can do. Select the intended business and use its internal IDs returned by the tools. Permissions and entitlements are checked when each operation runs.
For step-by-step tasks, see menu updates, bookings, photos and video, publishing a post, and guest messages and requests.
Before asking an assistant to change data, review the business, records and intended result. Tool descriptions specify any operation-specific approval steps. Client confirmation controls depend on your AI assistant. Read-only, destructive, open-world and idempotent hints describe the tool; they do not grant permission or approve an operation.
Input and output tables list each field, its required state and schema constraints. Nested objects, array items and schema alternatives link to shared shapes below. These shapes are generated from the same definitions, including local JSON Schema references.
Tool groups
- analytics:
get_organization_analytics,query_google_analytics,query_organization_analytics,query_search_console - blog:
create_article_category,create_blog_post,delete_article_category,delete_blog_post,get_blog_post,list_article_categories,list_blog_posts,publish_blog_post,reorder_article_categories,reorder_blog_posts,update_article_category,update_blog_post - bookings:
cancel_product_booking,cancel_table_reservation,confirm_product_booking,create_product_booking,create_product_session,create_table_reservation,get_product_booking,list_product_booking_sessions,list_product_bookings,reassign_product_booking,reject_product_booking,request_product_booking_change,request_table_reservation_change,update_product_session - content:
append_content_block,create_site_page,delete_content_block,delete_site_page,get_reservation_policy,get_site_page,list_site_pages,replace_content_block,update_reservation_policy,update_site_page - context:
get_workspace_context,set_workspace_context - google ads:
create_google_ads_search_campaign,get_google_ads_campaign,list_google_ads_campaigns,query_google_ads_report,update_google_ads_campaign - guest messaging:
cancel_scheduled_guest_message,cancel_scheduled_reply,create_message_template,delete_message_template,get_guest_messaging_context,list_message_templates,list_scheduled_guest_messages,list_scheduled_replies,schedule_guest_reply,update_message_template,update_stay_arrival_guide - locales:
add_organization_language,delete_organization_language,delete_resource_localization,disable_organization_language,get_product_catalog_localization,get_resource_localization,list_organization_locales,publish_organization_language,put_resource_localization,replace_resource_localizations - locations:
block_dates,create_location,get_calendar,get_location,list_locations,open_dates,update_location - media:
attach_media,delete_media_asset,list_media_assets,remove_media,reorder_media,save_media_attachment,set_media,update_media_asset - organizations:
cancel_organization_invitation,create_team,delete_team,get_organization,get_organization_settings,get_website_draft,invite_organization_member,list_organization_members,list_organizations,list_teams,publish_website,remove_organization_member,save_website_draft,set_consultation_mode,set_team_member,update_organization_member_role,update_organization_settings,update_team - payments:
get_payment,get_payment_payouts,get_payment_summary,get_payments_dashboard_link,list_payments - posts:
create_post,delete_channel_post,delete_post,get_channel_post,get_post,get_social_connections,list_channel_posts,list_posts,publish_post,reconcile_post_publication,update_post - products:
batch_create_products,create_collection,create_product,delete_collection,delete_product,delete_product_booking_config,get_product,list_collections,list_location_products,list_products,reconcile_products,remove_product_location,reorder_collections,replace_product_weekly_schedule,set_collection_products,set_product_booking_config,set_product_location,set_product_publication,update_collection,update_menu,update_product - providers:
get_member_public_profile,get_member_scheduling,set_member_busy_calendars,set_member_scheduling,update_member_public_profile - qa:
create_qa,delete_qa,list_location_qa,list_organization_qa,reorder_qa,update_qa - reviews:
list_location_reviews,list_organization_reviews - stays:
assign_home_photos_to_room,cancel_stay,create_home_room,create_stay,delete_home_room,delete_stay_payment,get_stay,get_stay_calendar,list_stays,record_stay_payment,set_stay_nights,update_home_accessibility,update_home_room,update_stay - submissions:
create_inquiry,get_guest_conversation,list_guest_conversations,list_table_reservations,reply_to_guest,set_guest_conversation_archived - team messaging:
get_team_conversation,list_team_conversation_recipients,list_team_conversations,mark_team_conversation_read,send_team_message,start_team_conversation,update_team_group
Analytics
Get organization analytics — get_organization_analytics
Read website traffic, attribution, conversions, bookings, collected revenue and refunds. Amounts are minor units per currency; booking quotes are not collected revenue.
Minimum role: admin. Required entitlement: None.
Annotations: title: Get organization analytics, readOnlyHint: true, idempotentHint: true, openWorldHint: false, destructiveHint: false.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
end_date |
string | No | Inclusive local end date in YYYY-MM-DD format. Defaults to today. |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
start_date |
string | No | Inclusive local start date in YYYY-MM-DD format. Defaults to 29 days before end_date. |
additionalProperties: false; required: []
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
adSpend |
object (fields) | No | additionalProperties: false; required: ["totalSpendMicros","clicks","impressions","conversions","costPerClickMicros"] |
attributedValue |
array of object (fields) | Yes | |
attribution |
array of object (fields) | Yes | |
bookingValue |
array of object (fields) | Yes | |
cities |
array of object (fields) | Yes | |
conversions |
array of object (fields) | Yes | |
countries |
array of object (fields) | Yes | |
coverage |
object (fields) | Yes | additionalProperties: false; required: ["measurementContractStartedAt","outcomeEventsWithoutAttribution","ga4Delivery"] |
dailyConversions |
array of object (fields) | Yes | |
dailyData |
array of object (fields) | Yes | |
devices |
array of object (fields) | Yes | |
funnel |
object (fields) | Yes | additionalProperties: false; required: ["visits","viewed","intent","submitted","confirmed","paid","paidCollected","bySource","byLocation"] |
metrics |
object (fields) | Yes | additionalProperties: false; required: ["pageViews","uniqueSessions","uniqueVisitors","returningVisitors","avgSessionDuration","pagesPerSession","changePercent"] |
net |
array of object (fields) | Yes | |
outcomeAttribution |
array of object (fields) | Yes | |
period |
object (fields) | Yes | additionalProperties: false; required: ["startDate","endDate","timezone","analyticsDataStartAt","nativeCoverage"] |
referrers |
array of object (fields) | Yes | |
signupCohort |
object (fields) | Yes | additionalProperties: false; required: ["observedThrough","signups","onboardedSignups","firstPaidSignups","bySignupAttribution","onboardedBusinesses","firstPaidBusinesses"] |
topPages |
array of object (fields) | Yes | |
values |
array of object (fields) | Yes |
$schema: "https://json-schema.org/draft/2020-12/schema"; additionalProperties: false; required: ["period","metrics","dailyData","dailyConversions","topPages","attribution","outcomeAttribution","attributedValue","conversions","values","bookingValue","net","funnel","signupCohort","coverage","countries","cities","referrers","devices"]
Query Google analytics — query_google_analytics
Run a report on the connected Google Analytics 4 property: GA4 dimensions and metrics (such as date, landingPage, sessionSource, sessionMedium; activeUsers, sessions, screenPageViews, keyEvents) over one to four date ranges, with filters, ordering and paging. GA4 keeps history from before KrabiClaw; use it for periods the business's own analytics do not cover.
Minimum role: admin. Required entitlement: None.
Annotations: title: Query Google analytics, readOnlyHint: true, idempotentHint: true, openWorldHint: false, destructiveHint: false.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
date_ranges |
array of object (fields) | Yes | Days in the property time zone. Two ranges compare periods, such as this October and last October. maxItems: 4; minItems: 1 |
dimensions |
array of string (fields) | No | GA4 API dimension names. maxItems: 9 |
filters |
array of object (fields) | No | Every filter must match. maxItems: 10 |
limit |
integer | No | Rows per page (default 100). maximum: 10000; minimum: 1 |
metrics |
array of string (fields) | Yes | GA4 API metric names. maxItems: 10; minItems: 1 |
offset |
integer | No | Rows to skip, for the next page. minimum: 0 |
order_by |
object (fields) | No | additionalProperties: false; required: ["field","kind"] |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
additionalProperties: false; required: ["date_ranges","metrics"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
currency |
string | Yes | |
property_id |
string | Yes | |
property_quota |
object or null | Yes | GA4 tokens consumed and remaining for the property after this report. |
row_count |
integer | Yes | All rows the report has; page with offset. |
rows |
array of object (fields) | Yes | |
time_zone |
string | Yes |
required: ["property_id","time_zone","currency","row_count","property_quota","rows"]
Query organization analytics — query_organization_analytics
Read unsampled filtered events, sessions, breakdowns or daily summaries. Coverage reports missing facts; use next_cursor with the same query to continue. Event results omit unrestricted actor, custom-properties and metadata payloads.
Minimum role: admin. Required entitlement: None.
Annotations: title: Query organization analytics, readOnlyHint: true, idempotentHint: true, openWorldHint: false, destructiveHint: false.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
attribution_basis |
string | No | Which attribution the attribution fields read. Default event_snapshot (sessions: session_last_touch). enum: ["observed","event_snapshot","session_last_touch"] |
cursor |
string | No | next_cursor from the previous page of this same request. |
dimensions |
array of string (fields) | No | breakdown only: 1-6 fields to group by. |
end_date |
string | No | Inclusive local end date (YYYY-MM-DD). Defaults to today. |
filters |
object (fields) | No | Exact-match filters (all must match). path_prefix matches the public path or anything under it. Names are the queryable fields; enumerated ones list their values. additionalProperties: false |
limit |
integer | No | Rows per page (default 50). A page size is not a total-result limit. maximum: 200; minimum: 1 |
metrics |
array of string (fields) | No | breakdown only: 1-8 metrics. events (events); page_views (page views); interactions (interactions); outcomes (outcome events); sessions (distinct sessions); visitors (distinct visitors); entities (distinct business subjects); quoted_value_minor (minor units of the group currency); purchase_value_minor (minor units of the group currency); collected_minor (minor units of the group currency); refunded_minor (minor units of the group currency); net_collected_minor (minor units of the group currency); converting_sessions (distinct eligible sessions that completed the selected outcome in the range); eligible_sessions (distinct sessions with a pageview); session_conversion_rate (percent: converting sessions / eligible sessions, over the same sessions); checkouts_started (checkouts); payments_paid (payments); refunds_sent (refunds); checkout_conversion_rate (percent: checkouts started that were paid / checkouts started); refund_rate (percent: refunds sent / payments captured); payments_volume_minor (minor units of the group currency); avg_decision_seconds (seconds) |
mode |
string | Yes | events | sessions | breakdown | daily_summaries enum: ["events","sessions","breakdown","daily_summaries"] |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
outcome_event |
string | No | The outcome measured by converting_sessions and session_conversion_rate. |
sort |
string or object (fields) | No | events: occurred_at_desc (default) or occurred_at_asc. breakdown: { metric, direction } over a requested metric (default: the first metric, descending). Ties break deterministically. |
start_date |
string | No | Inclusive local start date (YYYY-MM-DD). Defaults to 29 days before end_date. |
additionalProperties: false; required: ["mode"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
coverage |
object | Yes | |
mode |
string | Yes | |
next_cursor |
string or null | Yes | |
query |
object | Yes | |
rows |
array of object (fields) | Yes | |
totals |
object | Yes |
required: ["mode","rows","next_cursor","query","totals","coverage"]
Query search console — query_search_console
Read organic Google Search performance for the connected Search Console property: clicks, impressions, CTR and average position by query, page, country, device, date or search appearance, with filters and paging. final reads finished days only; all includes days Google is still finalizing.
Minimum role: admin. Required entitlement: None.
Annotations: title: Query search console, readOnlyHint: true, idempotentHint: true, openWorldHint: false, destructiveHint: false.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
aggregation_type |
string | No | How results are counted: byPage counts each page; byProperty counts the site once per result. Default auto. enum: ["auto","byPage","byProperty"] |
data_state |
string | No | Default final. enum: ["final","all"] |
dimensions |
array of string (fields) | No | maxItems: 4 |
end_date |
string | Yes | Last day, inclusive. pattern: "^\d{4}-\d{2}-\d{2}$" |
filters |
array of object (fields) | No | Every filter must match. maxItems: 10 |
limit |
integer | No | Rows per page (default 1000). maximum: 25000; minimum: 1 |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
search_type |
string | No | Default web. enum: ["web","image","video","news","discover","googleNews"] |
start_date |
string | Yes | First day (Pacific Time, as Search Console counts). pattern: "^\d{4}-\d{2}-\d{2}$" |
start_row |
integer | No | Rows to skip, for the next page. minimum: 0 |
additionalProperties: false; required: ["start_date","end_date"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
aggregation |
string or null | Yes | |
data_state |
string | Yes | |
end_date |
string | Yes | |
next_start_row |
integer or null | Yes | Set when this page is full: pass it as start_row for more. Google also omits rare queries, so a last page is not every query. |
rows |
array of object (fields) | Yes | |
site_url |
string | Yes | |
start_date |
string | Yes | |
time_zone |
string | Yes | Search Console counts days in Pacific Time. |
required: ["site_url","start_date","end_date","data_state","aggregation","time_zone","next_start_row","rows"]
Blog
Create article category — create_article_category
Create a category in the blog or the documentation, at the top level or under another category (parent_id). It goes last among its siblings; place it with reorder_article_categories. Its slug comes from the name and does not change later. Returns the category and ID; articles are assigned separately.
Minimum role: admin. Required entitlement: None.
Annotations: title: Create article category, readOnlyHint: false, openWorldHint: false, destructiveHint: false.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
collection |
string | Yes | enum: ["blog","docs"] |
description |
string or null | No | What the category covers, shown on its page and used as the page description. maxLength: 500 |
name |
string | Yes | maxLength: 100; minLength: 1 |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
parent_id |
string or null | No | The category this one sits under, in the same collection; null or omitted for the top level. Categories nest at most 3 levels deep. |
additionalProperties: false; required: ["collection","name"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
category |
object (fields) | Yes | additionalProperties: false; required: ["id","collection","name","slug","description","parent_id","sort_order","article_count","child_count"] |
additionalProperties: false; required: ["category"]
Create blog post — create_blog_post
Create a draft blog or documentation article with ordered content_blocks. It stays private until published. A category in the selected collection is required for publication. Use a new idempotency_key for each article; retrying the same key returns the same article. The preview_url allows draft review. When linking to dashboard settings in markdown copy, use /dashboard/app/
Minimum role: admin. Required entitlement: None.
Annotations: title: Create blog post, readOnlyHint: false, openWorldHint: false, destructiveHint: false.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
category_id |
string | No | The article's category: the id of one of its collection's categories (list_article_categories). Required before publish_blog_post. To use a category that does not exist yet, create it with create_article_category first. |
collection |
string | No | Which of the site's collections the article belongs to: its blog, or its documentation. Defaults to the blog. enum: ["blog","docs"] |
content_blocks |
array of object (fields) | Yes | The article, in order. Any number of blocks of any type, images wherever they belong. The first block, when it is an image, is the cover. minItems: 1 |
excerpt |
string | No | |
idempotency_key |
string | Yes | A value you make up once for this article, such as a UUID, and reuse only to retry this same request. maxLength: 200; minLength: 1 |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
title |
string | Yes | |
visibility |
string | No | Unlisted posts work by direct URL but are excluded from indexes, search, feeds, and sitemap. enum: ["listed","unlisted"] |
additionalProperties: false; required: ["idempotency_key","title","content_blocks"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
post |
object (fields) | Yes | additionalProperties: false; required: ["id","title","slug","excerpt","collection","category","sort_order","seo_keywords","published","published_at","status","visibility","created_at","updated_at","cover","admin_edit_url","edit_url","public_path","public_url","preview_url","view_url","content_blocks"] |
additionalProperties: false; required: ["post"]
Delete article category — delete_article_category
Delete an empty category. A category that still has articles or subcategories is refused with how many it holds: ask the user where they should go, move each article with update_blog_post (category_id) and each subcategory with update_article_category (parent_id), then delete it.
Minimum role: admin. Required entitlement: None.
Annotations: title: Delete article category, readOnlyHint: false, openWorldHint: false, destructiveHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
category_id |
string | Yes | |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
additionalProperties: false; required: ["category_id"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
category_id |
string | Yes | |
deleted |
boolean | Yes |
additionalProperties: false; required: ["category_id","deleted"]
Delete blog post — delete_blog_post
Permanently delete the selected blog or documentation article and its owned content. Use only when the user requests removing that article; a published article is removed from the website.
Minimum role: admin. Required entitlement: None.
Annotations: title: Delete blog post, readOnlyHint: false, openWorldHint: true, destructiveHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
post_id |
string | Yes | Post id or slug. |
additionalProperties: false; required: ["post_id"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
deleted |
boolean | Yes | |
post_id |
string | Yes |
additionalProperties: false; required: ["post_id","deleted"]
Get blog post — get_blog_post
Read one blog or documentation article by ID or slug, including its ordered content_blocks and updated_at token. Use that token when editing or publishing the article.
Minimum role: admin. Required entitlement: None.
Annotations: title: Get blog post, readOnlyHint: true, idempotentHint: true, openWorldHint: false, destructiveHint: false.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
post_id |
string | Yes | Post id or slug. |
additionalProperties: false; required: ["post_id"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
post |
object (fields) | Yes | additionalProperties: false; required: ["id","title","slug","excerpt","collection","category","sort_order","seo_keywords","published","published_at","status","visibility","created_at","updated_at","cover","admin_edit_url","edit_url","public_path","public_url","preview_url","view_url","content_blocks"] |
additionalProperties: false; required: ["post"]
List article categories — list_article_categories
List categories and subcategories in one site blog or documentation collection, in public display order, with article and child-category counts. Published articles require a category in their collection.
Minimum role: admin. Required entitlement: None.
Annotations: title: List article categories, readOnlyHint: true, idempotentHint: true, openWorldHint: false, destructiveHint: false.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
collection |
string | Yes | enum: ["blog","docs"] |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
additionalProperties: false; required: ["collection"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
categories |
array of object (fields) | Yes |
additionalProperties: false; required: ["categories"]
List blog posts — list_blog_posts
List draft and published long-form articles in the selected site’s blog or documentation collection. Results are paginated in public display order. Short website posts are listed separately by list_posts.
Minimum role: admin. Required entitlement: None.
Annotations: title: List blog posts, readOnlyHint: true, idempotentHint: true, openWorldHint: false, destructiveHint: false.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
collection |
string | No | enum: ["blog","docs"] |
cursor |
string | No | Opaque next_cursor from the previous page. |
limit |
number | No | Page size. Defaults to 50; maximum 100. maximum: 100; minimum: 1 |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
status |
string | No | enum: ["draft","published"] |
additionalProperties: false; required: []
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
page_info |
object (fields) | Yes | required: ["has_more","next_cursor"] |
posts |
array of object (fields) | Yes |
additionalProperties: false; required: ["posts","page_info"]
Publish blog post — publish_blog_post
Publish the selected draft blog or documentation article when publication is requested. Requires expected_updated_at from the latest read. An already published article is unchanged, including its date and announcement. Returns its publication state, revision and website URL; this does not publish to Facebook or Instagram.
Minimum role: admin. Required entitlement: None.
Annotations: title: Publish blog post, readOnlyHint: false, openWorldHint: true, destructiveHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
expected_updated_at |
string | Yes | Exact post.updated_at concurrency token from the latest get_blog_post or successful blog mutation. |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
post_id |
string | Yes | Post id or slug. |
additionalProperties: false; required: ["post_id","expected_updated_at"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
changed |
boolean | Yes | |
post |
object (fields) | Yes | additionalProperties: false; required: ["id","title","collection","visibility","status","published","published_at","updated_at","public_url"] |
additionalProperties: false; required: ["post","changed"]
Reorder article categories — reorder_article_categories
Set the order of one set of sibling categories on the public site — the index, its sidebar and the menu: the collection's top level (parent_id null or omitted), or one category's subcategories. Send every sibling id exactly once; a partial order is rejected.
Minimum role: admin. Required entitlement: None.
Annotations: title: Reorder article categories, readOnlyHint: false, openWorldHint: true, destructiveHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
category_ids |
array of string (fields) | Yes | minItems: 1 |
collection |
string | Yes | enum: ["blog","docs"] |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
parent_id |
string or null | No | Whose subcategories are being ordered; null or omitted for the top level. |
additionalProperties: false; required: ["collection","category_ids"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
categories |
array of object (fields) | Yes |
additionalProperties: false; required: ["categories"]
Reorder blog posts — reorder_blog_posts
Replace the public display order of articles in one blog or documentation collection. Supply every article ID in that collection exactly once, including drafts. New articles with sort_order 0 appear first until ordered; category ordering is separate.
Minimum role: admin. Required entitlement: None.
Annotations: title: Reorder blog posts, readOnlyHint: false, openWorldHint: true, destructiveHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
collection |
string | Yes | enum: ["blog","docs"] |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
post_ids |
array of string (fields) | Yes | minItems: 1 |
additionalProperties: false; required: ["collection","post_ids"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
posts |
array of object (fields) | Yes |
required: ["posts"]
Update article category — update_article_category
Rename a category, change its description, or move it under another category (parent_id; null moves it to the top level, where it goes last). Its page's address (slug) stays the same. Omitted fields stay unchanged; returns the updated category without moving its articles.
Minimum role: admin. Required entitlement: None.
Annotations: title: Update article category, readOnlyHint: false, openWorldHint: true, destructiveHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
category_id |
string | Yes | |
description |
string or null | No | maxLength: 500 |
name |
string | No | maxLength: 100; minLength: 1 |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
parent_id |
string or null | No | Omit to retain the current parent; null moves the category to the top level. A supplied parent must be in the same collection. Categories nest at most 3 levels deep. |
additionalProperties: false; required: ["category_id"]
anyOf: shape 1, shape 2, shape 3.
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
category |
object (fields) | Yes | additionalProperties: false; required: ["id","collection","name","slug","description","parent_id","sort_order","article_count","child_count"] |
additionalProperties: false; required: ["category"]
Update blog post — update_blog_post
Edit the selected blog or documentation article. Only supplied metadata changes; content_blocks replaces the entire body and requires expected_updated_at from the latest read. Stale tokens conflict. Changes to a published article are public immediately. When linking to dashboard settings in markdown copy, use /dashboard/app/
Minimum role: admin. Required entitlement: None.
Annotations: title: Update blog post, readOnlyHint: false, openWorldHint: true, destructiveHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
category_id |
string | No | The article's category: the id of one of its collection's categories (list_article_categories). Required before publish_blog_post. To use a category that does not exist yet, create it with create_article_category first. |
collection |
string | No | Move the article to the site's blog or its documentation. Omit to leave it where it is. enum: ["blog","docs"] |
content_blocks |
array of object (fields) | No | The whole article, in order, replacing every block. Blocks read back keep their id. The first block, when it is an image, is the cover. minItems: 1 |
excerpt |
string | No | |
expected_updated_at |
string | No | Required with content_blocks. Use updated_at returned by get_blog_post; stale tokens are rejected with a conflict. |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
post_id |
string | Yes | Post id or slug. |
title |
string | No | |
visibility |
string | No | enum: ["listed","unlisted"] |
additionalProperties: false; required: ["post_id"]
anyOf: shape 1, shape 2, shape 3, shape 4, shape 5, shape 6.
allOf: shape 1.
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
changed |
boolean | Yes | Whether this request changed the stored article. An equivalent save leaves its revision unchanged. |
post |
object (fields) | Yes | additionalProperties: false; required: ["id","title","slug","excerpt","collection","category","sort_order","seo_keywords","published","published_at","status","visibility","created_at","updated_at","cover","admin_edit_url","edit_url","public_path","public_url","preview_url","view_url","content_blocks"] |
additionalProperties: false; required: ["post","changed"]
Bookings
Cancel product booking — cancel_product_booking
Cancel a pending or confirmed product booking or consultation before it ends, release its places and email the guest. A required refund returns financial_action_required and a dashboard URL before status changes.
Minimum role: member. Required entitlement: None.
Annotations: title: Cancel product booking, readOnlyHint: false, openWorldHint: true, destructiveHint: true, idempotentHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
idempotency_key |
string | Yes | Caller-supplied durable idempotency key. Reuse only for the identical operation. maxLength: 200; minLength: 1 |
operational_booking_id |
string | Yes | Booking ID returned by list_product_bookings or create_product_booking. Distinct from request_id, which identifies the inbox conversation. |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
additionalProperties: false; required: ["operational_booking_id","idempotency_key"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
availableActions |
array of string (fields) | Yes | |
ok |
boolean | Yes | const: true |
record |
object (fields) | Yes | required: ["id","kind","status","party_size","starts_at","ends_at","timezone","assigned_member_id","location_id","product_id","product_name"] |
request_id |
string | Yes | minLength: 1 |
status |
number | Yes | const: 200 |
thread |
object (fields) | Yes | required: ["id","kind","conversation_state"] |
required: ["ok","status","request_id","record","availableActions","thread"]
Cancel table reservation — cancel_table_reservation
Cancel a table reservation, release its capacity and email the guest. A required refund returns financial_action_required and a dashboard URL before cancellation.
Minimum role: admin. Required entitlement: None.
Annotations: title: Cancel table reservation, readOnlyHint: false, openWorldHint: true, destructiveHint: true, idempotentHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
idempotency_key |
string | Yes | Caller-supplied durable idempotency key. Reuse only for the identical operation. maxLength: 200; minLength: 1 |
operational_reservation_id |
string | Yes | operational_reservation_id from list_table_reservations. Distinct from request_id, the inbox conversation ID. |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
additionalProperties: false; required: ["operational_reservation_id","idempotency_key"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
availableActions |
array of string (fields) | Yes | |
ok |
boolean | Yes | const: true |
record |
object (fields) | Yes | required: ["id","kind","status","party_size","starts_at","ends_at","timezone","assigned_member_id","location_id","product_id","product_name"] |
request_id |
string | Yes | minLength: 1 |
status |
number | Yes | const: 200 |
thread |
object (fields) | Yes | required: ["id","kind","conversation_state"] |
required: ["ok","status","request_id","record","availableActions","thread"]
Confirm product booking — confirm_product_booking
Confirm a pending product booking or consultation after staff review and email the guest, keeping its session and places. No payment is collected.
Minimum role: member. Required entitlement: None.
Annotations: title: Confirm product booking, readOnlyHint: false, openWorldHint: true, destructiveHint: true, idempotentHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
idempotency_key |
string | Yes | Caller-supplied durable idempotency key. Reuse only for the identical operation. maxLength: 200; minLength: 1 |
operational_booking_id |
string | Yes | Booking ID returned by list_product_bookings or create_product_booking. Distinct from request_id, which identifies the inbox conversation. |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
additionalProperties: false; required: ["operational_booking_id","idempotency_key"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
availableActions |
array of string (fields) | Yes | |
ok |
boolean | Yes | const: true |
record |
object (fields) | Yes | required: ["id","kind","status","party_size","starts_at","ends_at","timezone","assigned_member_id","location_id","product_id","product_name"] |
request_id |
string | Yes | minLength: 1 |
status |
number | Yes | const: 200 |
thread |
object (fields) | Yes | required: ["id","kind","conversation_state"] |
required: ["ok","status","request_id","record","availableActions","thread"]
Create product booking — create_product_booking
Book the named guest at a returned product session; review offerings start pending and instant offerings confirmed. Required online payment returns financial_action_required and a dashboard URL before any booking is created.
Minimum role: admin. Required entitlement: None.
Annotations: title: Create product booking, readOnlyHint: false, openWorldHint: true, destructiveHint: true, idempotentHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
answers |
array of object (fields) | No | Answers to the configured questions by question ID: text for short_text/long_text, a choice ID for single_choice, choice IDs for multiple_choice, true or false for yes_no. Required questions must be answered. Questions are get_product → booking.questions. maxItems: 20 |
external_reference |
string | No | maxLength: 200 |
guest_acknowledgement |
boolean | Yes | Explicit choice to send the guest creation email. Owner alerts, inbox, and audit always remain. |
guest_email |
string | Yes | |
guest_name |
string | Yes | minLength: 1 |
guest_phone |
string | No | Optional. International number with its country calling code, e.g. +66812345678. |
idempotency_key |
string | Yes | Caller-supplied durable idempotency key. Reuse only for the identical operation. maxLength: 200; minLength: 1 |
locale |
string | No | Guest confirmation language code; defaults to the website language. |
notes |
string | No | maxLength: 1000 |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
party_size |
integer | Yes | maximum: 99; minimum: 1 |
product_slug |
string | Yes | Offering slug from list_products or get_product, not its product ID. |
questions_revision |
string | No | The questions_revision the answers were collected against. Required with answers; a changed revision returns questions_changed with the current questions. |
session_id |
string | Yes | Available session ID from list_product_booking_sessions. |
source |
string | Yes | Explicit provenance, such as operator or external scheduler. maxLength: 100; minLength: 1 |
variant_id |
string | No |
additionalProperties: false; required: ["product_slug","session_id","party_size","guest_name","guest_email","idempotency_key","source","guest_acknowledgement"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
http_status |
integer | Yes | maximum: 299; minimum: 200 |
operational_booking_id |
string | Yes | minLength: 1 |
replayed |
boolean | No | |
request_id |
string | Yes | minLength: 1 |
status |
string | Yes | enum: ["pending","confirmed","cancelled"] |
success |
boolean | Yes | const: true |
required: ["success","operational_booking_id","request_id","status","http_status"]
Create product session — create_product_session
Add a dated time at a location for an existing bookable offering using its actual start and end. An assigned team gets one session per member. Online offerings take no dated sessions: they are booked in their provider's working hours.
Minimum role: member. Required entitlement: None.
Annotations: title: Create product session, readOnlyHint: false, openWorldHint: true, destructiveHint: false, idempotentHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
capacity |
integer or null | No | minimum: 0 |
ends_at |
string | Yes | format: "date-time" |
idempotency_key |
string | Yes | Caller-supplied durable idempotency key. Reuse only for the identical operation. maxLength: 200; minLength: 1 |
location_id |
string | Yes | Session location. minLength: 1 |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
product_id |
string | Yes | minLength: 1 |
starts_at |
string | Yes | format: "date-time" |
additionalProperties: false; required: ["product_id","location_id","starts_at","ends_at","idempotency_key"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
sessions |
array of object (fields) | Yes | minItems: 1 |
required: ["sessions"]
Create table reservation — create_table_reservation
Reserve a table for a named guest at a location’s local date and time under its saved reservation policy. Required deposits return financial_action_required and a dashboard URL before confirmation.
Minimum role: admin. Required entitlement: None.
Annotations: title: Create table reservation, readOnlyHint: false, openWorldHint: true, destructiveHint: true, idempotentHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
answers |
array of object (fields) | No | Answers to the configured questions by question ID: text for short_text/long_text, a choice ID for single_choice, choice IDs for multiple_choice, true or false for yes_no. Required questions must be answered. Questions come from get_reservation_policy. maxItems: 20 |
date |
string | Yes | pattern: "^\d{4}-\d{2}-\d{2}$" |
external_reference |
string | No | |
guest_acknowledgement |
boolean | Yes | Explicit choice to email the guest; owner alerts, inbox and audit are always recorded. |
guest_email |
string | Yes | |
guest_name |
string | Yes | minLength: 1 |
guest_phone |
string | Yes | International number with its country calling code, e.g. +66812345678. |
idempotency_key |
string | Yes | Caller-supplied durable idempotency key. Reuse only for the identical operation. maxLength: 200; minLength: 1 |
locale |
string | No | Guest confirmation language code; defaults to the website language. |
location_id |
string | Yes | |
notes |
string | No | maxLength: 1000 |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
party_size |
integer | Yes | maximum: 99; minimum: 1 |
questions_revision |
string | No | The questions_revision the answers were collected against. Required with answers; a changed revision returns questions_changed with the current questions. |
source |
string | Yes | minLength: 1 |
time |
string | Yes | pattern: "^([01]\d|2[0-3]):[0-5]\d$" |
additionalProperties: false; required: ["location_id","date","time","party_size","guest_name","guest_email","guest_phone","idempotency_key","source","guest_acknowledgement"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
http_status |
integer | Yes | |
operational_reservation_id |
string | Yes | minLength: 1 |
replayed |
boolean | No | |
request_id |
string | Yes | minLength: 1 |
status |
string | Yes | |
success |
boolean | Yes | const: true |
required: ["success","request_id","operational_reservation_id","status","http_status"]
Get product booking — get_product_booking
Read one product booking or consultation when the user wants its guest details, answers to the offering's questions, status or current session. Use updated_at when proposing a change and operational_updated_at when reassigning its provider.
Minimum role: member. Required entitlement: None.
Annotations: title: Get product booking, readOnlyHint: true, idempotentHint: true, openWorldHint: false, destructiveHint: false.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
operational_booking_id |
string | Yes | Booking ID returned by list_product_bookings or create_product_booking. Distinct from request_id, which identifies the inbox conversation. |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
additionalProperties: false; required: ["operational_booking_id"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
answers |
array of object (fields) | Yes | Answers to the tenant's own questions, with the wording the guest answered. Later edits to the questions do not change them. |
guest |
object (fields) | Yes | required: ["name","email"] |
operational_booking_id |
string | Yes | minLength: 1 |
operational_updated_at |
string | Yes | minLength: 1 |
provenance |
object or null (fields) | Yes | required: ["source","external_reference","guest_acknowledgement"] |
record |
object (fields) | Yes | required: ["id","kind","status","party_size","starts_at","ends_at","timezone","assigned_member_id","location_id","product_id","product_name"] |
request_id |
string | Yes | minLength: 1 |
updated_at |
string | Yes | minLength: 1 |
required: ["operational_booking_id","request_id","updated_at","operational_updated_at","guest","answers","provenance","record"]
List product booking sessions — list_product_booking_sessions
Read scheduled times and remaining places for a product, including shared calendar conflicts. Choose a returned session ID to create or change a booking.
Minimum role: member. Required entitlement: None.
Annotations: title: List product booking sessions, readOnlyHint: true, idempotentHint: true, openWorldHint: false, destructiveHint: false.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
cursor |
string | No | Opaque next_cursor from the previous page. |
from |
string | Yes | Inclusive ISO UTC instant. |
limit |
number | No | Page size. Defaults to 50; maximum 100. maximum: 100; minimum: 1 |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
product_id |
string | Yes | |
to |
string | Yes | Exclusive ISO UTC instant, at most 93 days after from. |
additionalProperties: false; required: ["product_id","from","to"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
page_info |
object (fields) | Yes | required: ["has_more","next_cursor"] |
sessions |
array of object (fields) | Yes |
required: ["sessions","page_info"]
List product bookings — list_product_bookings
Read product bookings and consultations with guest names, session times, assigned members and status; use operational_booking_id to manage a booking. Use get_product_booking for one booking’s guest contact details. Restaurant table reservations use list_table_reservations.
Minimum role: member. Required entitlement: None.
Annotations: title: List product bookings, readOnlyHint: true, idempotentHint: true, openWorldHint: false, destructiveHint: false.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
assigned_member_id |
string | No | |
cursor |
string | No | Opaque next_cursor from the previous page. |
from |
string | No | Inclusive session start instant. |
limit |
number | No | Page size. Defaults to 50; maximum 100. maximum: 100; minimum: 1 |
location_id |
string or null | No | |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
product_id |
string | No | |
status |
string | No | enum: ["pending","confirmed","completed","cancelled"] |
to |
string | No | Exclusive session start instant. |
additionalProperties: false; required: []
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
bookings |
array of object (fields) | Yes | |
page_info |
object (fields) | Yes | required: ["has_more","next_cursor"] |
required: ["bookings","page_info"]
Reassign product booking — reassign_product_booking
Propose a same-time attorney replacement for one consultation. The current appointment and other clients remain unchanged until this client accepts in their conversation. Uses a published available session for that attorney. Read get_product_booking and supply operational_updated_at.
Minimum role: admin. Required entitlement: None.
Annotations: title: Reassign product booking, readOnlyHint: false, openWorldHint: true, destructiveHint: true, idempotentHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
expected_updated_at |
string | Yes | operational_updated_at from get_product_booking. |
idempotency_key |
string | Yes | Caller-supplied durable idempotency key. Reuse only for the identical operation. maxLength: 120; minLength: 1 |
member_id |
string | Yes | Better Auth organization member ID from get_member_scheduling or list_teams. |
operational_booking_id |
string | Yes | Booking ID returned by list_product_bookings or create_product_booking. Distinct from request_id, which identifies the inbox conversation. |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
additionalProperties: false; required: ["operational_booking_id","member_id","expected_updated_at","idempotency_key"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
assigned_member_id |
string or null | Yes | |
change_status |
string | Yes | enum: ["awaiting_guest_acceptance","accepted","declined"] |
request_id |
string | Yes | minLength: 1 |
session_id |
string | Yes | minLength: 1 |
required: ["session_id","assigned_member_id","request_id","change_status"]
Reject product booking — reject_product_booking
Decline a pending product booking or consultation, release its places and email the guest. A required refund returns financial_action_required and a dashboard URL before status changes.
Minimum role: member. Required entitlement: None.
Annotations: title: Reject product booking, readOnlyHint: false, openWorldHint: true, destructiveHint: true, idempotentHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
idempotency_key |
string | Yes | Caller-supplied durable idempotency key. Reuse only for the identical operation. maxLength: 200; minLength: 1 |
operational_booking_id |
string | Yes | Booking ID returned by list_product_bookings or create_product_booking. Distinct from request_id, which identifies the inbox conversation. |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
additionalProperties: false; required: ["operational_booking_id","idempotency_key"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
availableActions |
array of string (fields) | Yes | |
ok |
boolean | Yes | const: true |
record |
object (fields) | Yes | required: ["id","kind","status","party_size","starts_at","ends_at","timezone","assigned_member_id","location_id","product_id","product_name"] |
request_id |
string | Yes | minLength: 1 |
status |
number | Yes | const: 200 |
thread |
object (fields) | Yes | required: ["id","kind","conversation_state"] |
required: ["ok","status","request_id","record","availableActions","thread"]
Request product booking change — request_product_booking_change
Email the guest a proposal to change a booking’s session or party size. The current booking and places remain unchanged until guest acceptance, which requires availability and preserves its review status. Consultation time and attorney changes always require client acceptance. For other booking kinds, apply moves the booking now and emails the guest; a paid quantity or location change is refused.
Minimum role: member. Required entitlement: None.
Annotations: title: Request product booking change, readOnlyHint: false, openWorldHint: true, destructiveHint: true, idempotentHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
apply |
boolean | No | For bookings other than consultations, move immediately and email the guest. Consultations always require client acceptance. |
assigned_member_id |
string | No | Optional explicit target attorney member ID; must match the selected session. |
expected_updated_at |
string | Yes | Thread updated_at from get_product_booking. |
idempotency_key |
string | Yes | Caller-supplied durable idempotency key. Reuse only for the identical operation. maxLength: 200; minLength: 1 |
operational_booking_id |
string | Yes | Booking ID returned by list_product_bookings or create_product_booking. Distinct from request_id, which identifies the inbox conversation. |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
party_size |
integer | Yes | maximum: 99; minimum: 1 |
session_id |
string | Yes |
additionalProperties: false; required: ["operational_booking_id","session_id","party_size","expected_updated_at","idempotency_key"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
change_status |
string | Yes | enum: ["awaiting_guest_acceptance","accepted","declined","moved"] |
record |
object (fields) | Yes | required: ["id","kind","status","party_size","starts_at","ends_at","timezone","assigned_member_id","location_id","product_id","product_name"] |
request_id |
string | Yes | minLength: 1 |
success |
boolean | Yes | const: true |
required: ["success","request_id","change_status","record"]
Request table reservation change — request_table_reservation_change
Email the guest a proposal to change a table reservation’s location, local date, time or party size. The current reservation remains unchanged until the guest accepts. With apply, the reservation moves now and the guest is emailed the new time; a change outside the change policy or that needs the guest’s consent is refused.
Minimum role: admin. Required entitlement: None.
Annotations: title: Request table reservation change, readOnlyHint: false, openWorldHint: true, destructiveHint: true, idempotentHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
apply |
boolean | No | Move the reservation now instead of asking the guest. The guest is emailed the new time. |
date |
string | Yes | pattern: "^\d{4}-\d{2}-\d{2}$" |
expected_updated_at |
string | Yes | Conversation updated_at from list_table_reservations or get_guest_conversation, not an operational reservation timestamp. |
idempotency_key |
string | Yes | Caller-supplied durable idempotency key. Reuse only for the identical operation. maxLength: 200; minLength: 1 |
location_id |
string | Yes | |
operational_reservation_id |
string | Yes | operational_reservation_id from list_table_reservations. Distinct from request_id, the inbox conversation ID. |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
override_policy |
boolean | No | True only when the business approves an exception to its change policy. |
party_size |
integer | Yes | maximum: 99; minimum: 1 |
time |
string | Yes | pattern: "^([01]\d|2[0-3]):[0-5]\d$" |
additionalProperties: false; required: ["operational_reservation_id","location_id","date","time","party_size","expected_updated_at","idempotency_key"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
change_status |
string | Yes | enum: ["awaiting_guest_acceptance","accepted","declined","moved"] |
record |
object (fields) | Yes | required: ["id","kind","status","party_size","starts_at","ends_at","timezone","assigned_member_id","location_id","product_id","product_name"] |
request_id |
string | Yes | minLength: 1 |
success |
boolean | Yes | const: true |
required: ["success","request_id","change_status","record"]
Update product session — update_product_session
Edit one session’s time, capacity or state using its current timestamp. Committed bookings or checkout holds prevent time or state changes; use the guest booking-change workflow.
Minimum role: member. Required entitlement: None.
Annotations: title: Update product session, readOnlyHint: false, openWorldHint: true, destructiveHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
capacity |
integer or null | No | minimum: 0 |
ends_at |
string | No | format: "date-time" |
expected_updated_at |
string | Yes | Session updated_at from list_product_booking_sessions. minLength: 1 |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
product_id |
string | Yes | minLength: 1 |
session_id |
string | Yes | minLength: 1 |
starts_at |
string | No | format: "date-time" |
status |
string | No | enum: ["scheduled","cancelled"] |
additionalProperties: false; required: ["product_id","session_id","expected_updated_at"]
anyOf: shape 1, shape 2, shape 3, shape 4.
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
session |
object (fields) | Yes | required: ["id","organization_id","product_id","location_id","assigned_member_id","starts_at","ends_at","timezone","capacity","status","claimed","remaining","is_full","updated_at"] |
required: ["session"]
Content
Append content block — append_content_block
Add a block to an existing article or site page, returning the changed block and document timestamp. An image in the first article block becomes its cover.
Minimum role: admin. Required entitlement: None.
Annotations: title: Append content block, readOnlyHint: false, openWorldHint: true, destructiveHint: false.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
after_block_id |
string or null | No | The block this one follows. Omit to append at the end. |
data |
#/$defs/content_heading or #/$defs/content_markdown or #/$defs/content_image or #/$defs/content_gallery or #/$defs/content_video or #/$defs/content_faq or #/$defs/content_how_to or #/$defs/content_divider or #/$defs/content_cta or #/$defs/content_contact_cta or #/$defs/content_booking_cta or #/$defs/content_callout or #/$defs/content_hero or #/$defs/content_button_group or #/$defs/content_feature_grid or #/$defs/content_comparison or #/$defs/content_stat_grid or #/$defs/content_workflow_grid or #/$defs/content_showcase or #/$defs/content_language_reach or #/$defs/content_steps or #/$defs/content_video_feature or #/$defs/content_media_text or #/$defs/content_contact_form or #/$defs/content_team_grid or #/$defs/content_testimonial_grid or #/$defs/content_donation_choices or #/$defs/content_page_grid or #/$defs/content_product_grid or #/$defs/content_location_grid or #/$defs/content_social_posts or #/$defs/content_ai_assistance (fields) | Yes | |
document_id |
string | Yes | The blog post id or site page variant id. |
level |
integer or null | No | Heading blocks only. maximum: 6; minimum: 1 |
media |
array of #/$defs/content_block_media (fields) | No | Required on image blocks: one item, the picture. Send a block's media as a read returned it. |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
type |
string | Yes | enum: ["heading","markdown","image","gallery","video","faq","how_to","divider","cta","contact_cta","booking_cta","callout","hero","button_group","feature_grid","comparison","stat_grid","workflow_grid","showcase","language_reach","steps","video_feature","media_text","contact_form","team_grid","testimonial_grid","donation_choices","page_grid","product_grid","location_grid","social_posts","ai_assistance"] |
additionalProperties: false; required: ["document_id","type","data"]
anyOf: shape 1, shape 2, shape 3, shape 4, shape 5, shape 6, shape 7, shape 8, shape 9, shape 10, shape 11, shape 12, shape 13, shape 14, shape 15, shape 16, shape 17, shape 18, shape 19, shape 20, shape 21, shape 22, shape 23, shape 24, shape 25, shape 26, shape 27, shape 28, shape 29, shape 30, shape 31, shape 32.
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
blocks |
array of object (fields) | Yes | Changed blocks with IDs and timestamps; empty after deletion. |
document_id |
string | Yes | |
updated_at |
string | Yes | The document's new concurrency token. |
additionalProperties: false; required: ["document_id","updated_at","blocks"]
Create site page — create_site_page
Add a new authored site page or a new language version of an existing source page. Existing document IDs and occupied language paths are refused; existing pages and their content are retained. Supply the actual content for the named language; no translation is generated. Pages on a live site can become public immediately. Returns the new document, blocks and editor information.
Minimum role: admin. Required entitlement: None.
Annotations: title: Create site page, readOnlyHint: false, openWorldHint: true, destructiveHint: false.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
blocks |
array of object (fields) | Yes | Ordered blocks for the new page. Existing pages and their blocks are not replaced. Block data contains no asset IDs or delivery URLs; use each block’s media field for its saved media placements. |
locale |
string or null | No | Authored language of the new page version. Omit or use null for the site’s source language. |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
pageType |
string | No | Type of a new source page. A language version inherits its source page’s type; omit this field or supply the same type. enum: ["custom","recipe","legal","system"] |
page_id |
string or null | No | Existing source page ID only when adding a new secondary-language version. Omit or use null for a new source page. |
path |
string | Yes | New unused path in this language. An occupied path or redirect is refused; creation does not move an existing page. |
recipe |
string or null | No | Template section a new source page fills, or null for none. A language version inherits its source page’s recipe when omitted; an explicit value, including null, must match the source. |
sortOrder |
number | No | Position of a new source page in the site’s page list. Language versions inherit the source page’s position and must omit this field. |
summary |
string or null | No | Summary of the new page; null means no summary. |
title |
string | Yes | The page's name, e.g. About. The site name is appended to the browser title. Always sent in full — an omitted title is not kept. |
variant_id |
string or null | No | Optional new document ID. An existing document ID is refused. |
additionalProperties: false; required: ["path","title","blocks"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
page |
object (fields) | Yes | required: ["id","page_id","organization_id","product_id","locale","path","title","summary","page_type","recipe","sort_order","updated_at","blocks","document","admin_edit_url"] |
required: ["page"]
Delete content block — delete_content_block
Permanently delete one block and its descendants from an article or site page; published content changes immediately. Returns the document timestamp and no blocks.
Minimum role: admin. Required entitlement: None.
Annotations: title: Delete content block, readOnlyHint: false, openWorldHint: true, destructiveHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
block_id |
string | Yes | |
expected_updated_at |
string | Yes | The block's updated_at from the last read. |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
additionalProperties: false; required: ["block_id","expected_updated_at"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
blocks |
array of object (fields) | Yes | Changed blocks with IDs and timestamps; empty after deletion. |
document_id |
string | Yes | |
updated_at |
string | Yes | The document's new concurrency token. |
additionalProperties: false; required: ["document_id","updated_at","blocks"]
Delete site page — delete_site_page
Delete the selected site page or translation. Deleting a translation removes that translation; deleting the source locale removes the page and every translation with it, and the response names the locales that went. A required site page cannot be deleted, because its route would then have nothing to show.
Minimum role: admin. Required entitlement: None.
Annotations: title: Delete site page, readOnlyHint: false, openWorldHint: true, destructiveHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
expected_updated_at |
string | Yes | The document timestamp from the last read, so a page edited since is refused rather than silently removed. |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
variant_id |
string | Yes |
additionalProperties: false; required: ["variant_id","expected_updated_at"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
deleted |
object (fields) | Yes | required: ["id","path","locale","removed_locales"] |
required: ["deleted"]
Get reservation policy — get_reservation_policy
Read one location’s table reservation settings and guest-facing policy summary. Product session bookings use get_product for their separate configuration.
Minimum role: admin. Required entitlement: None.
Annotations: title: Get reservation policy, readOnlyHint: true, idempotentHint: true, openWorldHint: false, destructiveHint: false.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
locale |
string | No | |
location_id |
string | Yes | |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
additionalProperties: false; required: ["location_id"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
cancellation_policy |
string or null | Yes | The named cancellation policy the dashboard shows, or null when the stored cutoffs match none of them. enum: ["flexible","moderate","firm",null] |
policy |
object (fields) | Yes | required: ["location_id","duration_minutes","reschedule_allowed","deposit_required","accessibility_contact_required","questions","questions_revision","created_at","updated_at"] |
summary |
object (fields) | Yes | required: ["heading","items","additional_notes_html"] |
required: ["policy","cancellation_policy","summary"]
Get site page — get_site_page
Read one site-page language variant, including its path, title, ordered blocks and current timestamp. Use its returned IDs and concurrency information for edits.
Minimum role: admin. Required entitlement: None.
Annotations: title: Get site page, readOnlyHint: true, idempotentHint: true, openWorldHint: false, destructiveHint: false.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
variant_id |
string | Yes |
additionalProperties: false; required: ["variant_id"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
page |
object (fields) | Yes | required: ["id","page_id","organization_id","product_id","locale","path","title","summary","page_type","recipe","sort_order","updated_at","blocks","document","admin_edit_url"] |
required: ["page"]
List site pages — list_site_pages
List authored pages and built-in public routes. Catalog routes display published products; they do not require custom page creation.
Minimum role: admin. Required entitlement: None.
Annotations: title: List site pages, readOnlyHint: true, idempotentHint: true, openWorldHint: false, destructiveHint: false.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
cursor |
string | No | Opaque next_cursor from the previous page. |
limit |
number | No | Page size. Defaults to 50; maximum 100. maximum: 100; minimum: 1 |
locale |
string or null | No | |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
additionalProperties: false; required: []
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
built_in_pages |
array of object (fields) | Yes | |
page_info |
object (fields) | Yes | required: ["has_more","next_cursor"] |
pages |
array of object (fields) | Yes |
required: ["pages","built_in_pages","page_info"]
Replace content block — replace_content_block
Replace one block’s complete data, keeping its ID and position; published content changes immediately. Read it first and preserve content outside the requested change; returns the changed block and document timestamp.
Minimum role: admin. Required entitlement: None.
Annotations: title: Replace content block, readOnlyHint: false, openWorldHint: true, destructiveHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
block_id |
string | Yes | |
data |
#/$defs/content_heading or #/$defs/content_markdown or #/$defs/content_image or #/$defs/content_gallery or #/$defs/content_video or #/$defs/content_faq or #/$defs/content_how_to or #/$defs/content_divider or #/$defs/content_cta or #/$defs/content_contact_cta or #/$defs/content_booking_cta or #/$defs/content_callout or #/$defs/content_hero or #/$defs/content_button_group or #/$defs/content_feature_grid or #/$defs/content_comparison or #/$defs/content_stat_grid or #/$defs/content_workflow_grid or #/$defs/content_showcase or #/$defs/content_language_reach or #/$defs/content_steps or #/$defs/content_video_feature or #/$defs/content_media_text or #/$defs/content_contact_form or #/$defs/content_team_grid or #/$defs/content_testimonial_grid or #/$defs/content_donation_choices or #/$defs/content_page_grid or #/$defs/content_product_grid or #/$defs/content_location_grid or #/$defs/content_social_posts or #/$defs/content_ai_assistance (fields) | Yes | Complete replacement data; omitted fields are removed. |
expected_updated_at |
string | Yes | The block's updated_at from the last read. |
media |
array of #/$defs/content_block_media (fields) | No | Omit to retain existing placements; supply the complete array to replace them. |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
additionalProperties: false; required: ["block_id","expected_updated_at","data"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
blocks |
array of object (fields) | Yes | Changed blocks with IDs and timestamps; empty after deletion. |
document_id |
string | Yes | |
updated_at |
string | Yes | The document's new concurrency token. |
additionalProperties: false; required: ["document_id","updated_at","blocks"]
Update reservation policy — update_reservation_policy
Enable or update table reservations using the location’s saved hours, including the questions asked with each reservation. New setup defaults to two hours, unlimited capacity, no advance notice and no deposit. Use the current updated_at when amending it; omitted fields keep their value. Deposits need an amount, currency, tax treatment and ready Payments.
Minimum role: admin. Required entitlement: None.
Annotations: title: Update reservation policy, readOnlyHint: false, openWorldHint: true, destructiveHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
accessibility_contact_required |
boolean | No | |
additional_notes_html |
string or null | No | Guest-facing notes. Sanitized on the way in; only basic formatting and links survive. |
advance_notice_minutes |
number or null | No | Required notice before the start. Defaults to zero on setup; null removes the rule. minimum: 0 |
cancellation_policy |
string | No | Flexible: 2 hours. Moderate: 1 day. Firm: 2 days. Sets the deposit-refund and reschedule cutoffs together; do not also pass those fields. enum: ["flexible","moderate","firm"] |
deposit_amount |
integer or null | No | Total deposit per reservation, in deposit_currency minor units. minimum: 1 |
deposit_currency |
string or null | No | ISO 4217 currency code. pattern: "^[A-Z]{3}$" |
deposit_required |
boolean | No | Defaults to false on setup. Omit to keep the current requirement. |
deposit_tax_behavior |
string or null | No | enum: ["inclusive","exclusive",null] |
deposit_trigger_party_size |
number or null | No | minimum: 1 |
duration_minutes |
integer or null | No | Minutes per reservation. Defaults to 120 on setup; null restores that default. Omit to keep the current duration. default: 120; minimum: 1 |
expected_questions_revision |
string | No | policy.questions_revision from get_reservation_policy; required with questions. |
expected_updated_at |
string or null | Yes | Current policy updated_at; null when creating. |
free_cancellation_until_minutes |
number or null | No | minimum: 0 |
locale |
string | No | |
location_id |
string | Yes | |
minimum_guest_age |
number or null | No | minimum: 0 |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
questions |
array of object (fields) | No | Replace the questions asked with each reservation. Read get_reservation_policy first and keep existing question IDs. maxItems: 20 |
reschedule_allowed |
boolean | No | |
reschedule_cutoff_minutes |
number or null | No | minimum: 0 |
slot_capacity |
number or null | No | Guests per start time. Defaults to unlimited on setup; null removes the limit. minimum: 0 |
additionalProperties: false; required: ["location_id","expected_updated_at"]
allOf: shape 1.
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
changed_fields |
array of string (fields) | No | |
context |
object (fields) | No | The business this call acted on, its public website origin, and the location the call named, or null location fields when it named none. additionalProperties: false; required: ["organization_id","organization_name","organization_slug","organization_subdomain","organization_public_url","location_id","location_slug","location_title"] |
entity |
string | Yes | enum: ["reservation_policy"] |
location_id |
string | Yes | |
ok |
boolean | Yes | |
summary |
object (fields) | No | required: ["heading","items","additional_notes_html"] |
updated_at |
string | No |
required: ["ok","entity","location_id"]
Update site page — update_site_page
Replace a page’s metadata and complete ordered blocks using its current timestamp. Omitted summary and product binding retain their values; removing blocks requires their exact IDs.
Minimum role: admin. Required entitlement: None.
Annotations: title: Update site page, readOnlyHint: false, openWorldHint: true, destructiveHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
blocks |
array of object (fields) | Yes | Complete canonical block array. Each existing block must retain its id unless its removal is explicitly confirmed. Block data never contains asset IDs or delivery URLs. Omit media to preserve that block's current placements; provide media explicitly to replace them, or call set_media with owner_type "content_block", the block id, and the intended slot. |
expected_updated_at |
string | Yes | |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
pageType |
string | Yes | The page's type. Send the page_type from the last read unless you are changing it. enum: ["custom","recipe","legal","system"] |
path |
string | Yes | The saved page path. A page keeps this address when its content or title changes. |
product_id |
string or null | No | Explicit canonical Product binding on the source page only. Omit to retain; null unbinds. Translations inherit the source binding; slugs never imply a relationship. |
recipe |
string or null | Yes | The site section this page fills, or null for a page that fills none. Send the recipe from the last read unless you are changing it; an omitted recipe is not kept. |
removed_block_ids |
array of string (fields) | No | Exact existing block IDs omitted from the replacement; omit when none are removed. |
sortOrder |
number | Yes | The page's position in the site's page list. Send the sort_order from the last read unless you are reordering. |
summary |
string or null | No | Omit to preserve on update; null clears it. |
title |
string | Yes | The page's name, e.g. About. The site name is appended to the browser title. Always sent in full — an omitted title is not kept. |
variant_id |
string | Yes |
additionalProperties: false; required: ["variant_id","expected_updated_at","path","title","pageType","recipe","sortOrder","blocks"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
page |
object (fields) | Yes | required: ["id","page_id","organization_id","product_id","locale","path","title","summary","page_type","recipe","sort_order","updated_at","blocks","document","admin_edit_url"] |
required: ["page"]
Context
Get workspace context — get_workspace_context
Read the selected business and location and the businesses available to the signed-in user. Selection uses the saved MCP workspace; without an accessible saved business, the only accessible business is selected, or no business is selected when several are available. Use the returned internal organization and location IDs in later tools.
Minimum role: member. Required entitlement: None.
Annotations: title: Get workspace context, readOnlyHint: true, idempotentHint: true, openWorldHint: false, destructiveHint: false.
Authentication: oauth2, scopes tenant.
Input
Input: object.
additionalProperties: false
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
context |
object (fields) | Yes | The business this call acted on, its public website origin, and the location the call named, or null location fields when it named none. additionalProperties: false; required: ["organization_id","organization_name","organization_slug","organization_subdomain","organization_public_url","location_id","location_slug","location_title"] |
locations |
array of object (fields) | Yes | |
organizations |
array of object (fields) | Yes |
required: ["context","organizations","locations"]
Set workspace context — set_workspace_context
Save the selected business or location for the signed-in user, shared across their MCP connections. Read get_workspace_context or list_organizations for organization IDs and list_locations for location IDs. Supply at least one ID. Omitted organization uses the current selection; omitted location keeps the saved location within the same business and is unset when changing businesses. Explicit IDs on later tools override this saved selection.
Minimum role: member. Required entitlement: None.
Annotations: title: Set workspace context, readOnlyHint: false, openWorldHint: false, destructiveHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
location_id |
string | No | Internal location ID from list_locations or get_workspace_context, within the selected business. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
organization_id |
string | No | minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
additionalProperties: false
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
context |
object (fields) | Yes | The business this call acted on, its public website origin, and the location the call named, or null location fields when it named none. additionalProperties: false; required: ["organization_id","organization_name","organization_slug","organization_subdomain","organization_public_url","location_id","location_slug","location_title"] |
locations |
array of object (fields) | Yes | |
organizations |
array of object (fields) | Yes | |
success |
boolean | Yes |
required: ["success","context","organizations","locations"]
Google ads
Create Google Ads search campaign — create_google_ads_search_campaign
Create a paused Google Ads Search campaign with one ad group and responsive search ad from the supplied keywords, copy, destination and daily budget. The campaign cannot serve ads until separately enabled. Each call creates a new campaign; inspect the account before retrying an uncertain result.
Minimum role: admin. Required entitlement: google_ads_management.
Annotations: title: Create Google Ads search campaign, readOnlyHint: false, openWorldHint: true, destructiveHint: false.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
contains_eu_political_advertising |
boolean | Yes | Whether the campaign contains EU political advertising. Google requires this self-declaration on every new campaign; ask the user rather than assuming. |
daily_budget_micros |
integer | Yes | Daily budget in micros (e.g. 10000000 for 10 units in account currency). minimum: 1000000 |
descriptions |
array of string (fields) | Yes | Descriptions for Responsive Search Ad (2 to 4, max 90 chars each). maxItems: 4; minItems: 2; uniqueItems: true |
headlines |
array of string (fields) | Yes | Headlines for Responsive Search Ad (3 to 15, max 30 chars each). maxItems: 15; minItems: 3; uniqueItems: true |
keywords |
array of object (fields) | Yes | Keywords to target with optional match type (default PHRASE). |
name |
string | Yes | Campaign name. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
target_url |
string | Yes | Destination landing page or blog post URL (must start with http:// or https://). |
additionalProperties: false; required: ["name","daily_budget_micros","target_url","keywords","headlines","descriptions","contains_eu_political_advertising"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
campaign_id |
string | Yes | |
status |
string | Yes | const: "PAUSED" |
required: ["campaign_id","status"]
Get Google Ads campaign — get_google_ads_campaign
Read a campaign in the connected Google Ads account when inspecting its status, budget, ad groups, keywords, responsive search ad copy or destination URLs.
Minimum role: admin. Required entitlement: None.
Annotations: title: Get Google Ads campaign, readOnlyHint: true, idempotentHint: true, openWorldHint: false, destructiveHint: false.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
campaign_id |
string | Yes | Numeric Google Ads campaign ID. pattern: "^[0-9]+$" |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
additionalProperties: false; required: ["campaign_id"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
adGroups |
array of object (fields) | Yes | |
budgetAmountMicros |
number | Yes | |
budgetId |
string or null | No | |
channelType |
string | Yes | |
clicks |
number | Yes | |
conversions |
number | Yes | |
costMicros |
number | Yes | |
currency |
string | Yes | Connected account currency; budget and spend micros are millionths of this currency. |
descriptions |
array of string (fields) | Yes | |
finalUrls |
array of string (fields) | Yes | |
headlines |
array of string (fields) | Yes | |
id |
string | Yes | |
impressions |
number | Yes | |
keywords |
array of object (fields) | Yes | |
name |
string | Yes | |
status |
string | Yes |
required: ["id","currency","name","status","channelType","budgetAmountMicros","clicks","impressions","costMicros","conversions","adGroups","keywords","headlines","descriptions","finalUrls"]
List Google Ads campaigns — list_google_ads_campaigns
List up to 100 campaigns in the connected Google Ads account, most spend first, with status, daily budget, spend, impressions, clicks and conversions. With start_date and end_date the metrics cover those days in the account time zone and include campaigns removed since; without them they are all-time for campaigns not removed. Reading is free with the connection.
Minimum role: admin. Required entitlement: None.
Annotations: title: List Google Ads campaigns, readOnlyHint: true, idempotentHint: true, openWorldHint: false, destructiveHint: false.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
end_date |
string | No | Last day of the metrics, inclusive. Requires start_date. pattern: "^\d{4}-\d{2}-\d{2}$" |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
start_date |
string | No | First day of the metrics, YYYY-MM-DD in the account time zone. Requires end_date. pattern: "^\d{4}-\d{2}-\d{2}$" |
status |
string | No | Filter campaigns by status: ENABLED, PAUSED, or ALL non-removed campaigns (default: ALL). enum: ["ENABLED","PAUSED","ALL"] |
additionalProperties: false; required: []
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
campaigns |
array of object (fields) | Yes | |
currency |
string | Yes | Connected account currency; budget and spend micros are millionths of this currency. |
customer_id |
string | Yes | |
end_date |
string or null | Yes | |
start_date |
string or null | Yes | |
time_zone |
string | Yes | The account time zone the dates are in. |
required: ["customer_id","currency","time_zone","start_date","end_date","campaigns"]
Query Google Ads report — query_google_ads_report
Read a Google Ads report for chosen days from the connected account: campaign_daily (each campaign per day), search_terms, keywords, landing_pages or geography (countries), with impressions, clicks, spend, conversions and conversion value. Dates are in the account time zone; spend is micros of the account currency. Google omits low-volume search terms for privacy, so a missing term is not zero demand. Reading is free with the connection.
Minimum role: admin. Required entitlement: None.
Annotations: title: Query Google Ads report, readOnlyHint: true, idempotentHint: true, openWorldHint: false, destructiveHint: false.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
campaign_id |
string | No | Only this campaign. pattern: "^[0-9]+$" |
end_date |
string | Yes | Last day, inclusive. pattern: "^\d{4}-\d{2}-\d{2}$" |
limit |
integer | No | Rows to return, most clicks first; campaign_daily is by day (default 100). maximum: 10000; minimum: 1 |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
report |
string | Yes | campaign_daily: each campaign per day; search_terms: what people searched; keywords: the keywords that matched; landing_pages: the final URLs ads sent people to; geography: the countries clicks came from. enum: ["campaign_daily","search_terms","keywords","landing_pages","geography"] |
start_date |
string | Yes | First day, YYYY-MM-DD in the account time zone. pattern: "^\d{4}-\d{2}-\d{2}$" |
additionalProperties: false; required: ["report","start_date","end_date"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
currency |
string | Yes | Connected account currency; costMicros are millionths of it. |
customer_id |
string | Yes | |
end_date |
string | Yes | |
report |
string | Yes | |
rows |
array of object (fields) | Yes | |
start_date |
string | Yes | |
time_zone |
string | Yes |
required: ["customer_id","currency","time_zone","report","start_date","end_date","rows"]
Update Google Ads campaign — update_google_ads_campaign
Pause, enable or change the daily budget of a selected campaign in the connected Google Ads account. Supply status, the budget_id/daily_budget_micros pair, or both. Read get_google_ads_campaign or list_google_ads_campaigns for the current budget ID and account currency first. Enabling or raising a budget can increase advertising spend; changing a shared budget affects every campaign using it.
Minimum role: admin. Required entitlement: google_ads_management.
Annotations: title: Update Google Ads campaign, readOnlyHint: false, openWorldHint: true, destructiveHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
budget_id |
string | No | Budget ID returned for this campaign by get_google_ads_campaign or list_google_ads_campaigns. Required with daily_budget_micros; shared budget changes affect every campaign using it. pattern: "^[0-9]+$" |
campaign_id |
string | Yes | Google Ads campaign ID to update. pattern: "^[0-9]+$" |
daily_budget_micros |
integer | No | New daily budget in micros. Required with budget_id. minimum: 1000000 |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
status |
string | No | New campaign status (ENABLED or PAUSED). enum: ["ENABLED","PAUSED"] |
additionalProperties: false; required: ["campaign_id"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
budget_id |
string or null | No | |
campaign_id |
string | Yes | |
daily_budget_micros |
integer or null | No | |
status |
string or null | No |
required: ["campaign_id"]
Guest messaging
Cancel scheduled guest message — cancel_scheduled_guest_message
Cancel one pending automatic guest message. A message already sending, sent or requiring review cannot be cancelled or resent by this operation.
Minimum role: admin. Required entitlement: None.
Annotations: title: Cancel scheduled guest message, readOnlyHint: false, openWorldHint: false, destructiveHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
message_id |
string | Yes | minLength: 1 |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
additionalProperties: false; required: ["message_id"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
message |
object (fields) | Yes | additionalProperties: false; required: ["id","status"] |
required: ["message"]
Cancel scheduled reply — cancel_scheduled_reply
Cancel one of your own scheduled replies before it starts sending.
Minimum role: member. Required entitlement: None.
Annotations: title: Cancel scheduled reply, readOnlyHint: false, openWorldHint: false, destructiveHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
message_id |
string | Yes | minLength: 1 |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
additionalProperties: false; required: ["message_id"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
reply |
object (fields) | Yes | required: ["id","organizationId","threadId","body","sendAt","status","reason","errorCode","errorField","entryId","version","sentAt","createdAt","updatedAt"] |
required: ["reply"]
Create message template — create_message_template
Create an automatic guest message, sent to every guest at the named homes at the scheduled time in each home’s own timezone. It plans only eligible future events; ambiguous or nonexistent local times fail visibly. Every confirmed stay is already sent its home’s check-in instructions at 10:00 the day before arrival, so the name “Check-in instructions” is reserved.
Minimum role: admin. Required entitlement: None.
Annotations: title: Create message template, readOnlyHint: false, openWorldHint: true, destructiveHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
body |
string | Yes | maxLength: 5000; minLength: 1 |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
schedule |
object (fields) | Yes | |
title |
string | Yes | maxLength: 100; minLength: 1 |
additionalProperties: false; required: ["title","body","schedule"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
template |
object (fields) | Yes | required: ["id","organizationId","title","body","schedule","version","createdAt","updatedAt"] |
required: ["template"]
Delete message template — delete_message_template
Delete an automatic message using its current version and cancel its pending messages. Earlier delivery snapshots remain recorded; an in-flight send cannot be recalled.
Minimum role: admin. Required entitlement: None.
Annotations: title: Delete message template, readOnlyHint: false, openWorldHint: false, destructiveHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
expected_version |
integer | Yes | minimum: 1 |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
template_id |
string | Yes | minLength: 1 |
additionalProperties: false; required: ["template_id","expected_version"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
status |
string | Yes | const: "deleted" |
template_id |
string | Yes | minLength: 1 |
required: ["template_id","status"]
Get guest messaging context — get_guest_messaging_context
Read the actual home and optional stay behind a canonical guest conversation, including private check-in instructions the host may choose to share. Contact conversations may have no home or stay; channel inquiries can have a home without a booked stay.
Minimum role: member. Required entitlement: None.
Annotations: title: Get guest messaging context, readOnlyHint: true, idempotentHint: true, openWorldHint: false, destructiveHint: false.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
request_id |
string | Yes | minLength: 1 |
additionalProperties: false; required: ["request_id"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
home |
object or null (fields) | Yes | additionalProperties: false; required: ["product_id","name","timezone","check_in_method","check_in_instructions","wifi_network","wifi_password","directions","house_manual","checkout_instructions"] |
requestId |
string | Yes | minLength: 1 |
stay |
object or null (fields) | Yes | additionalProperties: false; required: ["id","product_id","status","check_in_date","check_out_date","guest_name","adults","children","infants"] |
required: ["requestId","home","stay"]
List message templates — list_message_templates
Read the workspace’s automatic guest messages: text the server sends every guest at the named homes on its own schedule. Follow page_info for every page.
Minimum role: member. Required entitlement: None.
Annotations: title: List message templates, readOnlyHint: true, idempotentHint: true, openWorldHint: false, destructiveHint: false.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
cursor |
string | No | Opaque next_cursor from the previous page. |
limit |
number | No | Page size. Defaults to 50; maximum 100. maximum: 100; minimum: 1 |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
additionalProperties: false; required: []
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
page_info |
object (fields) | Yes | required: ["has_more","next_cursor"] |
templates |
array of object (fields) | Yes |
required: ["templates","page_info"]
List scheduled guest messages — list_scheduled_guest_messages
Read automatic guest-message snapshots and visible failure reasons, optionally for one canonical guest conversation, including each stay’s built-in check-in message (templateId null, title “Check-in instructions”). Read provider delivery receipts through get_guest_conversation; no provider result is inferred from a scheduled time.
Minimum role: admin. Required entitlement: None.
Annotations: title: List scheduled guest messages, readOnlyHint: true, idempotentHint: true, openWorldHint: false, destructiveHint: false.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
cursor |
string | No | Opaque next_cursor from the previous page. |
limit |
number | No | Page size. Defaults to 50; maximum 100. maximum: 100; minimum: 1 |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
request_id |
string | No | minLength: 1 |
additionalProperties: false; required: []
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
messages |
array of object (fields) | Yes | |
page_info |
object (fields) | Yes | required: ["has_more","next_cursor"] |
required: ["messages","page_info"]
List scheduled replies — list_scheduled_replies
Read your own replies scheduled with schedule_guest_reply that have not been sent, and any that failed, optionally for one conversation. Teammates’ scheduled replies are not visible.
Minimum role: member. Required entitlement: None.
Annotations: title: List scheduled replies, readOnlyHint: true, idempotentHint: true, openWorldHint: false, destructiveHint: false.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
request_id |
string | No | minLength: 1 |
additionalProperties: false; required: []
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
replies |
array of object (fields) | Yes |
required: ["replies"]
Schedule guest reply — schedule_guest_reply
Send your own text reply in a guest conversation later, at send_at (an ISO 8601 instant within the next year). It is sent through the conversation’s reply_channel as your reply, if you can still reach the conversation then. Only you see it pending; cancel it with cancel_scheduled_reply. Text only: send photos now with reply_to_guest.
Minimum role: member. Required entitlement: None.
Annotations: title: Schedule guest reply, readOnlyHint: false, openWorldHint: true, destructiveHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
message |
string | Yes | maxLength: 5000; minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
request_id |
string | Yes | minLength: 1 |
send_at |
string | Yes | format: "date-time" |
additionalProperties: false; required: ["request_id","message","send_at"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
reply |
object (fields) | Yes | required: ["id","organizationId","threadId","body","sendAt","status","reason","errorCode","errorField","entryId","version","sentAt","createdAt","updatedAt"] |
required: ["reply"]
Update message template — update_message_template
Replace an automatic message and its schedule using the current version. Completed, failed, skipped, cancelled and uncertain deliveries are never recreated by an edit.
Minimum role: admin. Required entitlement: None.
Annotations: title: Update message template, readOnlyHint: false, openWorldHint: true, destructiveHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
body |
string | Yes | maxLength: 5000; minLength: 1 |
expected_version |
integer | Yes | minimum: 1 |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
schedule |
object (fields) | Yes | |
template_id |
string | Yes | minLength: 1 |
title |
string | Yes | maxLength: 100; minLength: 1 |
additionalProperties: false; required: ["template_id","expected_version","title","body","schedule"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
template |
object (fields) | Yes | required: ["id","organizationId","title","body","schedule","version","createdAt","updatedAt"] |
required: ["template"]
Update stay arrival guide — update_stay_arrival_guide
Save one home's private arrival guide: check-in method and instructions, wifi, directions, house manual and checkout instructions. Fields left out keep their values; null removes one. Saving does not send anything to a guest or publish it on the site. For a connected Airbnb home, supplied check-in, wifi, directions and house-manual fields return editor links in airbnb_unsynced for the host to check and edit in Airbnb. Checkout instructions are saved only in KrabiClaw.
Minimum role: admin. Required entitlement: None.
Annotations: title: Update stay arrival guide, readOnlyHint: false, openWorldHint: false, destructiveHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
check_in_instructions |
string or null | No | maxLength: 5000; minLength: 1 |
check_in_method |
string or null | No | How guests get in. enum: ["smart_lock","keypad","lockbox","building_staff","in_person","other",null] |
checkout_instructions |
array of object (fields) | No | What guests do before leaving, in order, each task once; replaces the whole list. |
directions |
string or null | No | maxLength: 5000; minLength: 1 |
house_manual |
string or null | No | maxLength: 5000; minLength: 1 |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
product_id |
string | Yes | minLength: 1 |
wifi_network |
string or null | No | maxLength: 100; minLength: 1 |
wifi_password |
string or null | No | maxLength: 100; minLength: 1 |
additionalProperties: false; required: ["product_id"]
anyOf: shape 1, shape 2, shape 3, shape 4, shape 5, shape 6, shape 7.
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
airbnb_unsynced |
array of object (fields) | Yes | Airbnb editor links for supplied fields that have a mapped editor page. Each entry identifies a field saved in KrabiClaw for the host to check and edit in Airbnb. Empty when no mapped fields were supplied or the home is not connected. |
channel_push |
object or null (fields) | Yes | |
guide |
object (fields) | Yes | additionalProperties: false |
product_id |
string | Yes | minLength: 1 |
additionalProperties: false; required: ["product_id","guide","channel_push","airbnb_unsynced"]
Locales
Add organization language — add_organization_language
Add a supported website language for private authoring. A new language starts disabled; an existing language keeps its publication status and translations while its stored label is refreshed from the platform catalog.
Minimum role: admin. Required entitlement: None.
Annotations: title: Add organization language, readOnlyHint: false, openWorldHint: false, destructiveHint: true, idempotentHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
locale |
string | Yes | enum: ["en","ja","th","vi"] |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
additionalProperties: false; required: ["locale"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
locales |
array of object (fields) | Yes |
additionalProperties: false; required: ["locales"]
Delete organization language — delete_organization_language
Permanently delete a disabled website language and all of its translations. Disable it before deletion. Source content is preserved.
Minimum role: admin. Required entitlement: None.
Annotations: title: Delete organization language, readOnlyHint: false, openWorldHint: false, destructiveHint: true, idempotentHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
locale |
string | Yes | |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
additionalProperties: false; required: ["locale"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
deleted |
boolean | Yes | const: true |
locale |
string | Yes |
additionalProperties: false; required: ["deleted","locale"]
Delete resource localization — delete_resource_localization
Permanently remove one translation and its owned document and redirects. Source content is preserved; imported Q&A remains read-only.
Minimum role: admin. Required entitlement: None.
Annotations: title: Delete resource localization, readOnlyHint: false, openWorldHint: true, destructiveHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
locale |
string | Yes | |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
resource_id |
string | Yes | |
resource_type |
string | Yes | enum: ["organization","business_location","product","collection","article_category","media_asset","content_document"] |
additionalProperties: false; required: ["resource_type","resource_id","locale"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
context |
object (fields) | Yes | The business this call acted on, its public website origin, and the location the call named, or null location fields when it named none. additionalProperties: false; required: ["organization_id","organization_name","organization_slug","organization_subdomain","organization_public_url","location_id","location_slug","location_title"] |
deleted |
boolean | Yes | |
locale |
string | Yes | |
resource_id |
string | Yes | |
resource_type |
string | Yes | enum: ["organization","business_location","product","collection","article_category","media_asset","content_document"] |
additionalProperties: false; required: ["deleted","resource_type","resource_id","locale","context"]
Disable organization language — disable_organization_language
Disable an existing website language’s public routes while preserving its translations for private authoring. The source language cannot be disabled.
Minimum role: admin. Required entitlement: None.
Annotations: title: Disable organization language, readOnlyHint: false, openWorldHint: true, destructiveHint: true, idempotentHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
locale |
string | Yes | enum: ["en","ja","th","vi"] |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
additionalProperties: false; required: ["locale"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
locales |
array of object (fields) | Yes |
additionalProperties: false; required: ["locales"]
Get product catalog localization — get_product_catalog_localization
Read catalog text and existing translations for an authored secondary language, including its menu sections.
Minimum role: admin. Required entitlement: None.
Annotations: title: Get product catalog localization, readOnlyHint: true, idempotentHint: true, openWorldHint: false, destructiveHint: false.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
locale |
string | Yes | |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
additionalProperties: false; required: ["locale"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
collections |
array of object (fields) | Yes | |
locale |
string | Yes | |
products |
array of object (fields) | Yes |
additionalProperties: false; required: ["locale","products","collections"]
Get resource localization — get_resource_localization
Read the requested resource or document in exactly the named language. A missing translation returns not found rather than source-language content.
Minimum role: admin. Required entitlement: None.
Annotations: title: Get resource localization, readOnlyHint: true, idempotentHint: true, openWorldHint: false, destructiveHint: false.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
locale |
string | Yes | |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
resource_id |
string | Yes | |
resource_type |
string | Yes | enum: ["organization","business_location","product","collection","article_category","media_asset","content_document"] |
additionalProperties: false; required: ["resource_type","resource_id","locale"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
localization |
object (fields) | Yes |
additionalProperties: false; required: ["localization"]
List organization locales — list_organization_locales
Read the website’s source language and authored translations.
Minimum role: admin. Required entitlement: None.
Annotations: title: List organization locales, readOnlyHint: true, idempotentHint: true, openWorldHint: false, destructiveHint: false.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
additionalProperties: false; required: []
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
locales |
array of object (fields) | Yes |
additionalProperties: false; required: ["locales"]
Publish organization language — publish_organization_language
Publish an added website language’s authored translations after translating its homepage. Legal Services sites also require a translated organization name and consultation call-to-action label. Missing translations remain unavailable; the source language is unchanged.
Minimum role: admin. Required entitlement: None.
Annotations: title: Publish organization language, readOnlyHint: false, openWorldHint: true, destructiveHint: true, idempotentHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
locale |
string | Yes | enum: ["en","ja","th","vi"] |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
additionalProperties: false; required: ["locale"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
locales |
array of object (fields) | Yes |
additionalProperties: false; required: ["locales"]
Put resource localization — put_resource_localization
Replace an exact translation with fields allowed for its resource_type. For content_document, an existing translation requires its current expected_updated_at from get_resource_localization; a new article or page translation requires content_blocks. Omit blocks to retain an existing body. Document addresses come from the source and remain stable. Authored Q&A translations use title and summary without blocks; imported Q&A remains read-only.
Minimum role: admin. Required entitlement: None.
Annotations: title: Put resource localization, readOnlyHint: false, openWorldHint: true, destructiveHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
content_blocks |
array of object (fields) | No | Complete canonical block array. Each existing block must retain its id unless its removal is explicitly confirmed. Block data never contains asset IDs or delivery URLs. Omit media to preserve that block's current placements; provide media explicitly to replace them, or call set_media with owner_type "content_block", the block id, and the intended slot. |
expected_updated_at |
string or null | No | content_document only: required current translation updated_at when replacing an existing document. Omit or use null when creating a translation. |
locale |
string | Yes | |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
resource_id |
string | Yes | |
resource_type |
string | Yes | enum: ["organization","business_location","product","collection","article_category","media_asset","content_document"] |
values |
object (fields) | Yes | additionalProperties: false |
additionalProperties: false; required: ["resource_type","resource_id","locale","values"]
oneOf: shape 1, shape 2, shape 3, shape 4, shape 5, shape 6, shape 7.
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
context |
object (fields) | Yes | The business this call acted on, its public website origin, and the location the call named, or null location fields when it named none. additionalProperties: false; required: ["organization_id","organization_name","organization_slug","organization_subdomain","organization_public_url","location_id","location_slug","location_title"] |
localization |
object (fields) | Yes |
additionalProperties: false; required: ["localization","context"]
Replace resource localizations — replace_resource_localizations
Atomically replace 1–250 exact resource translations for one language. Omitted resources retain their translations; any invalid item rejects the batch. Uses supplied translations without generating them.
Minimum role: admin. Required entitlement: None.
Annotations: title: Replace resource localizations, readOnlyHint: false, openWorldHint: true, destructiveHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
items |
array of object (fields) | Yes | maxItems: 250; minItems: 1 |
locale |
string | Yes | |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
resource_type |
string | Yes | enum: ["organization","business_location","product","collection","article_category","media_asset"] |
additionalProperties: false; required: ["resource_type","locale","items"]
oneOf: shape 1, shape 2, shape 3, shape 4, shape 5, shape 6.
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
context |
object (fields) | Yes | The business this call acted on, its public website origin, and the location the call named, or null location fields when it named none. additionalProperties: false; required: ["organization_id","organization_name","organization_slug","organization_subdomain","organization_public_url","location_id","location_slug","location_title"] |
locale |
string | Yes | |
resource_type |
string | Yes | enum: ["organization","business_location","product","collection","article_category","media_asset"] |
updated_resource_ids |
array of string (fields) | Yes |
additionalProperties: false; required: ["locale","resource_type","updated_resource_ids","context"]
Locations
Block dates — block_dates
Close a location for a whole-day date range when the user wants to prevent bookings on those dates. Both endpoints are inclusive. Adds a closure to special hours while retaining existing closures and dated hours. Returns the saved hours; existing bookings and reservations are not cancelled or messaged.
Minimum role: admin. Required entitlement: None.
Annotations: title: Block dates, readOnlyHint: false, openWorldHint: true, destructiveHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
from |
string | Yes | First closed day, YYYY-MM-DD. format: "date"; pattern: "^\d{4}-\d{2}-\d{2}$" |
location_id |
string | Yes | Internal location ID returned by list_locations or get_workspace_context. |
note |
string or null | No | Why, for the team; guests never see it. |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
to |
string | Yes | Last closed day, YYYY-MM-DD, inclusive. Same as from for one day. format: "date"; pattern: "^\d{4}-\d{2}-\d{2}$" |
additionalProperties: false; required: ["location_id","from","to"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
affected_commitments |
array of object (fields) | Yes | |
changed_fields |
array of string (fields) | Yes | |
context |
object (fields) | Yes | The business this call acted on, its public website origin, and the location the call named, or null location fields when it named none. additionalProperties: false; required: ["organization_id","organization_name","organization_slug","organization_subdomain","organization_public_url","location_id","location_slug","location_title"] |
entity |
string | Yes | enum: ["location"] |
id |
string | Yes | |
ok |
boolean | Yes | const: true |
saved_fields |
object (fields) | Yes | Persisted values of the fields named in changed_fields. required: [] |
slug |
string | Yes | |
updated_at |
string | Yes |
required: ["ok","entity","id","slug","changed_fields","updated_at","context","saved_fields","affected_commitments"]
Create location — create_location
Add an active business branch or office. Locations are not billed. It becomes public unless the website has published homes and this location has no published offering. Set hours with update_location; create homes with create_product.
Minimum role: admin. Required entitlement: None.
Annotations: title: Create location, readOnlyHint: false, openWorldHint: true, destructiveHint: false, idempotentHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
address |
object or null (fields) | No | additionalProperties: false; required: ["regionCode","addressLines"] |
description |
string | No | |
email |
string | No | format: "email" |
idempotency_key |
string | Yes | One key per new location, kept by this business and never expired. Retrying with the same key and details returns the location it created. The same key with different details fails with IDEMPOTENCY_CONFLICT; if that location has been deleted it fails with LOCATION_DELETED and nothing is created. maxLength: 200; minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
phone |
string | No | International number with its country calling code, e.g. +66812345678. |
timezone |
string | Yes | Explicit IANA timezone identifier, such as Asia/Bangkok. Missing timezone is an error, never the browser timezone. minLength: 1 |
title |
string | Yes | maxLength: 200; minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
website_url |
string | No | format: "uri" |
additionalProperties: false; required: ["title","idempotency_key","timezone"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
location |
object (fields) | Yes | additionalProperties: false; required: ["id","title","status"] |
organization_id |
string | Yes |
additionalProperties: false; required: ["organization_id","location"]
Get calendar — get_calendar
Read the business’s reservations, bookings, consultations, guest arrivals and departures, published posts and unavailable dates when the user wants to review its calendar. Dates are inclusive local calendar days, with at most 62 days per call. Use kinds to filter the agenda.
Minimum role: admin. Required entitlement: None.
Annotations: title: Get calendar, readOnlyHint: true, idempotentHint: true, openWorldHint: false, destructiveHint: false.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
assigned_member_id |
string | No | |
from |
string | Yes | First day, YYYY-MM-DD. format: "date"; pattern: "^\d{4}-\d{2}-\d{2}$" |
kinds |
array of string (fields) | No | Limit to these kinds. Defaults to every kind the location offers. A stay appears on its arrival and its departure day. |
location_id |
string or null | No | Limit to this location, or null for the whole business including online bookings. |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
to |
string | Yes | Last day, YYYY-MM-DD, inclusive. format: "date"; pattern: "^\d{4}-\d{2}-\d{2}$" |
additionalProperties: false; required: ["from","to"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
available_kinds |
array of string (fields) | Yes | |
context |
object (fields) | No | The business this call acted on, its public website origin, and the location the call named, or null location fields when it named none. additionalProperties: false; required: ["organization_id","organization_name","organization_slug","organization_subdomain","organization_public_url","location_id","location_slug","location_title"] |
items |
array of object (fields) | Yes | |
unavailable_dates |
array of object (fields) | Yes |
required: ["items","available_kinds","unavailable_dates"]
Get location — get_location
Read one selected site location, including its contact details, opening hours, timezone and media. Use its returned ID for location-specific changes.
Minimum role: admin. Required entitlement: None.
Annotations: title: Get location, readOnlyHint: true, idempotentHint: true, openWorldHint: false, destructiveHint: false.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
location_id |
string | Yes | Internal location ID returned by list_locations or get_workspace_context. |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
additionalProperties: false; required: ["location_id"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
current_local_date |
string | Yes | Current date in the location timezone. format: "date" |
location |
object (fields) | Yes | required: ["id","slug","title","assigned_member_id","assigned_team_id","stay_map_sharing","latitude","longitude","status","timezone","created_at","updated_at","media"] |
required: ["location","current_local_date"]
List locations — list_locations
List the selected site’s locations with their IDs, slugs, titles and active state. Location-scoped tools take these IDs.
Minimum role: admin. Required entitlement: None.
Annotations: title: List locations, readOnlyHint: true, idempotentHint: true, openWorldHint: false, destructiveHint: false.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
cursor |
string | No | Opaque next_cursor from the previous page. |
limit |
number | No | Page size. Defaults to 50; maximum 100. maximum: 100; minimum: 1 |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
additionalProperties: false; required: []
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
locations |
array of object (fields) | Yes | |
page_info |
object (fields) | Yes | required: ["has_more","next_cursor"] |
required: ["locations","page_info"]
Open dates — open_dates
Remove temporary closures for an inclusive date range when the user wants to reopen a location. Closure dates outside the range and their notes are preserved. Regularly closed weekdays stay closed; change opening_hours with update_location to open those weekdays. Returns the saved hours without creating or changing existing bookings.
Minimum role: admin. Required entitlement: None.
Annotations: title: Open dates, readOnlyHint: false, openWorldHint: true, destructiveHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
from |
string | Yes | First reopened day, YYYY-MM-DD. format: "date"; pattern: "^\d{4}-\d{2}-\d{2}$" |
location_id |
string | Yes | Internal location ID returned by list_locations or get_workspace_context. |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
to |
string | Yes | Last reopened day, YYYY-MM-DD, inclusive. Same as from for one day. format: "date"; pattern: "^\d{4}-\d{2}-\d{2}$" |
additionalProperties: false; required: ["location_id","from","to"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
affected_commitments |
array of object (fields) | Yes | |
changed_fields |
array of string (fields) | Yes | |
context |
object (fields) | Yes | The business this call acted on, its public website origin, and the location the call named, or null location fields when it named none. additionalProperties: false; required: ["organization_id","organization_name","organization_slug","organization_subdomain","organization_public_url","location_id","location_slug","location_title"] |
entity |
string | Yes | enum: ["location"] |
id |
string | Yes | |
ok |
boolean | Yes | const: true |
saved_fields |
object (fields) | Yes | Persisted values of the fields named in changed_fields. required: [] |
slug |
string | Yes | |
updated_at |
string | Yes |
required: ["ok","entity","id","slug","changed_fields","updated_at","context","saved_fields","affected_commitments"]
Update location — update_location
Update a location's own details: its name and descriptions, regular opening hours, temporary closures/special hours, contact info, saved map coordinates, and map sharing for its places to stay. Renaming keeps the saved public address. To change its hero media, call set_media with { owner_type: "business_location", owner_id: <location.id>, slot: "hero" }. Only provided fields are changed. Returns the updated location; website details can change immediately. This does not change reservation capacity or a product’s session schedule.
Minimum role: admin. Required entitlement: None.
Annotations: title: Update location, readOnlyHint: false, openWorldHint: true, destructiveHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
address |
object or null (fields) | No | additionalProperties: false; required: ["regionCode","addressLines"] |
assigned_member_id |
string or null | No | Responsible Better Auth membership ID from list_organization_members, not userId. Null is unassigned. Choose a member or team, never both; clear assigned_team_id when choosing a member. |
assigned_team_id |
string or null | No | Responsible Better Auth Team ID from list_teams. Its current members receive assigned location work. Choose a member or team, never both; clear assigned_member_id when choosing a team. |
description |
string or null | No | Long description shown on the location page. Pass null to clear it. |
email |
string or null | No | Public email shown to guests on the website and in booking/reservation confirmation emails. Pass null to clear it. |
latitude |
number or null | No | Saved map latitude. Supply longitude in the same call; both null clears the coordinates. Omit both to keep the saved coordinates. maximum: 90; minimum: -90 |
location_id |
string | Yes | Internal location ID returned by list_locations or get_workspace_context. |
longitude |
number or null | No | Saved map longitude. Supply latitude in the same call; both null clears the coordinates. Omit both to keep the saved coordinates. maximum: 180; minimum: -180 |
max_capacity |
number or null | No | Stored location capacity metadata; does not limit reservation availability. Reservation seats per start time are controlled by update_reservation_policy.slot_capacity. Pass null to clear the metadata. |
opening_hours |
null or object (fields) | No | Canonical weekly endpoint periods. Days use Sunday=0. Null means unknown; periods [] means closed. Sunday 00:00 without a close means always open. |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
phone |
string | No | Public phone number shown to guests on the website and in booking/reservation confirmation emails. International number with its country calling code, e.g. +66812345678. |
short_description |
string or null | No | One-line summary shown on location cards. Pass null to clear it. |
special_hours |
null or array of object (fields) | No | Explicit dated hours or closures. Closure starts_on is required; ends_on is inclusive and null means indefinite. Dated hours replace regular hours; periods [] closes the date. A closure or dated hours on a date replace that whole date, including the previous day’s hours that run past midnight into it: those end at midnight. A closure wins over dated hours on the same date. Closures may overlap; a second dated-hours entry for the same date is rejected. |
status |
string | No | Set active to enable the location, or inactive to hide it. Increasing the number of live homes requires the dashboard. enum: ["active","inactive"] |
stay_map_sharing |
string | No | Public map precision for every place to stay at this location. General shows the area; specific shows its precise pin. Both keep the street address private until a confirmed booking. Omit to keep the saved choice. enum: ["general","specific"] |
timezone |
string | No | IANA time zone identifier for this location, e.g. Asia/Bangkok. Used to interpret opening hours and booking slots. |
title |
string | No | Location name shown to guests. Renaming keeps its saved public address. maxLength: 200; minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
additionalProperties: false; required: ["location_id"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
changed_fields |
array of string (fields) | Yes | |
context |
object (fields) | Yes | The business this call acted on, its public website origin, and the location the call named, or null location fields when it named none. additionalProperties: false; required: ["organization_id","organization_name","organization_slug","organization_subdomain","organization_public_url","location_id","location_slug","location_title"] |
entity |
string | Yes | enum: ["location"] |
id |
string | Yes | |
ok |
boolean | Yes | const: true |
saved_fields |
object (fields) | Yes | Persisted values of the fields named in changed_fields. required: [] |
slug |
string | Yes | |
updated_at |
string | Yes |
required: ["ok","entity","id","slug","changed_fields","updated_at","context","saved_fields"]
Media
Attach media — attach_media
Attach one existing media asset to an ordered collection placement (a gallery or a compliance document list), appending it after the current last item. An existing attachment stays in place; a full collection rejects a new attachment. For a single-valued placement (a cover, hero, or logo) use set_media instead. Product galleries are saved in KrabiClaw; a connected listing’s Airbnb photo tour is edited in Airbnb.
Minimum role: admin. Required entitlement: None.
Annotations: title: Attach media, readOnlyHint: false, openWorldHint: true, destructiveHint: false, idempotentHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
asset_id |
string | Yes | The single media asset id to attach. |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
placement |
object (fields) | Yes |
additionalProperties: false; required: ["placement","asset_id"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
asset_ids |
array of string (fields) | Yes | |
cleared |
boolean | Yes | |
context |
object (fields) | No | The business this call acted on, its public website origin, and the location the call named, or null location fields when it named none. additionalProperties: false; required: ["organization_id","organization_name","organization_slug","organization_subdomain","organization_public_url","location_id","location_slug","location_title"] |
entity |
string | Yes | |
id |
string | Yes | |
media |
array of object (fields) | Yes | |
ok |
boolean | Yes | |
placement |
object (fields) | Yes |
required: ["ok","entity","id","placement","asset_ids","media","cleared"]
Delete media asset — delete_media_asset
Delete the selected site media asset and remove its website placements. Deletes stored media when no other asset references it. Refused while a social publication pins the asset; published provider posts are not deleted.
Minimum role: admin. Required entitlement: None.
Annotations: title: Delete media asset, readOnlyHint: false, openWorldHint: true, destructiveHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
asset_id |
string | Yes | |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
additionalProperties: false; required: ["asset_id"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
deleted |
boolean | Yes |
required: ["deleted"]
List media assets — list_media_assets
List the images, videos and Markdown files in the selected site’s media library, with the asset IDs set_media and attach_media take. A file still in the conversation is saved with save_media_attachment.
Minimum role: admin. Required entitlement: None.
Annotations: title: List media assets, readOnlyHint: true, idempotentHint: true, openWorldHint: false, destructiveHint: false.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
cursor |
string | No | Opaque next_cursor from the previous page. |
kind |
string | No | Filter by asset type. enum: ["image","video","file"] |
limit |
number | No | Page size. Defaults to 50; maximum 100. maximum: 100; minimum: 1 |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
additionalProperties: false; required: []
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
assets |
array of object (fields) | Yes | |
page_info |
object (fields) | Yes | required: ["has_more","next_cursor"] |
required: ["assets","page_info"]
Remove media — remove_media
Detach one media asset from an ordered collection placement (a gallery or a compliance document list). Removing an asset that is not attached changes nothing; other attached assets keep their order. Product galleries are saved in KrabiClaw; a connected listing’s Airbnb photo tour is edited in Airbnb.
Minimum role: admin. Required entitlement: None.
Annotations: title: Remove media, readOnlyHint: false, openWorldHint: true, destructiveHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
asset_id |
string | Yes | The single media asset id to detach. |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
placement |
object (fields) | Yes |
additionalProperties: false; required: ["placement","asset_id"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
asset_ids |
array of string (fields) | Yes | |
cleared |
boolean | Yes | |
context |
object (fields) | No | The business this call acted on, its public website origin, and the location the call named, or null location fields when it named none. additionalProperties: false; required: ["organization_id","organization_name","organization_slug","organization_subdomain","organization_public_url","location_id","location_slug","location_title"] |
entity |
string | Yes | |
id |
string | Yes | |
media |
array of object (fields) | Yes | |
ok |
boolean | Yes | |
placement |
object (fields) | Yes |
required: ["ok","entity","id","placement","asset_ids","media","cleared"]
Reorder media — reorder_media
Move attached gallery or compliance assets before or after an attached neighbor. Omitted anchors move the asset to the end; invalid assets or anchors reject the call. Product galleries are saved in KrabiClaw; a connected listing’s Airbnb photo tour is edited in Airbnb.
Minimum role: admin. Required entitlement: None.
Annotations: title: Reorder media, readOnlyHint: false, openWorldHint: true, destructiveHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
moves |
array of object (fields) | Yes | Ordered list of moves to apply sequentially. |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
placement |
object (fields) | Yes |
additionalProperties: false; required: ["placement","moves"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
asset_ids |
array of string (fields) | Yes | |
cleared |
boolean | Yes | |
context |
object (fields) | No | The business this call acted on, its public website origin, and the location the call named, or null location fields when it named none. additionalProperties: false; required: ["organization_id","organization_name","organization_slug","organization_subdomain","organization_public_url","location_id","location_slug","location_title"] |
entity |
string | Yes | |
id |
string | Yes | |
media |
array of object (fields) | Yes | |
ok |
boolean | Yes | |
placement |
object (fields) | Yes |
required: ["ok","entity","id","placement","asset_ids","media","cleared"]
Save media attachment — save_media_attachment
Save an attached image, video with poster, or Markdown file. Uses the host’s file reference. An optional placement puts it on the requested website owner in this operation. Repeat the same idempotency key for a retry.
Minimum role: admin. Required entitlement: None.
Annotations: title: Save media attachment, readOnlyHint: false, openWorldHint: true, destructiveHint: true, idempotentHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
category |
string | No | Optional visual subject used to organize the media library. It never assigns the asset to content. enum: ["exterior","interior","food","menu","team","other"] |
description |
string | No | Description of the media (stored as alt text). |
file |
object (fields) | Yes | Authorized file reference supplied by ChatGPT after rewriting the declared top-level file argument, including a temporary download_url and file_id. required: ["download_url","file_id"] |
idempotency_key |
string | Yes | maxLength: 200; minLength: 1 |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
placement |
object (fields) | No | |
poster_file |
object (fields) | No | Required poster/thumbnail image for video uploads. Invalid for non-video uploads. required: ["download_url","file_id"] |
additionalProperties: false; required: ["file","idempotency_key"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
asset_id |
string | Yes | |
kind |
string | Yes | enum: ["image","video","file"] |
placement |
object or null (fields) | No | |
public_url |
string | Yes | |
status |
string | Yes | enum: ["active"] |
thumbnail_url |
string or null | No |
required: ["asset_id","status","public_url","kind"]
File parameters: file, poster_file.
Set media — set_media
Assign an asset to one cover, hero, logo or menu section photo; null clears it. Use attach_media for galleries and presentation for logo cropping. Product photos are saved in KrabiClaw; a connected listing’s Airbnb photo tour is edited in Airbnb.
Minimum role: admin. Required entitlement: None.
Annotations: title: Set media, readOnlyHint: false, openWorldHint: true, destructiveHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
asset_id |
string or null | Yes | One asset id, or null to clear this single-valued placement. |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
placement |
object (fields) | Yes | |
presentation |
object (fields) | No | Organization logo and logo_dark only. Omitted means original. additionalProperties: false; required: ["shape","focus"] |
additionalProperties: false; required: ["placement","asset_id"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
asset_ids |
array of string (fields) | Yes | |
cleared |
boolean | Yes | |
context |
object (fields) | No | The business this call acted on, its public website origin, and the location the call named, or null location fields when it named none. additionalProperties: false; required: ["organization_id","organization_name","organization_slug","organization_subdomain","organization_public_url","location_id","location_slug","location_title"] |
entity |
string | Yes | |
id |
string | Yes | |
media |
array of object (fields) | Yes | |
ok |
boolean | Yes | |
placement |
object (fields) | Yes |
required: ["ok","entity","id","placement","asset_ids","media","cleared"]
Update media asset — update_media_asset
Change the selected asset’s alt text or library category. At least one field is required. Category organizes the library and does not assign media to a page. Airbnb photo captions are edited in Airbnb.
Minimum role: admin. Required entitlement: None.
Annotations: title: Update media asset, readOnlyHint: false, openWorldHint: true, destructiveHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
alt_text |
string or null | No | Omit to retain; null clears the alt text. |
asset_id |
string | Yes | |
category |
string | No | enum: ["exterior","interior","food","menu","team","other"] |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
additionalProperties: false; required: ["asset_id"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
updated |
boolean | Yes |
required: ["updated"]
Organizations
Cancel organization invitation — cancel_organization_invitation
Cancel a pending invitation to this business.
Minimum role: admin. Required entitlement: None.
Annotations: title: Cancel organization invitation, readOnlyHint: false, openWorldHint: false, destructiveHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
invitation_id |
string | Yes | |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
additionalProperties: false; required: ["invitation_id"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
invitation |
object (fields) | Yes | additionalProperties: false; required: ["id","email","role","status","expiresAt","delivery"] |
additionalProperties: false; required: ["invitation"]
Create team — create_team
Create a named team within this business using Better Auth. Existing teammates can then be added to it.
Minimum role: admin. Required entitlement: None.
Annotations: title: Create team, readOnlyHint: false, openWorldHint: false, destructiveHint: false.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
name |
string | Yes | minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
additionalProperties: false; required: ["name"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
team |
object (fields) | Yes | additionalProperties: false; required: ["id","name"] |
required: ["team"]
Delete team — delete_team
Delete a team from this business. Existing bookings keep their saved provider. Offerings assigned to this team require a new schedule assignment.
Minimum role: admin. Required entitlement: None.
Annotations: title: Delete team, readOnlyHint: false, openWorldHint: false, destructiveHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
team_id |
string | Yes |
additionalProperties: false; required: ["team_id"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
deleted |
boolean | Yes | const: true |
team_id |
string | Yes |
required: ["deleted","team_id"]
Get organization — get_organization
Read the selected KrabiClaw site’s identity, public address and settings. organization_id is the internal ID returned by get_workspace_context or list_organizations, not a URL, domain or business name.
Minimum role: admin. Required entitlement: None.
Annotations: title: Get organization, readOnlyHint: true, idempotentHint: true, openWorldHint: false, destructiveHint: false.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
additionalProperties: false; required: []
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
organization |
object (fields) | Yes | required: ["id","subdomain","status"] |
required: ["organization"]
Get organization settings — get_organization_settings
Read editable settings for the selected KrabiClaw site. Use its internal organization_id from get_workspace_context or list_organizations, not its public URL, domain or name.
Minimum role: admin. Required entitlement: None.
Annotations: title: Get organization settings, readOnlyHint: true, idempotentHint: true, openWorldHint: false, destructiveHint: false.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
additionalProperties: false; required: []
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
settings |
object (fields) | Yes | required: ["id","subdomain","default_currency","timezone"] |
required: ["settings"]
Get website draft — get_website_draft
Read your saved website setup. Omit draft_id to resume your unfinished website.
Minimum role: admin. Required entitlement: None.
Annotations: title: Get website draft, readOnlyHint: true, idempotentHint: true, openWorldHint: false, destructiveHint: false.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
draft_id |
string | No | minLength: 1 |
additionalProperties: false
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
currency |
string | No | |
draft_id |
string | Yes | |
hero_headline |
string | No | |
hero_subtitle |
string | No | |
idempotency_key |
string | No | |
location |
object (fields) | Yes | additionalProperties: false |
missing_fields |
array of string (fields) | Yes | |
name |
string | Yes | |
organization_id |
string | No | |
products |
array of object (fields) | Yes | |
revision |
string | Yes | format: "date-time" |
source_locale |
string | Yes | |
status |
string | Yes | enum: ["active","committed"] |
subdomain |
string | Yes | |
timezone |
string | No | |
vertical |
string | Yes | enum: ["restaurant","experience","service","lodging"] |
additionalProperties: false; required: ["draft_id","revision","status","subdomain","name","vertical","source_locale","location","products","missing_fields"]
Invite organization member — invite_organization_member
Invite a teammate by email using Better Auth. The invitation remains pending until they accept. Set resend only when the user wants an existing invitation sent again.
Minimum role: admin. Required entitlement: None.
Annotations: title: Invite organization member, readOnlyHint: false, openWorldHint: true, destructiveHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
email |
string | Yes | format: "email" |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
resend |
boolean | No | |
role |
string | Yes | enum: ["member","owner","admin"] |
additionalProperties: false; required: ["email","role"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
invitation |
object (fields) | Yes | additionalProperties: false; required: ["id","email","role","status","expiresAt","delivery"] |
additionalProperties: false; required: ["invitation"]
List organization members — list_organization_members
Read the business’s teammates and invitations. Member IDs identify organization memberships; user IDs identify people.
Minimum role: admin. Required entitlement: None.
Annotations: title: List organization members, readOnlyHint: true, idempotentHint: true, openWorldHint: false, destructiveHint: false.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
limit |
integer | No | maximum: 100; minimum: 1 |
offset |
integer | No | minimum: 0 |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
additionalProperties: false; required: []
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
invitations |
array of object (fields) | Yes | |
members |
array of object (fields) | Yes | |
total |
integer | Yes | minimum: 0 |
additionalProperties: false; required: ["members","total","invitations"]
List organizations — list_organizations
List sites available to the signed-in user and the current account identity. Match the requested site against these results and use its internal ID; a public URL, domain or business name is not an organization_id.
Minimum role: admin. Required entitlement: None.
Annotations: title: List organizations, readOnlyHint: true, idempotentHint: true, openWorldHint: false, destructiveHint: false.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
cursor |
string | No | Opaque next_cursor from the previous page. |
limit |
number | No | Page size. Defaults to 50; maximum 100. maximum: 100; minimum: 1 |
additionalProperties: false
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
currentUser |
object (fields) | Yes | required: ["id","isPlatformAdmin"] |
organizations |
array of object (fields) | Yes | |
page_info |
object (fields) | Yes | required: ["has_more","next_cursor"] |
required: ["organizations","currentUser","page_info"]
List teams — list_teams
Read the business’s Better Auth teams and their members. Choose a team for an offering when any available member can host its bookings.
Minimum role: admin. Required entitlement: None.
Annotations: title: List teams, readOnlyHint: true, idempotentHint: true, openWorldHint: false, destructiveHint: false.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
additionalProperties: false; required: []
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
teams |
array of object (fields) | Yes |
required: ["teams"]
Publish website — publish_website
Publish a saved website draft, select it as your workspace and notify KrabiClaw operators by email. Finish any returned missing fields before retrying. Repeating a completed publication can resend the operator email.
Minimum role: admin. Required entitlement: None.
Annotations: title: Publish website, readOnlyHint: false, openWorldHint: true, destructiveHint: true, idempotentHint: false.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
draft_id |
string | Yes | minLength: 1 |
revision |
string | Yes | format: "date-time" |
additionalProperties: false; required: ["draft_id","revision"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
context |
object (fields) | Yes | The business this call acted on, its public website origin, and the location the call named, or null location fields when it named none. additionalProperties: false; required: ["organization_id","organization_name","organization_slug","organization_subdomain","organization_public_url","location_id","location_slug","location_title"] |
draft_id |
string | Yes | |
location_id |
string | Yes | |
organization_id |
string | Yes | |
public_url |
string | Yes | format: "uri" |
ready |
boolean | Yes | const: true |
additionalProperties: false; required: ["organization_id","location_id","draft_id","public_url","ready","context"]
Remove organization member — remove_organization_member
Remove a teammate’s membership in this business. Better Auth enforces removal permissions and protects the last owner.
Minimum role: admin. Required entitlement: None.
Annotations: title: Remove organization member, readOnlyHint: false, openWorldHint: false, destructiveHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
member_id |
string | Yes | |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
additionalProperties: false; required: ["member_id"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
member |
object (fields) | Yes | required: ["id","organizationId","userId","role","createdAt"] |
additionalProperties: false; required: ["member"]
Save website draft — save_website_draft
Save website answers without publishing. Use the returned draft_id and revision for changes; reuse the creation key on retry.
Minimum role: admin. Required entitlement: None.
Annotations: title: Save website draft, readOnlyHint: false, openWorldHint: false, destructiveHint: true, idempotentHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
currency |
string | No | ISO 4217 currency code. pattern: "^[A-Z]{3}$" |
draft_id |
string | No | Existing draft to edit; omit when creating. minLength: 1 |
hero_headline |
string | No | maxLength: 500 |
hero_subtitle |
string | No | maxLength: 2000 |
idempotency_key |
string | Yes | maxLength: 200; minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
location |
object (fields) | No | additionalProperties: false |
name |
string | No | Required when creating; omitted on an edit to retain it. maxLength: 200; minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
products |
array of object (fields) | No | |
revision |
string | No | Required when editing: the revision returned by get_website_draft. format: "date-time" |
source_locale |
string | No | Required when creating; a saved draft cannot be relabelled into another language. enum: ["en","ja","th","vi"] |
subdomain |
string | No | maxLength: 63; minLength: 1; pattern: "^a-z0-9?$" |
timezone |
string | No | Explicit IANA timezone identifier, such as Asia/Bangkok. Missing timezone is an error, never the browser timezone. minLength: 1 |
vertical |
string | No | Required when creating; omitted on an edit to retain it. enum: ["restaurant","experience","service","lodging"] |
additionalProperties: false; required: ["idempotency_key"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
currency |
string | No | |
draft_id |
string | Yes | |
hero_headline |
string | No | |
hero_subtitle |
string | No | |
idempotency_key |
string | No | |
location |
object (fields) | Yes | additionalProperties: false |
missing_fields |
array of string (fields) | Yes | |
name |
string | Yes | |
organization_id |
string | No | |
products |
array of object (fields) | Yes | |
revision |
string | Yes | format: "date-time" |
source_locale |
string | Yes | |
status |
string | Yes | enum: ["active","committed"] |
subdomain |
string | Yes | |
timezone |
string | No | |
vertical |
string | Yes | enum: ["restaurant","experience","service","lodging"] |
additionalProperties: false; required: ["draft_id","revision","status","subdomain","name","vertical","source_locale","location","products","missing_fields"]
Set consultation mode — set_consultation_mode
Choose native legal consultation bookings, an external scheduler, or Contact on the Schedule page. Supply external_url to connect a scheduler; omission retains the saved URL. Null clears the URL only when not using the external scheduler.
Minimum role: admin. Required entitlement: None.
Annotations: title: Set consultation mode, readOnlyHint: false, openWorldHint: true, destructiveHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
external_url |
string or null | No | |
mode |
string | Yes | enum: ["native","external_url","native_disabled"] |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
additionalProperties: false; required: ["mode"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
settings |
object (fields) | Yes | required: ["mode","external_url"] |
required: ["settings"]
Set team member — set_team_member
Add an existing business teammate to a team, or remove them from it. Existing bookings keep their saved provider.
Minimum role: admin. Required entitlement: None.
Annotations: title: Set team member, readOnlyHint: false, openWorldHint: false, destructiveHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
included |
boolean | Yes | |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
team_id |
string | Yes | |
user_id |
string | Yes |
additionalProperties: false; required: ["team_id","user_id","included"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
included |
boolean | Yes | |
team_id |
string | Yes | |
user_id |
string | Yes |
additionalProperties: false; required: ["team_id","user_id","included"]
Update organization member role — update_organization_member_role
Change a teammate’s business role. Better Auth enforces owner privileges and protects the last owner.
Minimum role: admin. Required entitlement: None.
Annotations: title: Update organization member role, readOnlyHint: false, openWorldHint: false, destructiveHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
member_id |
string | Yes | |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
role |
string | Yes | enum: ["member","owner","admin"] |
additionalProperties: false; required: ["member_id","role"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
member |
object (fields) | Yes | required: ["id","organizationId","userId","role","createdAt"] |
additionalProperties: false; required: ["member"]
Update organization settings — update_organization_settings
Change the selected site’s brand, description, website font, colors, button and heading styling, contact email, default currency, visitor announcement banner/popup, inquiry form questions or Live/Draft status. Only supplied settings change. An announcement replaces all its fields, and null removes it. Logos and announcement images are separate media placements; this tool does not change them. Returns the updated settings. Published website settings change immediately; this does not create a short post, blog article or social publication.
Minimum role: admin. Required entitlement: None.
Annotations: title: Update organization settings, readOnlyHint: false, openWorldHint: true, destructiveHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
address_visibility |
string | No | Show or hide office addresses on service websites. enum: ["visible","hidden"] |
announcement |
object or null (fields) | No | The universal announcement banner or modal shown to visitors on the public website, available to every theme. An image, when set, is a separate organization media placement (slot "announcement"), not a field here. required: ["headline"] |
brand_description |
string | No | |
button_casing |
string | No | Button text casing: uppercase or none (natural case). enum: ["uppercase","none"] |
button_color |
string | No | Button fill: action (the palette's action color) or accent (the palette's accent color). enum: ["action","accent"] |
button_shape |
string | No | Button corner styling: pill (fully rounded), rounded (subtle radius), or sharp (square corners). enum: ["pill","rounded","sharp"] |
careers_email |
string | No | |
catering_email |
string | No | |
contact_email |
string or null | No | Public contact email shown to guests. Pass null to clear it. |
default_currency |
string | No | ISO 4217 code. Existing prices keep their stored currency and amount; nothing is converted. pattern: "^[A-Z]{3}$" |
expected_inquiry_questions_revision |
string | No | inquiry_questions_revision from get_organization_settings; required with inquiry_questions. |
font_preset |
string | No | Website heading and body fonts, on every template: default (Default), mali (Mali), sarabun (Sarabun), prompt (Prompt), kanit (Kanit with Sarabun), ibm-plex-sans-thai (IBM Plex Sans Thai), noto-serif-thai (Noto Serif Thai with Noto Sans Thai), inter (Inter), dm-sans (DM Sans), montserrat (Montserrat), lora (Lora), playfair-display (Playfair Display with Inter), cormorant-garamond (Cormorant Garamond with Inter), marcellus (Marcellus with Inter). Thai, Vietnamese and Japanese text renders in every choice. enum: ["default","mali","sarabun","prompt","kanit","ibm-plex-sans-thai","noto-serif-thai","inter","dm-sans","montserrat","lora","playfair-display","cormorant-garamond","marcellus"] |
heading_casing |
string | No | Display heading casing: uppercase or none (natural case). enum: ["uppercase","none"] |
inquiry_questions |
array of object (fields) | No | The inquiry (quote or lead) form's own questions, asked beside the shared contact fields wherever the site places its contact form. Replaces the saved list; read get_organization_settings first and keep existing IDs. maxItems: 20 |
name |
string | No | |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
palette |
object or null (fields) | No | Website colors, each with a light and a dark value. Roles: ground (The page background.) surface (Cards, the header and footer, dialogs and fields.) text (Body copy and headings.) muted (Captions, details and supporting copy.) action (Buttons, links and selected states.) accent (Emphasis, decoration and highlighted buttons.) Start from a starter (coastal, forest, terracotta, ink, blossom, saffron, slate, midnight) and/or name only the roles to change; colors are #RRGGBB or a plain description such as "forest green". Borders and tints are derived. null returns to the default colors. The result reports any text or button pair below WCAG AA contrast. additionalProperties: false |
partnerships_email |
string | No | |
press_email |
string | No | |
status |
string | No | Website status: published/active is Live (public and indexable), draft/inactive is Draft (preview only). A suspended website cannot be changed. enum: ["published","draft","active","inactive"] |
timezone |
string | No | The business's reporting timezone: the day boundaries of its analytics. Bookings keep their location's or provider's timezone. minLength: 1 |
additionalProperties: false; required: []
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
address_visibility |
string | No | enum: ["visible","hidden"] |
changed_fields |
array of string (fields) | Yes | |
context |
object (fields) | No | The business this call acted on, its public website origin, and the location the call named, or null location fields when it named none. additionalProperties: false; required: ["organization_id","organization_name","organization_slug","organization_subdomain","organization_public_url","location_id","location_slug","location_title"] |
contrast_warnings |
array of object (fields) | No | |
entity |
string | Yes | enum: ["organization_settings"] |
id |
string | Yes | |
ok |
boolean | Yes | |
saved_fields |
object (fields) | Yes | Persisted values of only the supplied settings, keyed by changed_fields. additionalProperties: false |
updated_at |
string | No |
required: ["ok","entity","id","changed_fields","saved_fields"]
Update team — update_team
Rename a team in this business.
Minimum role: admin. Required entitlement: None.
Annotations: title: Update team, readOnlyHint: false, openWorldHint: false, destructiveHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
name |
string | Yes | minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
team_id |
string | Yes |
additionalProperties: false; required: ["team_id","name"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
team |
object (fields) | Yes | additionalProperties: false; required: ["id","name"] |
required: ["team"]
Payments
Get payment — get_payment
Read one customer payment belonging to the selected business, including its original purchase details, current refund records, disputes and authenticated dashboard URL. Requires payment_id from list_payments. Does not issue a refund, prepare an approval or change payment state; use the authenticated dashboard for financial actions.
Minimum role: admin. Required entitlement: None.
Annotations: title: Get payment, readOnlyHint: true, idempotentHint: true, openWorldHint: false, destructiveHint: false.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
payment_id |
string | Yes |
additionalProperties: false; required: ["payment_id"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
dashboard_url |
string | Yes | |
disputes |
array of object (fields) | Yes | |
organization_id |
string | Yes | |
payment |
object (fields) | Yes | additionalProperties: false; required: ["id","currency","amount","captured_amount","refunded_amount","state","title","to"] |
purchase |
object (fields) | Yes | required: ["title","quantity"] |
refunds |
array of object (fields) | Yes |
additionalProperties: false; required: ["organization_id","payment","purchase","refunds","disputes","dashboard_url"]
Get payment payouts — get_payment_payouts
Read the selected business’s connected Stripe balance and payout history, with source and retrieval time. Continue with next_cursor as after for another page. Use get_payment_summary for customer payment totals. This is a read of the business’s own connected account; it does not create a payout or transfer funds.
Minimum role: admin. Required entitlement: None.
Annotations: title: Get payment payouts, readOnlyHint: true, idempotentHint: true, openWorldHint: false, destructiveHint: false.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
after |
string | No | next_cursor from the previous payout page. |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
additionalProperties: false; required: []
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
balance |
object or null (fields) | No | required: ["available","pending"] |
configured |
boolean | Yes | |
dashboard_url |
string | Yes | |
next_cursor |
string or null | Yes | |
organization_id |
string | Yes | |
payouts |
array of object (fields) | Yes | |
refreshed_at |
string or null | No | |
source |
string | Yes |
additionalProperties: false; required: ["organization_id","configured","source","next_cursor","payouts","dashboard_url"]
Get payment summary — get_payment_summary
Read totals for the selected business’s customer payments in a UTC period: captured volume, refunds and disputes, separately by currency. Use list_payments for individual transactions. Trust receipts are distinct from earned revenue. Does not change payments or move money.
Minimum role: admin. Required entitlement: None.
Annotations: title: Get payment summary, readOnlyHint: true, idempotentHint: true, openWorldHint: false, destructiveHint: false.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
from |
string | Yes | Inclusive UTC ISO instant. |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
to |
string | Yes | Exclusive UTC ISO instant. |
additionalProperties: false; required: ["from","to"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
amounts |
array of object (fields) | Yes | |
dashboard_url |
string | Yes | |
from |
string | Yes | |
organization_id |
string | Yes | |
refreshed_at |
string or null | Yes | |
source |
string | Yes | |
timezone |
string | Yes | const: "UTC" |
to |
string | Yes | |
usage |
array of object (fields) | Yes | |
usage_status |
string | No |
additionalProperties: false; required: ["organization_id","timezone","from","to","amounts","usage","source","refreshed_at","dashboard_url"]
Get payments dashboard link — get_payments_dashboard_link
Get the selected business’s authenticated Payments setup and dashboard URL when the owner wants to manage its Stripe integration. Returns a link for the person to open; it does not open a page, create an account, start onboarding, prepare a refund or change the integration. Identity and bank details are entered only in the dashboard’s Stripe-hosted flow.
Minimum role: owner. Required entitlement: None.
Annotations: title: Get payments dashboard link, readOnlyHint: true, idempotentHint: true, openWorldHint: false, destructiveHint: false.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
additionalProperties: false; required: []
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
dashboard_url |
string | Yes | |
organization_id |
string | Yes | |
source |
string | Yes |
required: ["organization_id","dashboard_url","source"]
List payments — list_payments
List the selected business’s customer payment records in a UTC period, with purchase links and amounts in each currency’s minor units. Use the returned cursor as after for another page and get_payment for one transaction’s details. These are customer payments, separate from the business’s platform subscription bill. Does not change payments.
Minimum role: admin. Required entitlement: None.
Annotations: title: List payments, readOnlyHint: true, idempotentHint: true, openWorldHint: false, destructiveHint: false.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
after |
string | No | The cursor returned by the previous payment page. |
earnings_type |
string | No | Only payments still paid, or only payments with a refund. enum: ["paid","refunded"] |
from |
string | Yes | Inclusive UTC ISO instant. |
location_id |
string | No | |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
to |
string | Yes | Exclusive UTC ISO instant. |
additionalProperties: false; required: ["from","to"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
dashboard_url |
string | Yes | |
from |
string | No | |
next_cursor |
string or null | Yes | |
organization_id |
string | Yes | |
payments |
array of object (fields) | Yes | |
timezone |
string | No | const: "UTC" |
to |
string | No |
additionalProperties: false; required: ["organization_id","payments","next_cursor","dashboard_url"]
Posts
Create post — create_post
Create a draft short post when the user wants an announcement, event notice or offer. Supports a plain-text caption, ordered media, optional title, location and call to action. It stays private until publish_post. Use a new idempotency_key for each post and reuse it only for retries of that request. Long-form articles use create_blog_post.
Minimum role: admin. Required entitlement: None.
Annotations: title: Create post, readOnlyHint: false, openWorldHint: false, destructiveHint: false.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
body |
string or null (fields) | No | The caption, plain text; newlines are kept. |
call_to_action |
object or null (fields) | No | |
idempotency_key |
string | Yes | A value you make up once for this post, such as a UUID, and reuse only to retry this same request. maxLength: 200; minLength: 1 |
location_id |
string or null (fields) | No | Scope the post to one of this organization's locations; omit for organization-wide. |
media |
array of object (fields) | No | Ordered media: at most one cover, then gallery items in order. Each asset appears once. |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
slug |
string or null (fields) | No | Optional route segment for /posts/ |
title |
string or null (fields) | No | Optional headline. Never invented when absent. |
visibility |
string | No | New drafts default to listed. Listed posts appear in feeds after publication; unlisted posts are reachable only by their URL. This setting does not publish the draft. default: "listed"; enum: ["listed","unlisted"] |
additionalProperties: false; required: ["idempotency_key"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
context |
object (fields) | No | The business this call acted on, its public website origin, and the location the call named, or null location fields when it named none. additionalProperties: false; required: ["organization_id","organization_name","organization_slug","organization_subdomain","organization_public_url","location_id","location_slug","location_title"] |
ok |
boolean | Yes | |
post |
object (fields) | Yes | required: ["id","slug","status","visibility","media","publications","updated_at"] |
replayed |
boolean | No | True when this idempotency_key had already created the post. |
required: ["ok","post"]
Delete channel post — delete_channel_post
Permanently delete exactly the provider_post_id on the explicitly selected connected Facebook Page, or the KrabiClaw bot's message in the connected Discord channel. Keeps the website post and marks its publication receipt removed. Read get_social_connections and list_channel_posts first. Instagram deletion is unavailable with this app's Instagram Login connection; delete Instagram posts in Instagram. Use delete_post to remove website content separately.
Minimum role: admin. Required entitlement: None.
Annotations: title: Delete channel post, readOnlyHint: false, openWorldHint: true, destructiveHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
channel |
string | Yes | enum: ["facebook","discord"] |
connection_revision |
string | Yes | The connection_revision returned with that target. |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
provider_post_id |
string | Yes | |
target_id |
string | Yes | The exact target_id returned by get_social_connections. |
additionalProperties: false; required: ["channel","target_id","connection_revision","provider_post_id"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
channel |
string | Yes | enum: ["facebook","discord"] |
deleted |
boolean | Yes | |
provider_post_id |
string | Yes | |
publication |
object or null (fields) | Yes | required: ["id","state"] |
target_id |
string | Yes |
required: ["channel","target_id","provider_post_id","deleted","publication"]
Delete post — delete_post
Delete a post from the website. Its Facebook, Instagram and Discord posts are not deleted; use delete_channel_post for an explicit supported channel deletion. Refused while a publication of it is in progress or unresolved.
Minimum role: admin. Required entitlement: None.
Annotations: title: Delete post, readOnlyHint: false, openWorldHint: true, destructiveHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
post_id |
string | Yes |
additionalProperties: false; required: ["post_id"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
deleted |
boolean | Yes | |
post_id |
string | Yes |
required: ["post_id","deleted"]
Get channel post — get_channel_post
Read one post from the selected connected Facebook Page, Instagram professional account or Discord channel when the user wants its current caption, media or link. Use provider_post_id from list_channel_posts with the exact target from get_social_connections. Website content is unchanged.
Minimum role: admin. Required entitlement: None.
Annotations: title: Get channel post, readOnlyHint: true, idempotentHint: true, openWorldHint: false, destructiveHint: false.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
channel |
string | Yes | enum: ["facebook","instagram","discord"] |
connection_revision |
string | Yes | The connection_revision returned with that target. |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
provider_post_id |
string | Yes | |
target_id |
string | Yes | The exact target_id returned by get_social_connections. |
additionalProperties: false; required: ["channel","target_id","connection_revision","provider_post_id"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
post |
object (fields) | Yes | additionalProperties: false; required: ["channel","target_id","provider_post_id","body","public_url","published_at","media"] |
required: ["post"]
Get post — get_post
Read a short website post before editing or publishing it. Returns its caption, call to action, ordered media, website status, draft preview link and stored Facebook, Instagram or Discord publication receipts. Use get_channel_post for current provider content.
Minimum role: admin. Required entitlement: None.
Annotations: title: Get post, readOnlyHint: true, idempotentHint: true, openWorldHint: false, destructiveHint: false.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
post_id |
string | Yes |
additionalProperties: false; required: ["post_id"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
post |
object (fields) | Yes | required: ["id","slug","status","visibility","media","publications","updated_at"] |
required: ["post"]
Get social connections — get_social_connections
Read the site’s website, Facebook Page, Instagram and Discord channel publishing connections before selecting a publication target. Returns target_id, connection_revision, supported formats and operations, setup links, and problems, including whether Meta currently accepts each connection and whether the KrabiClaw bot can still post to the connected Discord channel. Credentials are not returned.
Minimum role: admin. Required entitlement: None.
Annotations: title: Get social connections, readOnlyHint: true, idempotentHint: true, openWorldHint: false, destructiveHint: false.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
additionalProperties: false; required: []
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
channels |
array of object (fields) | Yes | |
website |
object (fields) | Yes | required: ["channel","target_id","label"] |
required: ["website","channels"]
List channel posts — list_channel_posts
Read live posts directly from the explicitly selected connected Facebook Page, Instagram professional account or Discord channel; for Discord, the KrabiClaw bot's messages there. Does not import website posts or media. Read get_social_connections first and supply the exact channel, target_id and connection_revision. next_after is the provider's cursor; pass it as after for the next page.
Minimum role: admin. Required entitlement: None.
Annotations: title: List channel posts, readOnlyHint: true, idempotentHint: true, openWorldHint: false, destructiveHint: false.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
after |
string | No | |
channel |
string | Yes | enum: ["facebook","instagram","discord"] |
connection_revision |
string | Yes | The connection_revision returned with that target. |
limit |
integer | No | default: 25; maximum: 100; minimum: 1 |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
target_id |
string | Yes | The exact target_id returned by get_social_connections. |
additionalProperties: false; required: ["channel","target_id","connection_revision"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
next_after |
string or null | Yes | |
posts |
array of object (fields) | Yes |
required: ["posts","next_after"]
List posts — list_posts
List draft or published short website posts when the user wants to find announcements to review or edit. Results are paginated, newest change first. Filter by location_id for one location. Use list_channel_posts for live Facebook or Instagram posts.
Minimum role: admin. Required entitlement: None.
Annotations: title: List posts, readOnlyHint: true, idempotentHint: true, openWorldHint: false, destructiveHint: false.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
cursor |
string | No | Opaque next_cursor from the previous page. |
limit |
number | No | Page size. Defaults to 50; maximum 100. maximum: 100; minimum: 1 |
location_id |
string | No | Only posts scoped to this location. |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
status |
string | No | enum: ["draft","published"] |
additionalProperties: false; required: []
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
page_info |
object (fields) | Yes | required: ["has_more","next_cursor"] |
posts |
array of object (fields) | Yes |
required: ["posts","page_info"]
Publish post — publish_post
Publish the post to the selected website or social destinations, returning one result per target. Retry processing with the same post; reconcile an unknown result before publishing again.
Minimum role: admin. Required entitlement: None.
Annotations: title: Publish post, readOnlyHint: false, openWorldHint: true, destructiveHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
expected_updated_at |
string | Yes | The post's updated_at as you last read it. |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
post_id |
string | Yes | |
targets |
array of object (fields) | Yes | One entry per destination, each channel at most once. maxItems: 4; minItems: 1 |
additionalProperties: false; required: ["post_id","expected_updated_at","targets"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
ok |
boolean | Yes | True only when every requested target is published or already published. |
outcomes |
array of object (fields) | Yes | |
post_id |
string | Yes | |
updated_at |
string | Yes |
additionalProperties: false; required: ["ok","post_id","updated_at","outcomes"]
Reconcile post publication — reconcile_post_publication
Read an existing social publication and refresh its receipt without publishing. Supply provider_post_id only for the exact post on the connected destination; unproven outcomes remain unknown.
Minimum role: admin. Required entitlement: None.
Annotations: title: Reconcile post publication, readOnlyHint: false, openWorldHint: false, destructiveHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
provider_post_id |
string | No | Optional: the Facebook post id, Instagram media id or Discord message id it became. |
publication_id |
string | Yes | The publication id from get_post or a publish_post outcome. |
additionalProperties: false; required: ["publication_id"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
publication |
object (fields) | Yes | additionalProperties: false; required: ["channel","target_id","status"] |
state |
string | Yes | const: "published" |
additionalProperties: false; required: ["state","publication"]
Update post — update_post
Change at least one supplied website post field. First call get_post for its updated_at and use that as expected_updated_at. Omitted fields retain their values; null clears a nullable field. Published social posts are unchanged; unresolved publication prevents content edits.
Minimum role: admin. Required entitlement: None.
Annotations: title: Update post, readOnlyHint: false, openWorldHint: true, destructiveHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
body |
string or null (fields) | No | The caption, plain text; newlines are kept. |
call_to_action |
object or null (fields) | No | |
expected_updated_at |
string | Yes | Current post.updated_at from get_post. A stale revision refuses the change. |
location_id |
string or null (fields) | No | Omit to retain the current scope. A location ID scopes the post there; null makes it organization-wide. |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
post_id |
string | Yes | |
title |
string or null (fields) | No | Optional headline. Never invented when absent. |
visibility |
string | No | listed shows the post in feeds; unlisted keeps it reachable by its URL only. Neither makes a draft public. enum: ["listed","unlisted"] |
additionalProperties: false; required: ["post_id","expected_updated_at"]
anyOf: shape 1, shape 2, shape 3, shape 4, shape 5.
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
context |
object (fields) | No | The business this call acted on, its public website origin, and the location the call named, or null location fields when it named none. additionalProperties: false; required: ["organization_id","organization_name","organization_slug","organization_subdomain","organization_public_url","location_id","location_slug","location_title"] |
ok |
boolean | Yes | |
post |
object (fields) | Yes | required: ["id","slug","status","visibility","media","publications","updated_at"] |
replayed |
boolean | No | True when this idempotency_key had already created the post. |
required: ["ok","post"]
Products
Batch create products — batch_create_products
Create several products in the selected site’s catalog when the user supplies a new catalog batch. Validates every entry before writing; any invalid entry rejects the complete request. Publication and location offerings are assigned separately.
Minimum role: admin. Required entitlement: None.
Annotations: title: Batch create products, readOnlyHint: false, openWorldHint: false, destructiveHint: false, idempotentHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
idempotency_key |
string | Yes | maxLength: 200; minLength: 1 |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
products |
array of object (fields) | Yes | maxItems: 400; minItems: 1 |
additionalProperties: false; required: ["products","idempotency_key"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
products |
array of object (fields) | Yes |
required: ["products"]
Create collection — create_collection
Create an empty product collection, such as a menu section, site-wide or at the named location. Returns the saved collection and its ID. Add products separately with set_collection_products; existing products and collections stay unchanged.
Minimum role: admin. Required entitlement: None.
Annotations: title: Create collection, readOnlyHint: false, openWorldHint: true, destructiveHint: false.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
description |
string or null | No | |
location_id |
string or null | No | Narrow this collection to one location, or omit for site-wide. |
name |
string | Yes | |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
sort_order |
integer | No |
additionalProperties: false; required: ["name"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
collection |
object (fields) | Yes | additionalProperties: false; required: ["id","organization_id","location_id","name","slug","description","image","sort_order"] |
required: ["collection"]
Create product — create_product
Add food or drink, an experience or class, a practice area or consultation, or a place to stay. An experience can start as a private draft without booking setup. To make it public, configure its booking flow or supply an external booking URL. Supplying booking creates its configuration, offering, schedule and public page together, using instant confirmation and no online collection by default. A place to stay needs stay (its location and stay settings), keeps its public house rules in details, and is priced per night by its variant price; guests book it on the site and pay in full, so it takes no order_url and publishes only once it has a nightly price and online payments are set up. Repeat the same idempotency key on retry.
Minimum role: admin. Required entitlement: None.
Annotations: title: Create product, readOnlyHint: false, openWorldHint: true, destructiveHint: false, idempotentHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
active |
boolean | No | Enable or disable this product. Increasing the number of live homes requires the dashboard. |
booking |
object (fields) | No | Complete booking setup for a published offering. Legal consultations require provider scheduling and an explicitly selected attorney or legal team. At a location, provide weekly_slots or dated sessions; an update can retain its saved weekly times. location_id null holds it online: it needs scheduling_mode provider with an assigned member or team, takes no weekly_slots or sessions, and is booked in that provider's working hours. Runtime validation requires actual future availability before publication. additionalProperties: false; required: ["location_id","duration_minutes","default_capacity"] |
description |
string | No | |
details |
object (fields) | No | Named customer-facing facts for the product kind. This is a complete replacement map; preserve fields to retain. pricing_note contains explicitly stated price wording and requires empty numeric prices. additionalProperties: false |
idempotency_key |
string | Yes | Repeat the same key with the same request to get the product it created instead of a second one. maxLength: 200; minLength: 1 |
kind |
string | Yes | The customer-facing kind: dish (food or drink), experience (experience or class), service (practice area or consultation), or stay (place to stay). Determines the allowed descriptive fields; booking and stock remain separate capabilities. enum: ["dish","experience","service","stay"] |
marketing_features |
array of string (fields) | No | Generic selling bullets. Inclusions, preparation instructions and policies are separate details. maxItems: 15 |
metadata |
object | No | Opaque string annotations for integrations. No pricing, scheduling, stock or filtering behavior may read these. additionalProperties: {"type":"string"} |
name |
string | Yes | |
options |
array of object (fields) | No | maxItems: 3 |
order_url |
string or null | No | External ordering or booking destination, such as Uber Eats, an experience checkout, or Clio Grow. When set, public actions use this URL instead of native booking. Null restores the configured native flow. |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
page |
object (fields) | No | A source page created with this product and bound to it, in the same write. Omit for a product without a page of its own. additionalProperties: false; required: ["title","blocks"] |
stay |
object (fields) | No | Required for kind stay and refused for every other kind: the location the home is at (fixed once created) and its stay settings. Guest-facing house rules go in details.house_rules. Base nightly rate is the variant price. additionalProperties: false; required: ["location_id","check_in_time","check_out_time","max_guests","min_nights"] |
tax_code |
string or null | No | |
unit_label |
string or null | No | A unit noun such as "person" or "night". Never pricing prose. |
variants |
array of object (fields) | No | Omit to create a single default variant. Required once the product has options. maxItems: 250; minItems: 1 |
additionalProperties: false; required: ["name","kind","idempotency_key"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
product |
object (fields) | Yes | additionalProperties: false; required: ["id","kind","name","slug","description","active","options","variants","details","publications","locations","collections","source","created_at","updated_at"] |
required: ["product"]
Delete collection — delete_collection
Permanently delete the selected product collection and its memberships when the user asks to remove that group. Returns deleted status; its products remain in the catalog and other collections.
Minimum role: admin. Required entitlement: None.
Annotations: title: Delete collection, readOnlyHint: false, openWorldHint: true, destructiveHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
collection_id |
string | Yes | |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
additionalProperties: false; required: ["collection_id"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
deleted |
boolean | Yes |
required: ["deleted"]
Delete product — delete_product
Delete a product and its public page. Booking history prevents deletion; pause bookings or withhold publication to retain it.
Minimum role: admin. Required entitlement: None.
Annotations: title: Delete product, readOnlyHint: false, openWorldHint: true, destructiveHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
product_id |
string | Yes |
additionalProperties: false; required: ["product_id"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
deleted |
boolean | Yes |
required: ["deleted"]
Delete product booking config — delete_product_booking_config
Delete the selected product’s booking configuration to disable its session booking. Returns deleted status. Refused if any booking history exists, including cancelled bookings; the catalog product itself remains.
Minimum role: admin. Required entitlement: None.
Annotations: title: Delete product booking config, readOnlyHint: false, openWorldHint: true, destructiveHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
product_id |
string | Yes |
additionalProperties: false; required: ["product_id"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
deleted |
boolean | Yes |
required: ["deleted"]
Get product — get_product
Read one site product before reviewing or editing its options, variants, prices, media, publication, locations, collections, named product facts or booking defaults. Prices belong to variants; booking defaults apply to new sessions.
Minimum role: member. Required entitlement: None.
Annotations: title: Get product, readOnlyHint: true, idempotentHint: true, openWorldHint: false, destructiveHint: false.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
product_id |
string | Yes |
additionalProperties: false; required: ["product_id"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
product |
object (fields) | Yes | additionalProperties: false; required: ["id","kind","name","slug","description","active","options","variants","details","publications","locations","collections","source","created_at","updated_at"] |
required: ["product"]
List collections — list_collections
List the selected site’s product collections when the user wants to find menu sections or other product groups. Returns their public display order. Supply location_id to narrow the list to one location.
Minimum role: admin. Required entitlement: None.
Annotations: title: List collections, readOnlyHint: true, idempotentHint: true, openWorldHint: false, destructiveHint: false.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
location_id |
string or null | No | |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
additionalProperties: false; required: []
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
collections |
array of object (fields) | Yes |
required: ["collections"]
List location products — list_location_products
List product identities offered at one selected location. Results are paginated; published_only narrows to published offerings. Use list_products for the whole site.
Minimum role: admin. Required entitlement: None.
Annotations: title: List location products, readOnlyHint: true, idempotentHint: true, openWorldHint: false, destructiveHint: false.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
cursor |
string | No | Opaque next_cursor from the previous page. |
featured |
boolean | No | |
kind |
string | No | enum: ["dish","experience","service","stay"] |
limit |
number | No | Page size. Defaults to 50; maximum 100. maximum: 100; minimum: 1 |
location_id |
string | Yes | |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
published_only |
boolean | No |
additionalProperties: false; required: ["location_id"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
counts |
object (fields) | Yes | additionalProperties: false; required: ["total","by_kind"] |
page_info |
object (fields) | Yes | required: ["has_more","next_cursor"] |
products |
array of object (fields) | Yes | |
scope |
object (fields) | Yes | additionalProperties: false; required: ["view","organization_id","kind","published_only"] |
additionalProperties: false; required: ["scope","counts","products","page_info"]
List products — list_products
List products carried by the selected site, published or withheld. Results include products across the site; list_location_products narrows to one location.
Minimum role: member. Required entitlement: None.
Annotations: title: List products, readOnlyHint: true, idempotentHint: true, openWorldHint: false, destructiveHint: false.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
cursor |
string | No | Opaque next_cursor from the previous page. |
featured |
boolean | No | |
kind |
string | No | enum: ["dish","experience","service","stay"] |
limit |
number | No | Page size. Defaults to 50; maximum 100. maximum: 100; minimum: 1 |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
published_only |
boolean | No |
additionalProperties: false; required: []
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
counts |
object (fields) | Yes | additionalProperties: false; required: ["total","by_kind"] |
page_info |
object (fields) | Yes | required: ["has_more","next_cursor"] |
products |
array of object (fields) | Yes | |
scope |
object (fields) | Yes | additionalProperties: false; required: ["view","organization_id","kind","published_only"] |
additionalProperties: false; required: ["scope","counts","products","page_info"]
Reconcile products — reconcile_products
Synchronize complete catalog entries in one atomic local write. Existing product IDs preserve identity; supplied variants, prices and options replace their lists. Omitted products stay unchanged unless deactivate_missing disables them. A new home requires stay settings. Changed connected-home settings and nightly prices are pushed to Airbnb through Channex after saving. Unsupported connected-listing settings are refused before any local writes; a failed channel completion reports committed changes with CHANNEL_PUSH_FAILED. Repeat the same idempotency key for an identical retry. Use update_menu for a restaurant menu and update_product for a partial edit. Increasing the number of live homes requires the dashboard.
Minimum role: admin. Required entitlement: None.
Annotations: title: Reconcile products, readOnlyHint: false, openWorldHint: true, destructiveHint: true, idempotentHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
deactivate_missing |
boolean | No | |
idempotency_key |
string | Yes | maxLength: 200; minLength: 1 |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
products |
array of object (fields) | Yes | maxItems: 200 |
additionalProperties: false; required: ["products","idempotency_key"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
products |
array of object (fields) | Yes |
required: ["products"]
Remove product location — remove_product_location
Remove the selected product’s offering at one explicit location and return its product and location IDs with removed true. The catalog product, prices and other location offerings remain. Read get_product to review them.
Minimum role: admin. Required entitlement: None.
Annotations: title: Remove product location, readOnlyHint: false, openWorldHint: true, destructiveHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
location_id |
string | Yes | |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
product_id |
string | Yes |
additionalProperties: false; required: ["product_id","location_id"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
location_id |
string | Yes | |
product_id |
string | Yes | |
removed |
boolean | Yes | const: true |
additionalProperties: false; required: ["product_id","location_id","removed"]
Reorder collections — reorder_collections
Set the display order of product collections for the whole site or one explicit location. Supply every collection ID in that scope exactly once; a partial list is rejected. When supplied, expected_collection_ids must match the full current order or the complete reorder is refused. Returns the ordered collections without changing their products.
Minimum role: admin. Required entitlement: None.
Annotations: title: Reorder collections, readOnlyHint: false, openWorldHint: true, destructiveHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
collection_ids |
array of string (fields) | Yes | minItems: 1; uniqueItems: true |
expected_collection_ids |
array of string (fields) | No | Optional full ordered snapshot from list_collections; when supplied, a stale snapshot rejects the entire reorder. uniqueItems: true |
location_id |
string or null | No | |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
additionalProperties: false; required: ["collection_ids"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
collections |
array of object (fields) | Yes |
required: ["collections"]
Replace product weekly schedule — replace_product_weekly_schedule
Replace a product’s weekly time slots at one location when the user wants to change its recurring schedule. Times are in that location’s timezone and use the product duration/capacity. An online offering has no weekly slots: it is booked in its provider’s working hours (set_member_scheduling). An empty slots array clears that schedule. Sessions with any booking history are preserved; removed future sessions without bookings are cancelled, and re-added unbooked slots can reopen with current defaults.
Minimum role: member. Required entitlement: None.
Annotations: title: Replace product weekly schedule, readOnlyHint: false, openWorldHint: true, destructiveHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
location_id |
string | Yes | A saved location ID. |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
product_id |
string | Yes | |
slots |
array of object (fields) | Yes |
additionalProperties: false; required: ["product_id","location_id","slots"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
cancelled |
integer | Yes | |
rules |
array of object (fields) | Yes | |
sessions |
object (fields) | Yes | additionalProperties: false; required: ["created","existing","skipped"] |
additionalProperties: false; required: ["rules","sessions","cancelled"]
Set collection products — set_collection_products
Set a collection’s complete product membership and order. Supply every product ID to retain. When supplied, expected_product_ids is the full ordered snapshot being edited; a stale snapshot refuses every change. To move removed products into another explicitly named same-organization collection, supply move_to and both collections’ complete expected_product_ids. A move keeps the destination’s current order and appends source removals in source order without duplicates. Returns the source products; read the catalog to verify both sections.
Minimum role: admin. Required entitlement: None.
Annotations: title: Set collection products, readOnlyHint: false, openWorldHint: true, destructiveHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
collection_id |
string | Yes | |
expected_product_ids |
array of string (fields) | No | When supplied, reject changes unless this exactly matches the collection’s current product order. Required with move_to. maxItems: 2000; uniqueItems: true |
move_to |
object (fields) | No | additionalProperties: false; required: ["collection_id","expected_product_ids"] |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
product_ids |
array of string (fields) | Yes | maxItems: 2000; uniqueItems: true |
additionalProperties: false; required: ["collection_id","product_ids"]
allOf: shape 1.
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
products |
array of object (fields) | Yes |
required: ["products"]
Set product booking config — set_product_booking_config
Configure booking duration, capacity, scheduling and the questions asked with each booking (for example an assessment visit's property questions). New settings default to instant confirmation and no online collection. Omitted fields retain saved settings; existing sessions keep their times and capacity. Read settings with get_product.
Minimum role: member. Required entitlement: None.
Annotations: title: Set product booking config, readOnlyHint: false, openWorldHint: true, destructiveHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
assigned_member_id |
string or null | No | Host membership ID from list_organization_members → members[].id or get_member_scheduling → members[].id, not userId. Guests see this member’s approved public profile. Read get_member_public_profile; publication requires an approved profile with a nonblank public_name. Clear assigned_team_id when choosing a member. |
assigned_team_id |
string or null | No | Host team ID from list_teams. Guests see the team’s members with approved public profiles; at least one is required for publication. Clear assigned_member_id when choosing a team. |
confirmation_mode |
string | No | instant confirms immediately (default); review waits for staff approval. default: "instant"; enum: ["instant","review"] |
default_capacity |
integer or null | No | Places per session; null means unlimited, zero closes seats. minimum: 0 |
duration_minutes |
integer or null | No | Minutes each visit occupies its booking slot or seats, independent of the interval between start times. Null clears an existing duration. minimum: 1 |
expected_questions_revision |
string | No | booking.questions_revision (or stay.questions_revision) from get_product; required with questions. |
held_online |
boolean | No | True holds the offering online: its times are its provider's working hours, in the provider's timezone. Requires scheduling_mode provider with an assigned member or team. |
online_payment_required |
boolean | No | True requires online payment when booking; false is the default and does not collect online. default: false |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
product_id |
string | Yes | |
questions |
array of object (fields) | No | Replace the questions asked with each booking. Read get_product first and keep existing question IDs. A question-only change never moves or regenerates sessions. maxItems: 20 |
scheduling_mode |
string | No | Legal consultations require provider scheduling with an explicitly assigned attorney or legal team. Experiences may use legacy business scheduling without one named provider. Physical provider times also respect the selected member’s availability; online times come from their working hours. enum: ["legacy","provider"] |
additionalProperties: false; required: ["product_id"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
config |
object or null (fields) | Yes | required: ["duration_minutes","default_capacity","confirmation_mode","online_payment_required","held_online","questions","questions_revision"] |
required: ["config"]
Set product location — set_product_location
Set whether the selected location offers a product and shows it on that location’s website. A new location relationship defaults active and published to true; on an existing relationship, omitted flags retain their values. Returns the saved location flags. Existing prices do not establish a location offering; read get_product for the complete product.
Minimum role: admin. Required entitlement: None.
Annotations: title: Set product location, readOnlyHint: false, openWorldHint: true, destructiveHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
active |
boolean | No | |
location_id |
string | Yes | |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
product_id |
string | Yes | |
published |
boolean | No |
additionalProperties: false; required: ["product_id","location_id"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
active |
boolean | Yes | |
location_id |
string | Yes | |
product_id |
string | Yes | |
published |
boolean | Yes |
additionalProperties: false; required: ["product_id","location_id","active","published"]
Set product publication — set_product_publication
Publish or withhold a product on the selected site and return its saved publication flag. Read get_product first. A home or offering booked on this site needs an assigned host with an approved public profile and nonblank public_name: find membership IDs in list_organization_members, read get_member_public_profile, and author or approve the profile through update_member_public_profile. Assignment alone does not publish a profile. Other publication prerequisites, including pricing and availability, still apply. This setting is independent of whether the product is available for sale and of visibility at individual locations. Increasing the number of live homes requires the dashboard.
Minimum role: admin. Required entitlement: None.
Annotations: title: Set product publication, readOnlyHint: false, openWorldHint: true, destructiveHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
product_id |
string | Yes | |
published |
boolean | Yes |
additionalProperties: false; required: ["product_id","published"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
organization_id |
string | Yes | |
product_id |
string | Yes | |
published |
boolean | Yes |
additionalProperties: false; required: ["product_id","organization_id","published"]
Update collection — update_collection
Change the selected product collection’s name, description or display position and return the saved collection. Only supplied fields change; membership uses set_collection_products and ordering several collections uses reorder_collections.
Minimum role: admin. Required entitlement: None.
Annotations: title: Update collection, readOnlyHint: false, openWorldHint: true, destructiveHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
collection_id |
string | Yes | |
description |
string or null | No | |
name |
string | No | |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
sort_order |
integer | No |
additionalProperties: false; required: ["collection_id"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
collection |
object (fields) | Yes | additionalProperties: false; required: ["id","organization_id","location_id","name","slug","description","image","sort_order"] |
required: ["collection"]
Update menu — update_menu
Update and publish supplied menu dishes, prices and sections at the selected location. Omitted items, variants, prices and order remain; new items and sections append in supplied order. Returns the location’s menu sections and dishes.
Minimum role: admin. Required entitlement: None.
Annotations: title: Update menu, readOnlyHint: false, openWorldHint: true, destructiveHint: true, idempotentHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
idempotency_key |
string | Yes | maxLength: 200; minLength: 1 |
location_id |
string | Yes | |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
sections |
array of object (fields) | Yes | maxItems: 30; minItems: 1 |
additionalProperties: false; required: ["location_id","idempotency_key","sections"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
public_url |
string or null | Yes | |
replayed |
boolean | Yes | |
sections |
array of object (fields) | Yes |
additionalProperties: false; required: ["sections","replayed","public_url"]
Update product — update_product
Edit a product and return its updated record. For a price change, supply the variant ID, price ID and unit_amount. Variants and prices merge by ID; omitted entries stay. Supplied options and details replace their current values by default. Use details_mode merge for focused fact edits, preserving unmentioned facts and clearing named facts with null. Booking setup also creates sessions and publishes the offering. For a connected Airbnb home, changed arrival/departure windows, cancellation, pet/smoking/event rules and minimum stays update supported listing settings through Channex. Unsupported connected-listing settings are refused before saving. A failed channel completion reports the committed edit with CHANNEL_PUSH_FAILED; reload before retrying. Increasing the number of live homes requires the dashboard.
Minimum role: member. Required entitlement: None.
Annotations: title: Update product, readOnlyHint: false, openWorldHint: true, destructiveHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
active |
boolean | No | Enable or disable this product. Increasing the number of live homes requires the dashboard. |
booking |
object (fields) | No | Complete booking setup for a published offering. Legal consultations require provider scheduling and an explicitly selected attorney or legal team. At a location, provide weekly_slots or dated sessions; an update can retain its saved weekly times. location_id null holds it online: it needs scheduling_mode provider with an assigned member or team, takes no weekly_slots or sessions, and is booked in that provider's working hours. Runtime validation requires actual future availability before publication. additionalProperties: false; required: ["location_id","duration_minutes","default_capacity"] |
description |
string | No | |
details |
object (fields) | No | Named customer-facing facts for the product kind. Omitted details stay unchanged. Supplied details replace their map by default, retaining featured unless supplied. With details_mode merge, only supplied facts change and null removes a named fact. pricing_note requires empty numeric prices. additionalProperties: false |
details_mode |
string | No | Requires details. replace is the default complete replacement map, retaining featured unless supplied; null is refused. merge preserves unmentioned facts and null explicitly removes a named fact. Unknown keys are refused in either mode. default: "replace"; enum: ["merge","replace"] |
expected_updated_at |
string | No | The Product updated_at from the read being edited. A stale value refuses the entire update, including options, variants and prices. Omit only for a deliberate update based on current state. minLength: 1 |
idempotency_key |
string | No | Required with booking setup. Repeat the same key with the same request for an identical retry. maxLength: 200; minLength: 1 |
kind |
string | No | The customer-facing kind: dish (food or drink), experience (experience or class), service (practice area or consultation), or stay (place to stay). Determines the allowed descriptive fields; booking and stock remain separate capabilities. enum: ["dish","experience","service","stay"] |
marketing_features |
array of string (fields) | No | Generic selling bullets. Inclusions, preparation instructions and policies are separate details. maxItems: 15 |
metadata |
object | No | Opaque string annotations for integrations. No pricing, scheduling, stock or filtering behavior may read these. additionalProperties: {"type":"string"} |
name |
string | No | |
options |
array of object (fields) | No | Complete option list when supplied; omitted options are removed. Omit to preserve existing options and selections. maxItems: 3 |
order_url |
string or null | No | External ordering or booking destination, such as Uber Eats, an experience checkout, or Clio Grow. When set, public actions use this URL instead of native booking. Null restores the configured native flow. |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
product_id |
string | Yes | |
stay |
object (fields) | No | Stay settings to change on a place to stay. Its location is fixed. additionalProperties: false |
tax_code |
string or null | No | |
unit_label |
string or null | No | A unit noun such as "person" or "night". Never pricing prose. |
variants |
array of object (fields) | No | Partial existing variants by id or new variants. Omitted variants and their prices/options remain unless variants_mode is replace. Existing variant and price IDs retain their identities. maxItems: 250; minItems: 1 |
variants_mode |
string | No | merge preserves variants omitted from the supplied list. replace explicitly removes omitted variants and their owned records; removal is refused once a variant has booking history. Applies only with variants. default: "merge"; enum: ["merge","replace"] |
additionalProperties: false; required: ["product_id"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
product |
object (fields) | Yes | additionalProperties: false; required: ["id","kind","name","slug","description","active","options","variants","details","publications","locations","collections","source","created_at","updated_at","channel_push"] |
required: ["product"]
Providers
Get member public profile — get_member_public_profile
Read one organization membership’s authored public host name, photo, biography, approval and shared revision, including unpublished drafts. A valid membership without saved settings returns profile null. This is separate from the person’s Better Auth account profile and does not return working hours or Calendar data. Ordinary members can read only themselves; owners/admins can inspect their team.
Minimum role: member. Required entitlement: None.
Annotations: title: Get member public profile, readOnlyHint: true, idempotentHint: true, openWorldHint: false, destructiveHint: false.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
member_id |
string | Yes | Organization membership ID from get_member_scheduling.members[].id or list_organization_members.members[].id, not the person’s userId. Ordinary members may name only their own membership. minLength: 1 |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
additionalProperties: false; required: ["member_id"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
profile |
object or null (fields) | Yes | additionalProperties: false; required: ["member_id","updated_at","public_name","public_photo_url","public_bio","public_approved"] |
additionalProperties: false; required: ["profile"]
Get member scheduling — get_member_scheduling
List accessible organization memberships and their hours, time off and Calendar status when member_id is omitted, or read one membership’s scheduling. A valid membership without saved settings returns scheduling null. A profile-only record has null timezone, weekly and time_off. Use get_member_public_profile for authored host profiles and approval. Ordinary members can read only themselves; owners/admins can inspect their team. No Google event content or credentials are returned.
Minimum role: member. Required entitlement: None.
Annotations: title: Get member scheduling, readOnlyHint: true, idempotentHint: true, openWorldHint: false, destructiveHint: false.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
member_id |
string | No | Organization membership ID from get_member_scheduling.members[].id or list_organization_members.members[].id, not the person’s userId. Ordinary members may name only their own membership. minLength: 1 |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
additionalProperties: false; required: []
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
members |
array of object (fields) | No | |
scheduling |
object or null (fields) | No | additionalProperties: false; required: ["member_id","timezone","updated_at","weekly","time_off","calendar_account_id","calendar_ids","calendar_status","busy_from","busy_until","busy_checked_at","busy_error","calendar_conflict_count","calendar_conflicts"] |
additionalProperties: false
Set member busy calendars — set_member_busy_calendars
Google Calendar sync. Selecting calendars needs the Business plan; disconnecting never does. After working hours are authored, select busy-input calendars using the member’s already-linked Google account and known calendar IDs. Only that member may select their linked account; an administrator can disconnect it. This tool does not connect Google or discover calendars. Returns the saved selection and check status. Stale or disconnected selected calendars block availability; no selected calendars uses internal scheduling.
Minimum role: member. Required entitlement: None.
Annotations: title: Set member busy calendars, readOnlyHint: false, openWorldHint: false, destructiveHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
account_id |
string or null | Yes | Existing member Google account with free/busy scopes; null with no calendars disconnects. Does not grant OAuth access. |
calendar_ids |
array of string (fields) | Yes | Busy-input calendars, separate from organization booking output. Empty pauses checking; existing bookings and Google events are unchanged. maxItems: 10; uniqueItems: true |
member_id |
string | Yes | Organization membership ID from get_member_scheduling.members[].id or list_organization_members.members[].id, not the person’s userId. Ordinary members may name only their own membership. minLength: 1 |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
additionalProperties: false; required: ["member_id","account_id","calendar_ids"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
scheduling |
object (fields) | Yes | additionalProperties: false; required: ["member_id","updated_at","calendar_account_id","calendar_ids","calendar_status","calendar_conflict_count"] |
additionalProperties: false; required: ["scheduling"]
Set member scheduling — set_member_scheduling
Change a member’s working hours or time off using the latest shared revision from get_member_scheduling. Omitted fields retain their values. When saved timezone is null, provide timezone, weekly and time_off together; explicit empty arrays mean no working hours or time off. Later edits can supply only changed fields. Returns the saved hours and revision. Changes affect future bookable availability; existing booking assignments and times stay fixed and no guest messages are sent. Public host profile edits use update_member_public_profile.
Minimum role: member. Required entitlement: None.
Annotations: title: Set member scheduling, readOnlyHint: false, openWorldHint: true, destructiveHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
expected_updated_at |
string or null | Yes | Latest updated_at from get_member_scheduling or get_member_public_profile; null only when that read returns null. Both concerns share this revision, so either kind of edit can make an earlier read stale. format: "date-time" |
member_id |
string | Yes | Organization membership ID from get_member_scheduling.members[].id or list_organization_members.members[].id, not the person’s userId. Ordinary members may name only their own membership. minLength: 1 |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
time_off |
array of object (fields) | No | maxItems: 100 |
timezone |
string | No | IANA timezone for these working hours. |
weekly |
array of object (fields) | No | maxItems: 28 |
additionalProperties: false; required: ["member_id","expected_updated_at"]
anyOf: shape 1, shape 2, shape 3.
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
scheduling |
object (fields) | Yes | additionalProperties: false; required: ["member_id","updated_at","timezone","weekly","time_off"] |
additionalProperties: false; required: ["scheduling"]
Update member public profile — update_member_public_profile
Edit only the supplied public host profile fields using the latest shared revision from get_member_public_profile. Omitted fields retain their values; null clears a field. Profile content edits revoke prior approval unless an owner/admin explicitly approves that edit. Only owners/admins may supply public_approved. True publishes the authored profile as a host on public offerings. False withholds it. Approval requires a nonblank public_name. A profile can be saved before any working hours exist; this operation leaves hours, time off and Calendar settings unchanged. Returns the saved profile and shared revision.
Minimum role: member. Required entitlement: None.
Annotations: title: Update member public profile, readOnlyHint: false, openWorldHint: true, destructiveHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
expected_updated_at |
string or null | Yes | Latest updated_at from get_member_scheduling or get_member_public_profile; null only when that read returns null. Both concerns share this revision, so either kind of edit can make an earlier read stale. format: "date-time" |
member_id |
string | Yes | Organization membership ID from get_member_scheduling.members[].id or list_organization_members.members[].id, not the person’s userId. Ordinary members may name only their own membership. minLength: 1 |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
public_approved |
boolean | No | Owner/admin only. True approves this authored profile for public host display; false withholds it. |
public_bio |
string or null | No | maxLength: 2000 |
public_name |
string or null | No | maxLength: 100 |
public_photo_url |
string or null | No | format: "uri"; maxLength: 2048 |
additionalProperties: false; required: ["member_id","expected_updated_at"]
anyOf: shape 1, shape 2, shape 3, shape 4.
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
profile |
object (fields) | Yes | additionalProperties: false; required: ["member_id","updated_at","public_name","public_photo_url","public_bio","public_approved"] |
additionalProperties: false; required: ["profile"]
Qa
Create Q&A — create_qa
Create authored Q&A in the explicit site, page or location scope. Omitted sort_order appends. This creates a new record on every call and is not idempotent: do not automatically retry an uncertain response. Imported Google content remains managed in Google.
Minimum role: admin. Required entitlement: None.
Annotations: title: Create Q&A, readOnlyHint: false, openWorldHint: true, destructiveHint: false.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
answer |
string or null | No | |
is_owner_answer |
boolean | No | |
location_id |
string or null | No | Location scope; omit or use null for site or page Q&A. A location ID cannot be combined with a non-null page_path. |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
page_path |
string or null | No | Page scope such as /about; omit or use null for general site or location Q&A. |
question |
string | Yes | Required non-empty question; at most 500 characters after trimming. |
question_author |
string or null | No | |
sort_order |
integer | No | |
status |
string | No | enum: ["published","hidden"] |
additionalProperties: false; required: ["question"]
allOf: shape 1.
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
created |
boolean | Yes | |
id |
string | Yes |
required: ["id","created"]
Delete Q&A — delete_qa
Delete authored Q&A and its content document tree in its explicit scope. Imported Google records are protected.
Minimum role: admin. Required entitlement: None.
Annotations: title: Delete Q&A, readOnlyHint: false, openWorldHint: true, destructiveHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
location_id |
string or null | No | Location scope; omit or use null for site or page Q&A. A location ID cannot be combined with a non-null page_path. |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
page_path |
string or null | No | Page scope such as /about; omit or use null for general site or location Q&A. |
qa_id |
string | Yes |
additionalProperties: false; required: ["qa_id"]
allOf: shape 1.
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
deleted |
boolean | Yes | |
qa_id |
string | Yes |
required: ["qa_id","deleted"]
List location Q&A — list_location_qa
Read Q&A for an explicit location. This tool lists authored and imported Q&A. Authored Q&A can be managed through the CMS and authored Q&A tools; imported Google question and answer content is managed in Google.
Minimum role: admin. Required entitlement: None.
Annotations: title: List location Q&A, readOnlyHint: true, idempotentHint: true, openWorldHint: false, destructiveHint: false.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
cursor |
string | No | Opaque next_cursor from the previous page. |
limit |
number | No | Page size. Defaults to 50; maximum 100. maximum: 100; minimum: 1 |
location_id |
string | Yes | |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
additionalProperties: false; required: ["location_id"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
items |
array of object (fields) | Yes | |
page_info |
object (fields) | Yes | required: ["has_more","next_cursor"] |
required: ["items","page_info"]
List organization Q&A — list_organization_qa
Read the site’s general Q&A, or the Q&A of one page when page_path is provided. This tool lists authored and imported Q&A. Authored Q&A can be managed through the CMS and authored Q&A tools; imported Google question and answer content is managed in Google.
Minimum role: admin. Required entitlement: None.
Annotations: title: List organization Q&A, readOnlyHint: true, idempotentHint: true, openWorldHint: false, destructiveHint: false.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
cursor |
string | No | Opaque next_cursor from the previous page. |
limit |
number | No | Page size. Defaults to 50; maximum 100. maximum: 100; minimum: 1 |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
page_path |
string or null | No | Public route path such as /about, /pricing, or /blog. Omit for general site Q&A. |
additionalProperties: false; required: []
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
items |
array of object (fields) | Yes | |
page_info |
object (fields) | Yes | required: ["has_more","next_cursor"] |
required: ["items","page_info"]
Reorder Q&A — reorder_qa
Set sort positions of authored Q&A records in one explicit scope. Every id must be distinct, manual and in scope; otherwise no record is reordered. Imported Google records are protected.
Minimum role: admin. Required entitlement: None.
Annotations: title: Reorder Q&A, readOnlyHint: false, openWorldHint: true, destructiveHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
location_id |
string or null | No | Location scope; omit or use null for site or page Q&A. A location ID cannot be combined with a non-null page_path. |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
page_path |
string or null | No | Page scope such as /about; omit or use null for general site or location Q&A. |
updates |
array of object (fields) | Yes | minItems: 1 |
additionalProperties: false; required: ["updates"]
allOf: shape 1.
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
updated |
integer | Yes |
required: ["updated"]
Update Q&A — update_qa
Update at least one authored Q&A field in its explicit scope. Omitted fields retain their values. Imported Google records and translations cannot be edited through this tool.
Minimum role: admin. Required entitlement: None.
Annotations: title: Update Q&A, readOnlyHint: false, openWorldHint: true, destructiveHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
answer |
string or null | No | |
is_owner_answer |
boolean | No | |
location_id |
string or null | No | Location scope; omit or use null for site or page Q&A. A location ID cannot be combined with a non-null page_path. |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
page_path |
string or null | No | Page scope such as /about; omit or use null for general site or location Q&A. |
qa_id |
string | Yes | |
question |
string | No | Required non-empty question; at most 500 characters after trimming. |
question_author |
string or null | No | |
sort_order |
integer | No | |
status |
string | No | enum: ["published","hidden"] |
additionalProperties: false; required: ["qa_id"]
anyOf: shape 1, shape 2, shape 3, shape 4, shape 5, shape 6.
allOf: shape 1.
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
qa_id |
string | Yes | |
updated |
boolean | Yes |
required: ["qa_id","updated"]
Reviews
List location reviews — list_location_reviews
Read reviews and existing replies for the selected location. Includes review provenance and verification status. Replies to imported Google reviews are managed in Google; this tool makes no changes.
Minimum role: admin. Required entitlement: None.
Annotations: title: List location reviews, readOnlyHint: true, idempotentHint: true, openWorldHint: false, destructiveHint: false.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
cursor |
string | No | Opaque next_cursor from the previous page. |
limit |
number | No | Page size. Defaults to 50; maximum 100. maximum: 100; minimum: 1 |
location_id |
string | Yes | |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
additionalProperties: false; required: ["location_id"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
page_info |
object (fields) | Yes | required: ["has_more","next_cursor"] |
reviews |
array of object (fields) | Yes |
required: ["reviews","page_info"]
List organization reviews — list_organization_reviews
Read site-wide reviews that have no location, including existing replies, provenance and verification status. This tool makes no changes.
Minimum role: admin. Required entitlement: None.
Annotations: title: List organization reviews, readOnlyHint: true, idempotentHint: true, openWorldHint: false, destructiveHint: false.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
cursor |
string | No | Opaque next_cursor from the previous page. |
limit |
number | No | Page size. Defaults to 50; maximum 100. maximum: 100; minimum: 1 |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
additionalProperties: false; required: []
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
page_info |
object (fields) | Yes | required: ["has_more","next_cursor"] |
reviews |
array of object (fields) | Yes |
required: ["reviews","page_info"]
Stays
Assign home photos to room — assign_home_photos_to_room
Assign existing home photos to one room group, to Additional photos, or to a newly created room. First call get_product: photo IDs are product.image.asset_id and product.gallery[].asset_id; current room membership is product.stay.photo_rooms. Supply exactly one destination: room_id with an existing ID, explicit room_id:null for Additional photos, or new_room_type. Omitting room_id does not mean null. Each selected photo needs its current expected_room_id; changed membership or a removed photo refuses the whole assignment, including new room creation. Returns the destination ID, new room ID if created and moved photo IDs. Changes only KrabiClaw; it does not update Airbnb. Edit Airbnb’s photo tour separately in Airbnb.
Minimum role: admin. Required entitlement: None.
Annotations: title: Assign home photos to room, readOnlyHint: false, openWorldHint: true, destructiveHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
new_room_type |
string | No | Create this room type and assign the photos to it. Omit room_id when using this destination. enum: ["art_studio","backyard","balcony","bedroom","bowling_alley","childrens_playroom","courtyard","darkroom","deck","dining_area","event_room","exterior","front_yard","full_bathroom","full_kitchen","game_room","garage","garden","gym","half_bathroom","hot_tub","kitchenette","laundry_area","library","living_room","movie_theater","music_studio","office","patio","photography_studio","pool","porch","rooftop","sunroom","terrace","theme_room","wine_cellar","woodshop","workshop","workspace"] |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
photos |
array of object (fields) | Yes | maxItems: 50; minItems: 1 |
product_id |
string | Yes | The place to stay: a product of kind stay, from list_products. minLength: 1 |
room_id |
string or null | No | Existing room ID from get_product → product.stay.photo_rooms, or explicit null for Additional photos. Omit only when supplying new_room_type. minLength: 1 |
additionalProperties: false; required: ["product_id","photos"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
created_room_id |
string or null | Yes | The newly created room’s ID when new_room_type was supplied; otherwise null. |
destination_room_id |
string or null | Yes | The saved destination room; null means Additional photos. |
moved_photo_ids |
array of string (fields) | Yes | The selected photo IDs whose assignment was saved. minItems: 1; uniqueItems: true |
product_id |
string | Yes | minLength: 1 |
additionalProperties: false; required: ["product_id","destination_room_id","created_room_id","moved_photo_ids"]
Cancel stay — cancel_stay
Cancel a host-entered stay under its current version, free its nights, cancel pending automatic guest messages and update availability on the home’s connected Airbnb listing through Channex. A failed channel update reports that cancellation was saved. If a website payment needs a refund, returns financial_action_required with an authenticated dashboard link before cancellation or financial writes. Offline refunds can be recorded separately with record_stay_payment; that record moves no money.
Minimum role: admin. Required entitlement: None.
Annotations: title: Cancel stay, readOnlyHint: false, openWorldHint: true, destructiveHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
expected_version |
integer | Yes | stay.version from the latest get_stay call; a stale version is refused. minimum: 1 |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
reason |
string | No | maxLength: 500 |
stay_id |
string | Yes | Stay ID from list_stays. minLength: 1 |
additionalProperties: false; required: ["stay_id","expected_version"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
channel_push |
object or null (fields) | Yes | What the home's connected channel took from this change: null when no channel push is needed; pushed when delivery completed; pending, with the reason, while it waits out Channex's rate limit or an unconfirmed attempt it sends again. A refused channel update returns a committed error. |
stay |
object (fields) | Yes | additionalProperties: false; required: ["id","product_id","request_id","status","version","updated_at","check_in_date","check_out_date","cancelled_at","cancellation_reason"] |
additionalProperties: false; required: ["stay","channel_push"]
Create home room — create_home_room
Create an empty room or space, such as Bedroom or Patio, for grouping an existing home’s photos. This creates a room group, not a photo or business location, and requires no amenity answers. Use assign_home_photos_to_room to group existing home photos afterward; save_media_attachment saves new attachments and attach_media adds library images to the home’s gallery. Returns the new room ID. Each call creates a new room; if the outcome is uncertain, read get_product before retrying. Changes only KrabiClaw; it does not update Airbnb. Edit Airbnb’s photo tour separately in Airbnb.
Minimum role: admin. Required entitlement: None.
Annotations: title: Create home room, readOnlyHint: false, openWorldHint: true, destructiveHint: false.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
product_id |
string | Yes | The place to stay: a product of kind stay, from list_products. minLength: 1 |
type |
string | Yes | Type of the empty room or space to create. enum: ["art_studio","backyard","balcony","bedroom","bowling_alley","childrens_playroom","courtyard","darkroom","deck","dining_area","event_room","exterior","front_yard","full_bathroom","full_kitchen","game_room","garage","garden","gym","half_bathroom","hot_tub","kitchenette","laundry_area","library","living_room","movie_theater","music_studio","office","patio","photography_studio","pool","porch","rooftop","sunroom","terrace","theme_room","wine_cellar","woodshop","workshop","workspace"] |
additionalProperties: false; required: ["product_id","type"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
product_id |
string | Yes | minLength: 1 |
room |
object (fields) | Yes | additionalProperties: false; required: ["id","type","photo_ids","details_version"] |
additionalProperties: false; required: ["product_id","room"]
Create stay — create_stay
Add a stay the host took directly and hold its nights. Read get_product for the home’s ID, capacity and currency. Children and infants default to zero; omitted arrival time, surname, contacts and notes remain unset. Another stay or checkout hold refuses overlapping nights. Takes no payment. Applies automatic guest-message schedules and updates connected Airbnb availability through Channex. Returns the saved stay’s identity, dates, version and channel completion; use get_stay for full details. Retry identical arguments with the same key. The retry checks current saved details, so later edits can cause IDEMPOTENCY_CONFLICT; read get_stay before another change.
Minimum role: admin. Required entitlement: None.
Annotations: title: Create stay, readOnlyHint: false, openWorldHint: true, destructiveHint: true, idempotentHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
adults |
integer | Yes | maximum: 99; minimum: 1 |
answers |
array of object (fields) | No | Answers to the home's questions (get_product → stay.questions), as the guest gave them to the host. maxItems: 20 |
arrival_time |
string or null | No | pattern: "^([01]\d|2[0-3]):[0-5]\d$" |
check_in_date |
string | Yes | pattern: "^\d{4}-\d{2}-\d{2}$" |
check_out_date |
string | Yes | The morning the guest leaves; the stay holds the nights before it. pattern: "^\d{4}-\d{2}-\d{2}$" |
children |
integer | No | maximum: 99; minimum: 0 |
guest_email |
string or null | No | |
guest_name |
string | Yes | maxLength: 200; minLength: 1 |
guest_phone |
string or null | No | International number with its country calling code, e.g. +66812345678. |
guest_surname |
string or null | No | maxLength: 200 |
idempotency_key |
string | Yes | Caller-supplied durable idempotency key. Reuse only for identical operation arguments. maxLength: 200; minLength: 1 |
infants |
integer | No | maximum: 99; minimum: 0 |
notes |
string or null | No | maxLength: 2000 |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
product_id |
string | Yes | The place to stay: a product of kind stay, from list_products. minLength: 1 |
questions_revision |
string | No | stay.questions_revision the answers were collected against; required with answers. |
total_minor |
integer | Yes | Whole minor units of the organization currency, e.g. cents. minimum: 0 |
additionalProperties: false; required: ["product_id","check_in_date","check_out_date","adults","guest_name","total_minor","idempotency_key"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
channel_push |
object or null (fields) | Yes | What the home's connected channel took from this change: null when no channel push is needed; pushed when delivery completed; pending, with the reason, while it waits out Channex's rate limit or an unconfirmed attempt it sends again. A refused channel update returns a committed error. |
stay |
object (fields) | Yes | additionalProperties: false; required: ["id","product_id","request_id","status","version","updated_at","check_in_date","check_out_date"] |
additionalProperties: false; required: ["stay","channel_push"]
Delete home room — delete_home_room
Delete a room or space group from a home. First call get_product for product.stay.photo_rooms and choose its exact room ID. Its photos become Additional photos; the home’s cover, gallery and library files remain. Returns the removed ID and current photo memberships. Changes only KrabiClaw; it does not update Airbnb. Delete an Airbnb room separately in Airbnb.
Minimum role: admin. Required entitlement: None.
Annotations: title: Delete home room, readOnlyHint: false, openWorldHint: true, destructiveHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
product_id |
string | Yes | The place to stay: a product of kind stay, from list_products. minLength: 1 |
room_id |
string | Yes | Room ID from get_product → product.stay.photo_rooms. minLength: 1 |
additionalProperties: false; required: ["product_id","room_id"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
deleted_room_id |
string | Yes | minLength: 1 |
photo_memberships |
array of object (fields) | Yes | Every photo retained on this home in Product photo order, with its current room assignment. Null means Additional photos. |
product_id |
string | Yes | minLength: 1 |
additionalProperties: false; required: ["product_id","deleted_room_id","photo_memberships"]
Delete stay payment — delete_stay_payment
Remove one offline payment record entered by mistake. First call get_stay for its payment ID. Returns the removed payment ID and current paid amount/status. Does not refund or move money, and cannot remove the guest’s Stripe payment.
Minimum role: admin. Required entitlement: None.
Annotations: title: Delete stay payment, readOnlyHint: false, openWorldHint: false, destructiveHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
payment_id |
string | Yes | ID from get_stay → stay.payments[].id, or record_stay_payment → payment.id. Removes an offline record, not a Stripe payment or actual money. minLength: 1 |
stay_id |
string | Yes | Stay ID from list_stays. minLength: 1 |
additionalProperties: false; required: ["stay_id","payment_id"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
currency |
string | Yes | minLength: 1 |
deleted_payment_id |
string | Yes | minLength: 1 |
paid_minor |
integer | Yes | |
payment_status |
string or null | Yes | enum: ["unpaid","partial","paid","overpaid",null] |
stay_id |
string | Yes | minLength: 1 |
additionalProperties: false; required: ["stay_id","currency","paid_minor","payment_status","deleted_payment_id"]
Get stay — get_stay
Read one stay with its guest details and, for a stay the host took, the payments recorded against it. A member reads a stay at a home they look after as its dates, arrival time, guest first name and party only.
Minimum role: member. Required entitlement: None.
Annotations: title: Get stay, readOnlyHint: true, idempotentHint: true, openWorldHint: false, destructiveHint: false.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
stay_id |
string | Yes | Stay ID from list_stays. minLength: 1 |
additionalProperties: false; required: ["stay_id"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
stay |
object (fields) | Yes |
required: ["stay"]
Get stay calendar — get_stay_calendar
Read every night of a date range at one home: availability, nightly price, booking restrictions and the stays holding those nights. Returns scheduling details; members read each stay as its dates, arrival time, guest first name and party. Owners and admins use get_stay for one booking’s contact and payment details, or get_product for the home’s photos and room groups.
Minimum role: member. Required entitlement: None.
Annotations: title: Get stay calendar, readOnlyHint: true, idempotentHint: true, openWorldHint: false, destructiveHint: false.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
from |
string | Yes | pattern: "^\d{4}-\d{2}-\d{2}$" |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
product_id |
string | Yes | The place to stay: a product of kind stay, from list_products. minLength: 1 |
to |
string | Yes | Exclusive; at most 500 days after from. pattern: "^\d{4}-\d{2}-\d{2}$" |
additionalProperties: false; required: ["product_id","from","to"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
channel_push |
object or null (fields) | No | What the home's connected channel took from this change: null when no channel push is needed; pushed when delivery completed; pending, with the reason, while it waits out Channex's rate limit or an unconfirmed attempt it sends again. A refused channel update returns a committed error. |
home |
object (fields) | Yes | additionalProperties: false; required: ["product_id","name","location_id","timezone","currency","base_price_minor","base_price_tax_behavior","check_in_time","check_in_end_time","check_out_time","max_guests","min_nights","calendar_rules","channel"] |
nights |
array of object (fields) | Yes | |
stays |
array of object (fields) | Yes |
required: ["home","nights","stays"]
List stays — list_stays
Read guests staying at the organization’s homes overlapping a date range, with dates, party, channel and status. Members see only the homes they look after, and only each stay’s dates, arrival time, guest first name and party. Owners and admins use get_stay for one stay’s contact, notes and payment details.
Minimum role: member. Required entitlement: None.
Annotations: title: List stays, readOnlyHint: true, idempotentHint: true, openWorldHint: false, destructiveHint: false.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
from |
string | Yes | pattern: "^\d{4}-\d{2}-\d{2}$" |
include_cancelled |
boolean | No | |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
product_id |
string | No | The place to stay: a product of kind stay, from list_products. minLength: 1 |
to |
string | Yes | Exclusive; at most 400 days after from. pattern: "^\d{4}-\d{2}-\d{2}$" |
additionalProperties: false; required: ["from","to"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
stays |
array of object (fields) | Yes |
required: ["stays"]
Record stay payment — record_stay_payment
Record money received outside KrabiClaw for a host-entered stay, such as cash or a bank transfer. Read get_stay for the stay ID and currency. A negative amount records an offline refund. Returns the exact recorded payment and current paid amount/status, without unrelated guest details or payment history. Moves no money.
Minimum role: admin. Required entitlement: None.
Annotations: title: Record stay payment, readOnlyHint: false, openWorldHint: false, destructiveHint: false, idempotentHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
amount_minor |
integer | Yes | Whole minor units of the stay’s currency from get_stay; negative records an offline refund, never zero. not: {"const":0} |
idempotency_key |
string | Yes | Reuse only for the identical amount, method, date, reference and note on this stay. Returns the exact recorded payment without a second entry. maxLength: 200; minLength: 1 |
method |
string | Yes | enum: ["cash","bank_transfer","card_external","other"] |
note |
string | No | maxLength: 1000 |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
paid_on |
string | Yes | pattern: "^\d{4}-\d{2}-\d{2}$" |
reference |
string | No | maxLength: 200 |
stay_id |
string | Yes | Stay ID from list_stays. minLength: 1 |
additionalProperties: false; required: ["stay_id","amount_minor","method","paid_on","idempotency_key"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
currency |
string | Yes | minLength: 1 |
paid_minor |
integer | Yes | |
payment |
object (fields) | Yes | additionalProperties: false; required: ["id","stay_id","amount_minor","currency","method","paid_on","reference","note","created_at"] |
payment_status |
string or null | Yes | enum: ["unpaid","partial","paid","overpaid",null] |
stay_id |
string | Yes | minLength: 1 |
additionalProperties: false; required: ["stay_id","currency","paid_minor","payment_status","payment"]
Set stay nights — set_stay_nights
Close or open nights, set a nightly price, or set stay rules for a date range at one place to stay. Fields left out keep each night’s value; weekdays narrows the range to nights on those weekdays; price_change_percent moves each chosen night’s own current price by a whole percent instead of setting one, and compounds if sent again; price_minor null inherits the weekend price on Friday/Saturday when configured, otherwise the base price; reset removes the range’s overrides. Updates the website’s bookable nights and, when connected, pushes prices, availability and stay rules to the home’s Airbnb listing through Channex. Returns channel_push on success. A failed channel update raises CHANNEL_PUSH_FAILED with committed:true; read the calendar before retrying.
Minimum role: admin. Required entitlement: None.
Annotations: title: Set stay nights, readOnlyHint: false, openWorldHint: true, destructiveHint: true, idempotentHint: false.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
closed |
boolean | No | |
closed_to_arrival |
boolean | No | |
closed_to_departure |
boolean | No | |
from |
string | Yes | pattern: "^\d{4}-\d{2}-\d{2}$" |
max_stay |
integer or null | No | minimum: 1 |
min_stay_arrival |
integer or null | No | minimum: 1 |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
price_change_percent |
integer | No | Moves each chosen night’s own current price by this percent, rounded to the minor unit. Not with price_minor or reset; 0 is refused. maximum: 50; minimum: -50; not: {"const":0} |
price_minor |
integer or null | No | minimum: 0 |
product_id |
string | Yes | The place to stay: a product of kind stay, from list_products. minLength: 1 |
reset |
boolean | No | True removes all nightly overrides in the range and cannot be combined with night settings. False or omitted requires at least one night setting. |
to |
string | Yes | Exclusive; at most 500 days after from. pattern: "^\d{4}-\d{2}-\d{2}$" |
weekdays |
array of integer (fields) | No | Only nights on these weekdays, 0 Sunday to 6 Saturday. Omitted means every night in the range. maxItems: 7; minItems: 1; uniqueItems: true |
additionalProperties: false; required: ["product_id","from","to"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
channel_push |
object or null (fields) | No | What the home's connected channel took from this change: null when no channel push is needed; pushed when delivery completed; pending, with the reason, while it waits out Channex's rate limit or an unconfirmed attempt it sends again. A refused channel update returns a committed error. |
home |
object (fields) | Yes | additionalProperties: false; required: ["product_id","name","location_id","timezone","currency","base_price_minor","base_price_tax_behavior","check_in_time","check_in_end_time","check_out_time","max_guests","min_nights","calendar_rules","channel"] |
nights |
array of object (fields) | Yes | |
stays |
array of object (fields) | Yes |
required: ["home","nights","stays"]
Update home accessibility — update_home_accessibility
Change one home accessibility answer. First call get_product for product.updated_at and product.stay.accessibility. True requires evidence images in this organization; saving appends selected library images to this home’s Product photos without changing the cover, existing order or room assignments. False/null requires []; null clears the answer. Evidence photos remain protected until the answer is cleared or the evidence replaced. A stale Product revision or photo order refuses the entire change. Changes only KrabiClaw; it does not update Airbnb. Edit Airbnb accessibility separately in Airbnb.
Minimum role: admin. Required entitlement: None.
Annotations: title: Update home accessibility, readOnlyHint: false, openWorldHint: true, destructiveHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
accessibility |
object (fields) | Yes | additionalProperties: false; required: ["feature","available","photo_ids"] |
expected_updated_at |
string | Yes | product.updated_at from the latest get_product call. A stale value refuses the entire change. minLength: 1 |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
product_id |
string | Yes | The place to stay: a product of kind stay, from list_products. minLength: 1 |
additionalProperties: false; required: ["product_id","expected_updated_at","accessibility"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
accessibility |
array of object (fields) | Yes | All six home accessibility features in catalog order, including unanswered null rows. maxItems: 6; minItems: 6 |
product_id |
string | Yes | minLength: 1 |
product_updated_at |
string | Yes | minLength: 1 |
additionalProperties: false; required: ["product_id","product_updated_at","accessibility"]
Update home room — update_home_room
Change a room’s beds, bedroom bathroom privacy, amenity assignments or one bedroom accessibility answer. First call get_product for product.stay.photo_rooms and the selected room’s details_version. Omitted fields remain unchanged. Bed allocations must fit the home’s declared total; assigning an amenity also adds it to the home’s amenity set, while unassigning only removes its room membership. Accessibility evidence may append library images to the home’s gallery. A stale room revision or invalid combination refuses the entire change. Returns the saved room details. Changes only KrabiClaw; it does not update Airbnb. Edit Airbnb room details separately in Airbnb.
Minimum role: admin. Required entitlement: None.
Annotations: title: Update home room, readOnlyHint: false, openWorldHint: true, destructiveHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
accessibility |
object (fields) | No | additionalProperties: false; required: ["feature","available","photo_ids"] |
amenities |
array of string (fields) | No | Replaces this room’s amenity memberships; [] unassigns all. Selected codes also join the home’s amenity set. Unassigning does not remove a home amenity. uniqueItems: true |
expected_details_version |
integer | Yes | details_version of this room from get_product → product.stay.photo_rooms. A stale value refuses the entire edit. minimum: 1 |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
private_attached_bathroom |
boolean or null | No | Whether this bedroom has a private attached bathroom. Null is unanswered. Only bedrooms may author this fact. |
product_id |
string | Yes | The place to stay: a product of kind stay, from list_products. minLength: 1 |
room_id |
string | Yes | Room ID from get_product → product.stay.photo_rooms. minLength: 1 |
sleeping_arrangements |
array or null (fields) | No | Room allocations from the declared listing bed total. Null is unanswered; [] explicitly states none. Each bed type occurs once; all room quantities together must fit within a known listing beds total. maxItems: 14 |
additionalProperties: false; required: ["product_id","room_id","expected_details_version"]
anyOf: shape 1, shape 2, shape 3, shape 4.
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
product_id |
string | Yes | minLength: 1 |
product_updated_at |
string | Yes | minLength: 1 |
room |
object (fields) | Yes | additionalProperties: false; required: ["id","type","photo_ids","details_version","sleeping_arrangements","private_attached_bathroom","amenities","accessibility"] |
additionalProperties: false; required: ["product_id","product_updated_at","room"]
Update stay — update_stay
Change a host-entered stay’s dates, party, guest details, total or notes using stay.version from get_stay. Supply at least one changed field; empty and unchanged edits are refused. Omitted fields keep their values. Returns a compact stay receipt and the saved values of supplied fields. Replans pending automatic guest messages and updates connected Airbnb availability through Channex. A failed channel update reports the committed edit; read get_stay before retrying. Channel-owned stays must be edited on their channel.
Minimum role: admin. Required entitlement: None.
Annotations: title: Update stay, readOnlyHint: false, openWorldHint: true, destructiveHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
adults |
integer | No | maximum: 99; minimum: 1 |
arrival_time |
string or null | No | pattern: "^([01]\d|2[0-3]):[0-5]\d$" |
check_in_date |
string | No | pattern: "^\d{4}-\d{2}-\d{2}$" |
check_out_date |
string | No | The morning the guest leaves; the stay holds the nights before it. pattern: "^\d{4}-\d{2}-\d{2}$" |
children |
integer | No | maximum: 99; minimum: 0 |
expected_version |
integer | Yes | stay.version from the latest get_stay call; a stale version is refused. minimum: 1 |
guest_email |
string or null | No | |
guest_name |
string | No | maxLength: 200; minLength: 1 |
guest_phone |
string or null | No | International number with its country calling code, e.g. +66812345678. |
guest_surname |
string or null | No | maxLength: 200 |
infants |
integer | No | maximum: 99; minimum: 0 |
notes |
string or null | No | maxLength: 2000 |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
stay_id |
string | Yes | Stay ID from list_stays. minLength: 1 |
total_minor |
integer | No | Whole minor units of the organization currency, e.g. cents. minimum: 0 |
additionalProperties: false; required: ["stay_id","expected_version"]
anyOf: shape 1, shape 2, shape 3, shape 4, shape 5, shape 6, shape 7, shape 8, shape 9, shape 10, shape 11, shape 12.
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
channel_push |
object or null (fields) | Yes | What the home's connected channel took from this change: null when no channel push is needed; pushed when delivery completed; pending, with the reason, while it waits out Channex's rate limit or an unconfirmed attempt it sends again. A refused channel update returns a committed error. |
saved_fields |
object (fields) | Yes | additionalProperties: false; minProperties: 1 |
stay |
object (fields) | Yes | additionalProperties: false; required: ["id","product_id","request_id","status","version","updated_at","check_in_date","check_out_date"] |
additionalProperties: false; required: ["stay","channel_push","saved_fields"]
Submissions
Create inquiry — create_inquiry
Record an inquiry, quote request or lead in the inbox for a named person, as the website's inquiry form does: their contact details, an optional message, and answers to the organization's inquiry questions (get_organization_settings → inquiry_questions). No appointment, capacity or payment is involved; to book a time use create_product_booking. Legal practices also require the person's consent acknowledgement. Reuse the same idempotency key for an identical retry; read the saved answers with get_guest_conversation.
Minimum role: admin. Required entitlement: None.
Annotations: title: Create inquiry, readOnlyHint: false, openWorldHint: true, destructiveHint: true, idempotentHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
answers |
array of object (fields) | No | Answers to the configured questions by question ID: text for short_text/long_text, a choice ID for single_choice, choice IDs for multiple_choice, true or false for yes_no. Required questions must be answered. maxItems: 20 |
consent |
boolean | No | Legal practices only: the person acknowledged the contact and privacy notice. |
email |
string | Yes | maxLength: 200; minLength: 3 |
idempotency_key |
string | Yes | maxLength: 200; minLength: 1 |
locale |
string | No | The language the person wrote in; defaults to the website language. Answers are matched to the questions as worded in it. |
location_id |
string | No | Optional location the inquiry is about. |
message |
string | No | What they wrote. Required (10+ characters) when the organization has no inquiry questions; optional otherwise. maxLength: 2000 |
name |
string | Yes | maxLength: 100; minLength: 1 |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
phone |
string | No | Optional. International number with its country calling code, e.g. +66812345678. |
questions_revision |
string | No | inquiry_questions_revision the answers were collected against; required with answers. |
source |
string | Yes | Where the inquiry came from, such as phone call or event. maxLength: 100; minLength: 1 |
additionalProperties: false; required: ["name","email","source","idempotency_key"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
answers |
array of object (fields) | Yes | Answers to the tenant's own questions, with the wording the guest answered. Later edits to the questions do not change them. |
replayed |
boolean | Yes | |
request_id |
string | Yes | |
success |
boolean | Yes | const: true |
required: ["success","request_id","replayed","answers"]
Get guest conversation — get_guest_conversation
Read the entire guest conversation, including the guest's answers to the tenant's questions, messages, booking/reservation, proposals, attachments and delivery receipts. Requires request_id from the inbox or booking read.
Minimum role: member. Required entitlement: None.
Annotations: title: Get guest conversation, readOnlyHint: true, idempotentHint: true, openWorldHint: false, destructiveHint: false.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
request_id |
string | Yes |
additionalProperties: false; required: ["request_id"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
conversation |
object (fields) | Yes | required: ["request_id","type","state","archived","updated_at","participant_label","reply_channel","guest","answers","operational_record","entries"] |
required: ["conversation"]
List guest conversations — list_guest_conversations
Read the business inbox for contacts, table reservations, bookings and stay conversations. Filter by type, current/past and whether a reply is needed. Follow page_info; use request_id to read the whole conversation.
Minimum role: member. Required entitlement: None.
Annotations: title: List guest conversations, readOnlyHint: true, idempotentHint: true, openWorldHint: false, destructiveHint: false.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
cursor |
string | No | Opaque next_cursor from the previous page. |
limit |
number | No | Page size. Defaults to 50; maximum 100. maximum: 100; minimum: 1 |
location_id |
string | No | |
mailbox |
string | No | enum: ["current","past"] |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
state |
string | No | enum: ["needs_attention","waiting_on_guest","resolved"] |
type |
string | No | enum: ["contact","reservation","booking","stay"] |
additionalProperties: false; required: []
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
conversations |
array of object (fields) | Yes | |
page_info |
object (fields) | Yes | required: ["has_more","next_cursor"] |
required: ["conversations","page_info"]
List table reservations — list_table_reservations
Read table reservations for the selected site, optionally filtered by location and creation window of up to 90 days. Returns guest contact details, reservation details and status counts. Use list_product_bookings to read product session bookings and consultations.
Minimum role: admin. Required entitlement: None.
Annotations: title: List table reservations, readOnlyHint: true, idempotentHint: true, openWorldHint: false, destructiveHint: false.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
cursor |
string | No | Opaque next_cursor from the previous page. |
days |
number | No | Optional: only include reservations made in the last N days (max 90). |
limit |
number | No | Page size. Defaults to 50; maximum 100. maximum: 100; minimum: 1 |
location_id |
string | No | Optional location id to list only that location's reservations. |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
additionalProperties: false; required: []
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
page_info |
object (fields) | Yes | required: ["has_more","next_cursor"] |
submissions |
array of object (fields) | Yes | |
summary |
object (fields) | Yes | required: ["total","by_status"] |
required: ["submissions","summary","page_info"]
Reply to guest — reply_to_guest
Reply through this conversation’s reply_channel and save the reply. Airbnb replies accept text or one photo, sent separately; email replies accept text, a photo or both. A stay guest without an email is reached in their KrabiClaw inbox once they accept the host’s invite link; until then the reply is refused with GUEST_INVITE_REQUIRED and the host shares an invite from the KrabiClaw app. Reuse the same key for an identical retry. A failed Airbnb attempt may retry only when retry_with_same_idempotency_key is true. Sending, uncertain or review-required attempts need review and are never blindly resent. Returns saved conversation state; use get_guest_conversation for history and delivery receipts.
Minimum role: member. Required entitlement: None.
Annotations: title: Reply to guest, readOnlyHint: false, openWorldHint: true, destructiveHint: true, idempotentHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
file |
object (fields) | No | Photo attachment; required when no reply text is supplied. required: ["download_url","file_id"] |
idempotency_key |
string | Yes | maxLength: 200; minLength: 1 |
message |
string | No | Reply text; required when no photo is attached. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
request_id |
string | Yes | Conversation request_id from list_guest_conversations or a booking read. |
additionalProperties: false; required: ["request_id","idempotency_key"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
conversation |
object (fields) | Yes | additionalProperties: false; required: ["request_id","state","archived","updated_at"] |
outcome |
object (fields) | Yes | required: ["ok"] |
additionalProperties: false; required: ["outcome","conversation"]
File parameters: file.
Set guest conversation archived — set_guest_conversation_archived
Archive or restore the inbox conversation identified by request_id from list_guest_conversations or a booking read. Returns its saved archive state without conversation history. Does not cancel a booking or reservation and does not send the guest a message.
Minimum role: admin. Required entitlement: None.
Annotations: title: Set guest conversation archived, readOnlyHint: false, openWorldHint: false, destructiveHint: true, idempotentHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
archived |
boolean | Yes | |
idempotency_key |
string | Yes | maxLength: 200; minLength: 1 |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
request_id |
string | Yes | Conversation request_id from list_guest_conversations or a booking read. |
additionalProperties: false; required: ["request_id","archived","idempotency_key"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
conversation |
object (fields) | Yes | additionalProperties: false; required: ["request_id","state","archived","updated_at"] |
outcome |
object (fields) | Yes | required: ["ok"] |
additionalProperties: false; required: ["outcome","conversation"]
Team messaging
Get team conversation — get_team_conversation
Read messages, photos and notification receipts from one of your internal conversations, newest first. Defaults to 20, maximum 100. When hasMore is true, page back with both before and before_id from the oldest loaded message’s createdAt and id. Reading does not mark the conversation read.
Minimum role: member. Required entitlement: None.
Annotations: title: Get team conversation, readOnlyHint: true, idempotentHint: true, openWorldHint: false, destructiveHint: false.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
before |
string | No | minLength: 1 |
before_id |
string | No | minLength: 1 |
limit |
integer | No | maximum: 100; minimum: 1 |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
thread_id |
string | Yes | Team conversation ID from list_team_conversations or start_team_conversation; never a guest request or Better Auth Team ID. minLength: 1 |
additionalProperties: false; required: ["thread_id"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
hasMore |
boolean | Yes | |
messages |
array of object (fields) | Yes |
required: ["messages","hasMore"]
List team conversation recipients — list_team_conversation_recipients
Read the current organization members available for internal conversations. Select actual user IDs from these results; current_user_id identifies you. This is not Better Auth Team/group management and does not include guests.
Minimum role: member. Required entitlement: None.
Annotations: title: List team conversation recipients, readOnlyHint: true, idempotentHint: true, openWorldHint: false, destructiveHint: false.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
additionalProperties: false; required: []
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
current_user_id |
string | Yes | |
members |
array of object (fields) | Yes |
required: ["current_user_id","members"]
List team conversations — list_team_conversations
Read only your internal team conversations, newest activity first. Optional stay_id or location_id filters narrow their explicit context. Follow page_info; guest conversations use list_guest_conversations instead.
Minimum role: member. Required entitlement: None.
Annotations: title: List team conversations, readOnlyHint: true, idempotentHint: true, openWorldHint: false, destructiveHint: false.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
cursor |
string | No | Opaque next_cursor from the previous page. |
limit |
number | No | Page size. Defaults to 50; maximum 100. maximum: 100; minimum: 1 |
location_id |
string | No | minLength: 1 |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
stay_id |
string | No | minLength: 1 |
additionalProperties: false; required: []
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
conversations |
array of object (fields) | Yes | |
page_info |
object (fields) | Yes | required: ["has_more","next_cursor"] |
required: ["conversations","page_info"]
Mark team conversation read — mark_team_conversation_read
Mark one of your internal conversations read through now. Changes only your own read position; does not send a message or change another participant’s unread state.
Minimum role: member. Required entitlement: None.
Annotations: title: Mark team conversation read, readOnlyHint: false, openWorldHint: false, destructiveHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
thread_id |
string | Yes | Team conversation ID from list_team_conversations or start_team_conversation; never a guest request or Better Auth Team ID. minLength: 1 |
additionalProperties: false; required: ["thread_id"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
lastReadAt |
string | Yes | |
status |
string | Yes | const: "read" |
required: ["status","lastReadAt"]
Send team message — send_team_message
Send the text and/or supplied photo to an internal team conversation you belong to. Sends as the authenticated member and records notification outcomes; a saved message does not prove delivery to a participant. Reuse the same idempotency_key for an identical retry; a failed realtime publication may report committed:true and must retry that same request. This never replies to a guest.
Minimum role: member. Required entitlement: None.
Annotations: title: Send team message, readOnlyHint: false, openWorldHint: true, destructiveHint: true, idempotentHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
file |
object (fields) | No | Optional photo supplied as a ChatGPT file attachment. required: ["download_url","file_id"] |
idempotency_key |
string | Yes | maxLength: 200; minLength: 1 |
message |
string | No | maxLength: 5000; minLength: 1 |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
thread_id |
string | Yes | Team conversation ID from list_team_conversations or start_team_conversation; never a guest request or Better Auth Team ID. minLength: 1 |
additionalProperties: false; required: ["thread_id","idempotency_key"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
created |
boolean | Yes | |
message |
object (fields) | Yes | required: ["id","threadId","senderId","body","createdAt","attachments","deliveries"] |
required: ["message","created"]
File parameters: file.
Start team conversation — start_team_conversation
Start an internal conversation with explicitly selected workspace members. Direct and stay/location conversations reuse the same participants/context. A manual conversation with at least three people is a distinct group, can have a name, and requires a stable idempotency_key; reuse that key only for an identical retry. Maximum 50 people including you. This does not send a message, invite anyone or create a Better Auth Team. Choose actual users from list_team_conversation_recipients.
Minimum role: member. Required entitlement: None.
Annotations: title: Start team conversation, readOnlyHint: false, openWorldHint: false, destructiveHint: false, idempotentHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
idempotency_key |
string | No | Required for a manually created group. Keep the same key for an identical retry. maxLength: 200; minLength: 1 |
location_id |
string | No | Optional explicit location context you may read. minLength: 1 |
member_user_ids |
array of string (fields) | Yes | maxItems: 49; minItems: 1; uniqueItems: true |
name |
string | No | Optional name for a manually created group of at least three people; unavailable for direct or stay/location conversations. maxLength: 100; minLength: 1 |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
stay_id |
string | No | Optional canonical stay ID you may read; never a guest request ID. minLength: 1 |
additionalProperties: false; required: ["member_user_ids"]
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
created |
boolean | Yes | |
id |
string | Yes |
required: ["id","created"]
Update team group — update_team_group
Rename, add people to, remove someone from, or leave a manually created internal group. The creator and participating workspace owners/admins can manage it; any participant can leave. Read canManage/canLeave from list_team_conversations. Direct chats, guest/buyer conversations and stay/location conversations are protected. No action deletes the conversation or its messages. New members can read its history; removed members lose access. Select actual member user IDs, never Better Auth Team IDs. Use a stable idempotency_key and retry exactly the same action if committed:true is returned.
Minimum role: member. Required entitlement: None.
Annotations: title: Update team group, readOnlyHint: false, openWorldHint: false, destructiveHint: true, idempotentHint: true.
Authentication: oauth2, scopes tenant.
Input
| Field | Type | Required | Description and constraints |
|---|---|---|---|
action |
string | Yes | enum: ["rename","add","remove","leave"] |
idempotency_key |
string | Yes | maxLength: 200; minLength: 1 |
member_user_ids |
array of string (fields) | No | Add only: current workspace users to add. maxItems: 49; minItems: 1; uniqueItems: true |
name |
string or null | No | Rename only: a name, or null to clear it. maxLength: 100; minLength: 1 |
organization_id |
string | No | Internal organization ID from get_workspace_context or list_organizations. If omitted, uses the accessible organization saved by set_workspace_context, or the only accessible organization when no saved selection applies. Otherwise the call fails and requires a selection. Read get_workspace_context before relying on the default. A URL, domain, slug or business name is not an ID. minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
thread_id |
string | Yes | Team conversation ID from list_team_conversations or start_team_conversation; never a guest request or Better Auth Team ID. minLength: 1 |
user_id |
string | No | Remove only: the participant to remove. Use leave to remove yourself. minLength: 1 |
additionalProperties: false; required: ["thread_id","action","idempotency_key"]
oneOf: shape 1, shape 2, shape 3, shape 4.
Output
| Field | Type | Required | Description and constraints |
|---|---|---|---|
status |
string | Yes | enum: ["updated","left"] |
threadId |
string | Yes |
required: ["status","threadId"]
Shared field shapes
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
clicks |
integer | Yes | maximum: 9007199254740991; minimum: 0 |
conversions |
integer | Yes | maximum: 9007199254740991; minimum: 0 |
costPerClickMicros |
integer | Yes | maximum: 9007199254740991; minimum: 0 |
error |
string or null | No | |
impressions |
integer | Yes | maximum: 9007199254740991; minimum: 0 |
totalSpendMicros |
integer | Yes | maximum: 9007199254740991; minimum: 0 |
additionalProperties: false; required: ["totalSpendMicros","clicks","impressions","conversions","costPerClickMicros"]
array of object fields
Value: array of object.
Array items: object.
array of object fields
Value: array of object.
Array items: object.
array of object fields
Value: array of object.
Array items: object.
array of object fields
Value: array of object.
Array items: object.
array of object fields
Value: array of object.
Array items: object.
array of object fields
Value: array of object.
Array items: object.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
ga4Delivery |
array of object (fields) | Yes | |
measurementContractStartedAt |
string or null | Yes | |
outcomeEventsWithoutAttribution |
integer | Yes | maximum: 9007199254740991; minimum: 0 |
additionalProperties: false; required: ["measurementContractStartedAt","outcomeEventsWithoutAttribution","ga4Delivery"]
array of object fields
Value: array of object.
Array items: object.
array of object fields
Value: array of object.
Array items: object.
array of object fields
Value: array of object.
Array items: object.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
byLocation |
array of object (fields) | Yes | |
bySource |
array of object (fields) | Yes | |
confirmed |
integer | Yes | maximum: 9007199254740991; minimum: 0 |
intent |
integer | Yes | maximum: 9007199254740991; minimum: 0 |
paid |
integer | Yes | maximum: 9007199254740991; minimum: 0 |
paidCollected |
array of object (fields) | Yes | |
submitted |
integer | Yes | maximum: 9007199254740991; minimum: 0 |
viewed |
integer | Yes | maximum: 9007199254740991; minimum: 0 |
visits |
integer | Yes | maximum: 9007199254740991; minimum: 0 |
additionalProperties: false; required: ["visits","viewed","intent","submitted","confirmed","paid","paidCollected","bySource","byLocation"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
avgSessionDuration |
number | Yes | minimum: 0 |
changePercent |
number or null | Yes | |
pageViews |
integer | Yes | maximum: 9007199254740991; minimum: 0 |
pagesPerSession |
number | Yes | minimum: 0 |
returningVisitors |
integer | Yes | maximum: 9007199254740991; minimum: 0 |
uniqueSessions |
integer | Yes | maximum: 9007199254740991; minimum: 0 |
uniqueVisitors |
integer | Yes | maximum: 9007199254740991; minimum: 0 |
additionalProperties: false; required: ["pageViews","uniqueSessions","uniqueVisitors","returningVisitors","avgSessionDuration","pagesPerSession","changePercent"]
array of object fields
Value: array of object.
Array items: object.
array of object fields
Value: array of object.
Array items: object.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
analyticsDataStartAt |
string or null | Yes | |
endDate |
string | Yes | |
nativeCoverage |
string | Yes | enum: ["full","partial"] |
startDate |
string | Yes | |
timezone |
string | Yes |
additionalProperties: false; required: ["startDate","endDate","timezone","analyticsDataStartAt","nativeCoverage"]
array of object fields
Value: array of object.
Array items: object.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
bySignupAttribution |
array of object (fields) | Yes | |
firstPaidBusinesses |
integer | Yes | maximum: 9007199254740991; minimum: 0 |
firstPaidSignups |
integer | Yes | maximum: 9007199254740991; minimum: 0 |
observedThrough |
string | Yes | |
onboardedBusinesses |
integer | Yes | maximum: 9007199254740991; minimum: 0 |
onboardedSignups |
integer | Yes | maximum: 9007199254740991; minimum: 0 |
signups |
integer | Yes | maximum: 9007199254740991; minimum: 0 |
additionalProperties: false; required: ["observedThrough","signups","onboardedSignups","firstPaidSignups","bySignupAttribution","onboardedBusinesses","firstPaidBusinesses"]
array of object fields
Value: array of object.
Array items: object.
array of object fields
Value: array of object.
Array items: object.
array of object fields
Value: array of object.
maxItems: 4; minItems: 1
Array items: object.
array of string fields
Value: array of string.
maxItems: 9
Array items: string.
array of object fields
Value: array of object.
maxItems: 10
Array items: object.
array of string fields
Value: array of string.
maxItems: 10; minItems: 1
Array items: string.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
desc |
boolean | No | Default true. |
field |
string | Yes | pattern: "^[A-Za-z0-9_:]+$" |
kind |
string | Yes | enum: ["metric","dimension"] |
additionalProperties: false; required: ["field","kind"]
array of object fields
Value: array of object.
Array items: object.
array of string fields
Value: array of string.
Array items: string.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
actor_id |
string | No | the staff member, agent or user who acted, when not the subject |
attribution_basis |
string | No | how the event snapshot arose: own_touch, inherited, session_current, checkout or none |
campaign |
string | No | campaign on the requested attribution_basis (observed: as the event carried it; event_snapshot: the attribution in force for the event when it happened; session_last_touch: the session's current last touch) |
campaign_prefix |
string | No | Literal, case-sensitive campaign prefix under the selected attribution basis; % and _ are ordinary characters. |
city |
string | No | city |
content |
string | No | content on the requested attribution_basis (observed: as the event carried it; event_snapshot: the attribution in force for the event when it happened; session_last_touch: the session's current last touch) |
conversion_type |
string | No | contact, reservation, booking or subscription |
country |
string | No | ISO country code |
currency |
string | No | currency of a monetary outcome |
device |
string | No | device class derived from the user agent |
dimension |
string | No | daily_summaries with dimension_day: the dimension to read. enum: ["country","city","device","referrer"] |
entity_id |
string | No | the business subject of an outcome or interaction |
entity_type |
string | No | the business subject type of an outcome or interaction |
event_name |
string | No | pageview, or the catalog event name |
fbclid |
string | No | fbclid on the requested attribution_basis (observed: as the event carried it; event_snapshot: the attribution in force for the event when it happened; session_last_touch: the session's current last touch) |
ga4_delivery_status |
string | No | the outcome of the optional GA4 delivery |
gbraid |
string | No | gbraid on the requested attribution_basis (observed: as the event carried it; event_snapshot: the attribution in force for the event when it happened; session_last_touch: the session's current last touch) |
gclid |
string | No | gclid on the requested attribution_basis (observed: as the event carried it; event_snapshot: the attribution in force for the event when it happened; session_last_touch: the session's current last touch) |
kind |
string | No | pageview, conversion (a business outcome) or interaction |
locale |
string | No | the language of the visit |
location_id |
string | No | the business location |
medium |
string | No | medium on the requested attribution_basis (observed: as the event carried it; event_snapshot: the attribution in force for the event when it happened; session_last_touch: the session's current last touch) |
member_id |
string | No | the team member a paid booking or booking decision is with |
msclkid |
string | No | msclkid on the requested attribution_basis (observed: as the event carried it; event_snapshot: the attribution in force for the event when it happened; session_last_touch: the session's current last touch) |
outcome_event |
string | No | The outcome measured by converting_sessions and session_conversion_rate (sign_up, contact_submit, booking_submit, purchase, ...) |
page_id |
string | No | the canonical page document |
page_path |
string | No | the public path exactly as visited (localized visits keep their prefix) |
page_type |
string | No | the page type |
path_prefix |
string | No | A public path prefix such as /th/ or /locations/main |
product_id |
string | No | the product the event is about |
referrer_host |
string | No | referrer_host on the requested attribution_basis (observed: as the event carried it; event_snapshot: the attribution in force for the event when it happened; session_last_touch: the session's current last touch) |
region |
string | No | region |
session_id |
string | No | the native session; null for a server outcome with no browser |
source |
string | No | source on the requested attribution_basis (observed: as the event carried it; event_snapshot: the attribution in force for the event when it happened; session_last_touch: the session's current last touch) |
source_path |
string | No | the locale-bare path documents are stored under |
stage |
string | No | outcome or interaction stage |
summary_kind |
string | No | daily_summaries only (required): the summary grain: one row per day, per day and public page path, or per day and country/city/device/referrer value. enum: ["organization_day","page_day","dimension_day"] |
surface |
string | No | the surface that produced the event |
tenant_organization_id |
string | No | on the platform organization: the business a Payments volume or fee invoice belongs to |
term |
string | No | term on the requested attribution_basis (observed: as the event carried it; event_snapshot: the attribution in force for the event when it happened; session_last_touch: the session's current last touch) |
value |
string | No | daily_summaries with dimension_day: one value of the dimension. |
value_basis |
string | No | quoted, purchase or refund |
variant_id |
string | No | the product variant the event is about |
visitor_id |
string | No | the native visitor; null for a server outcome with no browser |
wbraid |
string | No | wbraid on the requested attribution_basis (observed: as the event carried it; event_snapshot: the attribution in force for the event when it happened; session_last_touch: the session's current last touch) |
additionalProperties: false
array of string fields
Value: array of string.
Array items: string.
string or object fields
Value: string or object.
array of object fields
Value: array of object.
Array items: object.
array of string fields
Value: array of string.
maxItems: 4
Array items: string.
array of object fields
Value: array of object.
maxItems: 10
Array items: object.
array of object fields
Value: array of object.
Array items: object.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
article_count |
integer | Yes | Articles in the category itself, drafts included. |
child_count |
integer | Yes | Subcategories directly under it. |
collection |
string | Yes | enum: ["blog","docs"] |
description |
string or null | Yes | |
id |
string | Yes | |
name |
string | Yes | |
parent_id |
string or null | Yes | The category it sits under; null at the top level. |
slug |
string | Yes | The category page's address: /blog/category/{slug} or /docs/category/{slug}. It does not change when the category is renamed. |
sort_order |
integer | Yes | Its place among its siblings. |
additionalProperties: false; required: ["id","collection","name","slug","description","parent_id","sort_order","article_count","child_count"]
array of object fields
Value: array of object.
minItems: 1
Array items: object.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
admin_edit_url |
string or null | Yes | |
category |
object or null (fields) | Yes | additionalProperties: false; required: ["id","name","slug"] |
collection |
string | Yes | enum: ["blog","docs"] |
content_blocks |
array of object (fields) | Yes | |
cover |
object or null (fields) | Yes | additionalProperties: false; required: ["asset_id","public_url","thumbnail_url","kind","alt_text","width","height"] |
created_at |
string | Yes | |
edit_url |
string or null | Yes | |
excerpt |
string or null | Yes | |
id |
string | Yes | |
preview_url |
string or null | Yes | |
public_path |
string or null | Yes | |
public_url |
string or null | Yes | |
published |
boolean | Yes | |
published_at |
string or null | Yes | |
seo_keywords |
string or null | Yes | |
slug |
string | Yes | |
sort_order |
integer | Yes | |
status |
string | Yes | enum: ["draft","published"] |
title |
string | Yes | |
updated_at |
string | Yes | |
view_url |
string or null | Yes | |
visibility |
string | Yes | enum: ["listed","unlisted"] |
additionalProperties: false; required: ["id","title","slug","excerpt","collection","category","sort_order","seo_keywords","published","published_at","status","visibility","created_at","updated_at","cover","admin_edit_url","edit_url","public_path","public_url","preview_url","view_url","content_blocks"]
array of object fields
Value: array of object.
Array items: object.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
has_more |
boolean | Yes | |
next_cursor |
string or null | Yes |
required: ["has_more","next_cursor"]
array of object fields
Value: array of object.
Array items: object.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
collection |
string | Yes | enum: ["blog","docs"] |
id |
string | Yes | |
public_url |
string or null | Yes | |
published |
boolean | Yes | |
published_at |
string or null | Yes | |
status |
string | Yes | enum: ["draft","published"] |
title |
string | Yes | |
updated_at |
string | Yes | |
visibility |
string | Yes | enum: ["listed","unlisted"] |
additionalProperties: false; required: ["id","title","collection","visibility","status","published","published_at","updated_at","public_url"]
array of string fields
Value: array of string.
minItems: 1
Array items: string.
See schema fields
Value: See schema.
required: ["parent_id"]
See schema fields
Value: See schema.
required: ["name"]
See schema fields
Value: See schema.
required: ["description"]
array of object fields
Value: array of object.
minItems: 1
Array items: object.
See schema fields
Value: See schema.
required: ["title"]
See schema fields
Value: See schema.
required: ["excerpt"]
See schema fields
Value: See schema.
required: ["collection"]
See schema fields
Value: See schema.
required: ["category_id"]
See schema fields
Value: See schema.
required: ["content_blocks"]
See schema fields
Value: See schema.
required: ["visibility"]
See schema fields
Value: See schema.
if: {"required":["content_blocks"]}; then: {"required":["expected_updated_at"]}
array of string fields
Value: array of string.
Array items: string.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
assigned_member_id |
string or null | Yes | |
ends_at |
string | Yes | minLength: 1 |
id |
string | Yes | minLength: 1 |
kind |
string | Yes | enum: ["booking","reservation"] |
location_id |
string or null | Yes | |
party_size |
integer | Yes | minimum: 1 |
product_id |
string or null | Yes | |
product_name |
string or null | Yes | |
starts_at |
string | Yes | minLength: 1 |
status |
string | Yes | enum: ["pending","confirmed","cancelled"] |
timezone |
string | Yes | minLength: 1 |
required: ["id","kind","status","party_size","starts_at","ends_at","timezone","assigned_member_id","location_id","product_id","product_name"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
conversation_state |
string | Yes | minLength: 1 |
id |
string | Yes | minLength: 1 |
kind |
string | Yes | enum: ["booking","reservation"] |
required: ["id","kind","conversation_state"]
array of object fields
Value: array of object.
maxItems: 20
Array items: object.
array of object fields
Value: array of object.
minItems: 1
Array items: object.
array of object fields
Value: array of object.
maxItems: 20
Array items: object.
array of object fields
Value: array of object.
Array items: object.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
email |
string | Yes | minLength: 1 |
name |
string | Yes | minLength: 1 |
phone |
string or null | No |
required: ["name","email"]
object or null fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
external_reference |
string or null | Yes | |
guest_acknowledgement |
boolean | Yes | |
source |
string | Yes | minLength: 1 |
required: ["source","external_reference","guest_acknowledgement"]
array of object fields
Value: array of object.
Array items: object.
array of object fields
Value: array of object.
Array items: object.
See schema fields
Value: See schema.
required: ["starts_at"]
See schema fields
Value: See schema.
required: ["ends_at"]
See schema fields
Value: See schema.
required: ["capacity"]
See schema fields
Value: See schema.
required: ["status"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
assigned_member_id |
string or null | Yes | |
capacity |
integer or null | Yes | |
claimed |
integer | Yes | |
ends_at |
string | Yes | minLength: 1 |
id |
string | Yes | minLength: 1 |
is_full |
boolean | Yes | |
location_id |
string or null | Yes | |
organization_id |
string | Yes | minLength: 1 |
product_id |
string | Yes | minLength: 1 |
remaining |
integer or null | Yes | |
starts_at |
string | Yes | minLength: 1 |
status |
string | Yes | minLength: 1 |
timezone |
string | Yes | minLength: 1 |
updated_at |
string | Yes | minLength: 1 |
required: ["id","organization_id","product_id","location_id","assigned_member_id","starts_at","ends_at","timezone","capacity","status","claimed","remaining","is_full","updated_at"]
#/$defs/content_heading or #/$defs/content_markdown or #/$defs/content_image or #/$defs/content_gallery or #/$defs/content_video or #/$defs/content_faq or #/$defs/content_how_to or #/$defs/content_divider or #/$defs/content_cta or #/$defs/content_contact_cta or #/$defs/content_booking_cta or #/$defs/content_callout or #/$defs/content_hero or #/$defs/content_button_group or #/$defs/content_feature_grid or #/$defs/content_comparison or #/$defs/content_stat_grid or #/$defs/content_workflow_grid or #/$defs/content_showcase or #/$defs/content_language_reach or #/$defs/content_steps or #/$defs/content_video_feature or #/$defs/content_media_text or #/$defs/content_contact_form or #/$defs/content_team_grid or #/$defs/content_testimonial_grid or #/$defs/content_donation_choices or #/$defs/content_page_grid or #/$defs/content_product_grid or #/$defs/content_location_grid or #/$defs/content_social_posts or #/$defs/content_ai_assistance fields
Value: #/$defs/content_heading or #/$defs/content_markdown or #/$defs/content_image or #/$defs/content_gallery or #/$defs/content_video or #/$defs/content_faq or #/$defs/content_how_to or #/$defs/content_divider or #/$defs/content_cta or #/$defs/content_contact_cta or #/$defs/content_booking_cta or #/$defs/content_callout or #/$defs/content_hero or #/$defs/content_button_group or #/$defs/content_feature_grid or #/$defs/content_comparison or #/$defs/content_stat_grid or #/$defs/content_workflow_grid or #/$defs/content_showcase or #/$defs/content_language_reach or #/$defs/content_steps or #/$defs/content_video_feature or #/$defs/content_media_text or #/$defs/content_contact_form or #/$defs/content_team_grid or #/$defs/content_testimonial_grid or #/$defs/content_donation_choices or #/$defs/content_page_grid or #/$defs/content_product_grid or #/$defs/content_location_grid or #/$defs/content_social_posts or #/$defs/content_ai_assistance.
anyOf: shape 1, shape 2, shape 3, shape 4, shape 5, shape 6, shape 7, shape 8, shape 9, shape 10, shape 11, shape 12, shape 13, shape 14, shape 15, shape 16, shape 17, shape 18, shape 19, shape 20, shape 21, shape 22, shape 23, shape 24, shape 25, shape 26, shape 27, shape 28, shape 29, shape 30, shape 31, shape 32.
array of #/$defs/content_block_media fields
Value: array of #/$defs/content_block_media.
Array items: #/$defs/content_block_media.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
after_block_id |
string or null | No | The block this one follows. Omit to append at the end. |
data |
object (fields) | Yes | additionalProperties: false; required: ["text"] |
document_id |
string | Yes | The blog post id or site page variant id. |
level |
integer or null | No | Heading blocks only. maximum: 6; minimum: 1 |
media |
array of #/$defs/content_block_media (fields) | No | Required on image blocks: one item, the picture. Send a block's media as a read returned it. |
type |
string | Yes | const: "heading" |
required: ["document_id","type","data"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
after_block_id |
string or null | No | The block this one follows. Omit to append at the end. |
data |
object (fields) | Yes | additionalProperties: false; required: ["markdown","editor_mode"] |
document_id |
string | Yes | The blog post id or site page variant id. |
level |
integer or null | No | Heading blocks only. maximum: 6; minimum: 1 |
media |
array of #/$defs/content_block_media (fields) | No | Required on image blocks: one item, the picture. Send a block's media as a read returned it. |
type |
string | Yes | const: "markdown" |
required: ["document_id","type","data"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
after_block_id |
string or null | No | The block this one follows. Omit to append at the end. |
data |
object (fields) | Yes | additionalProperties: false; required: [] |
document_id |
string | Yes | The blog post id or site page variant id. |
level |
integer or null | No | Heading blocks only. maximum: 6; minimum: 1 |
media |
array of #/$defs/content_block_media (fields) | Yes | Required on image blocks: one item, the picture. Send a block's media as a read returned it. maxItems: 1; minItems: 1 |
type |
string | Yes | const: "image" |
required: ["document_id","type","data","media"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
after_block_id |
string or null | No | The block this one follows. Omit to append at the end. |
data |
object (fields) | Yes | additionalProperties: false; required: [] |
document_id |
string | Yes | The blog post id or site page variant id. |
level |
integer or null | No | Heading blocks only. maximum: 6; minimum: 1 |
media |
array of #/$defs/content_block_media (fields) | No | Required on image blocks: one item, the picture. Send a block's media as a read returned it. |
type |
string | Yes | const: "gallery" |
required: ["document_id","type","data"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
after_block_id |
string or null | No | The block this one follows. Omit to append at the end. |
data |
object (fields) | Yes | additionalProperties: false; required: ["url","title"] |
document_id |
string | Yes | The blog post id or site page variant id. |
level |
integer or null | No | Heading blocks only. maximum: 6; minimum: 1 |
media |
array of #/$defs/content_block_media (fields) | No | Required on image blocks: one item, the picture. Send a block's media as a read returned it. |
type |
string | Yes | const: "video" |
required: ["document_id","type","data"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
after_block_id |
string or null | No | The block this one follows. Omit to append at the end. |
data |
object (fields) | Yes | additionalProperties: false; required: ["source"] |
document_id |
string | Yes | The blog post id or site page variant id. |
level |
integer or null | No | Heading blocks only. maximum: 6; minimum: 1 |
media |
array of #/$defs/content_block_media (fields) | No | Required on image blocks: one item, the picture. Send a block's media as a read returned it. |
type |
string | Yes | const: "faq" |
required: ["document_id","type","data"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
after_block_id |
string or null | No | The block this one follows. Omit to append at the end. |
data |
object (fields) | Yes | additionalProperties: false; required: ["steps"] |
document_id |
string | Yes | The blog post id or site page variant id. |
level |
integer or null | No | Heading blocks only. maximum: 6; minimum: 1 |
media |
array of #/$defs/content_block_media (fields) | No | Required on image blocks: one item, the picture. Send a block's media as a read returned it. |
type |
string | Yes | const: "how_to" |
required: ["document_id","type","data"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
after_block_id |
string or null | No | The block this one follows. Omit to append at the end. |
data |
object (fields) | Yes | additionalProperties: false; required: [] |
document_id |
string | Yes | The blog post id or site page variant id. |
level |
integer or null | No | Heading blocks only. maximum: 6; minimum: 1 |
media |
array of #/$defs/content_block_media (fields) | No | Required on image blocks: one item, the picture. Send a block's media as a read returned it. |
type |
string | Yes | const: "divider" |
required: ["document_id","type","data"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
after_block_id |
string or null | No | The block this one follows. Omit to append at the end. |
data |
object (fields) | Yes | additionalProperties: false; required: [] |
document_id |
string | Yes | The blog post id or site page variant id. |
level |
integer or null | No | Heading blocks only. maximum: 6; minimum: 1 |
media |
array of #/$defs/content_block_media (fields) | No | Required on image blocks: one item, the picture. Send a block's media as a read returned it. |
type |
string | Yes | const: "cta" |
required: ["document_id","type","data"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
after_block_id |
string or null | No | The block this one follows. Omit to append at the end. |
data |
object (fields) | Yes | additionalProperties: false; required: [] |
document_id |
string | Yes | The blog post id or site page variant id. |
level |
integer or null | No | Heading blocks only. maximum: 6; minimum: 1 |
media |
array of #/$defs/content_block_media (fields) | No | Required on image blocks: one item, the picture. Send a block's media as a read returned it. |
type |
string | Yes | const: "contact_cta" |
required: ["document_id","type","data"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
after_block_id |
string or null | No | The block this one follows. Omit to append at the end. |
data |
object (fields) | Yes | additionalProperties: false; required: [] |
document_id |
string | Yes | The blog post id or site page variant id. |
level |
integer or null | No | Heading blocks only. maximum: 6; minimum: 1 |
media |
array of #/$defs/content_block_media (fields) | No | Required on image blocks: one item, the picture. Send a block's media as a read returned it. |
type |
string | Yes | const: "booking_cta" |
required: ["document_id","type","data"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
after_block_id |
string or null | No | The block this one follows. Omit to append at the end. |
data |
object (fields) | Yes | additionalProperties: false; required: [] |
document_id |
string | Yes | The blog post id or site page variant id. |
level |
integer or null | No | Heading blocks only. maximum: 6; minimum: 1 |
media |
array of #/$defs/content_block_media (fields) | No | Required on image blocks: one item, the picture. Send a block's media as a read returned it. |
type |
string | Yes | const: "callout" |
required: ["document_id","type","data"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
after_block_id |
string or null | No | The block this one follows. Omit to append at the end. |
data |
object (fields) | Yes | additionalProperties: false; required: ["title"] |
document_id |
string | Yes | The blog post id or site page variant id. |
level |
integer or null | No | Heading blocks only. maximum: 6; minimum: 1 |
media |
array of #/$defs/content_block_media (fields) | No | Required on image blocks: one item, the picture. Send a block's media as a read returned it. |
type |
string | Yes | const: "hero" |
required: ["document_id","type","data"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
after_block_id |
string or null | No | The block this one follows. Omit to append at the end. |
data |
object (fields) | Yes | additionalProperties: false; required: [] |
document_id |
string | Yes | The blog post id or site page variant id. |
level |
integer or null | No | Heading blocks only. maximum: 6; minimum: 1 |
media |
array of #/$defs/content_block_media (fields) | No | Required on image blocks: one item, the picture. Send a block's media as a read returned it. |
type |
string | Yes | const: "button_group" |
required: ["document_id","type","data"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
after_block_id |
string or null | No | The block this one follows. Omit to append at the end. |
data |
object (fields) | Yes | additionalProperties: false; required: [] |
document_id |
string | Yes | The blog post id or site page variant id. |
level |
integer or null | No | Heading blocks only. maximum: 6; minimum: 1 |
media |
array of #/$defs/content_block_media (fields) | No | Required on image blocks: one item, the picture. Send a block's media as a read returned it. |
type |
string | Yes | const: "feature_grid" |
required: ["document_id","type","data"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
after_block_id |
string or null | No | The block this one follows. Omit to append at the end. |
data |
object (fields) | Yes | additionalProperties: false; required: [] |
document_id |
string | Yes | The blog post id or site page variant id. |
level |
integer or null | No | Heading blocks only. maximum: 6; minimum: 1 |
media |
array of #/$defs/content_block_media (fields) | No | Required on image blocks: one item, the picture. Send a block's media as a read returned it. |
type |
string | Yes | const: "comparison" |
required: ["document_id","type","data"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
after_block_id |
string or null | No | The block this one follows. Omit to append at the end. |
data |
object (fields) | Yes | additionalProperties: false; required: [] |
document_id |
string | Yes | The blog post id or site page variant id. |
level |
integer or null | No | Heading blocks only. maximum: 6; minimum: 1 |
media |
array of #/$defs/content_block_media (fields) | No | Required on image blocks: one item, the picture. Send a block's media as a read returned it. |
type |
string | Yes | const: "stat_grid" |
required: ["document_id","type","data"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
after_block_id |
string or null | No | The block this one follows. Omit to append at the end. |
data |
object (fields) | Yes | additionalProperties: false; required: [] |
document_id |
string | Yes | The blog post id or site page variant id. |
level |
integer or null | No | Heading blocks only. maximum: 6; minimum: 1 |
media |
array of #/$defs/content_block_media (fields) | No | Required on image blocks: one item, the picture. Send a block's media as a read returned it. |
type |
string | Yes | const: "workflow_grid" |
required: ["document_id","type","data"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
after_block_id |
string or null | No | The block this one follows. Omit to append at the end. |
data |
object (fields) | Yes | additionalProperties: false; required: [] |
document_id |
string | Yes | The blog post id or site page variant id. |
level |
integer or null | No | Heading blocks only. maximum: 6; minimum: 1 |
media |
array of #/$defs/content_block_media (fields) | No | Required on image blocks: one item, the picture. Send a block's media as a read returned it. |
type |
string | Yes | const: "showcase" |
required: ["document_id","type","data"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
after_block_id |
string or null | No | The block this one follows. Omit to append at the end. |
data |
object (fields) | Yes | additionalProperties: false; required: [] |
document_id |
string | Yes | The blog post id or site page variant id. |
level |
integer or null | No | Heading blocks only. maximum: 6; minimum: 1 |
media |
array of #/$defs/content_block_media (fields) | No | Required on image blocks: one item, the picture. Send a block's media as a read returned it. |
type |
string | Yes | const: "language_reach" |
required: ["document_id","type","data"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
after_block_id |
string or null | No | The block this one follows. Omit to append at the end. |
data |
object (fields) | Yes | additionalProperties: false; required: [] |
document_id |
string | Yes | The blog post id or site page variant id. |
level |
integer or null | No | Heading blocks only. maximum: 6; minimum: 1 |
media |
array of #/$defs/content_block_media (fields) | No | Required on image blocks: one item, the picture. Send a block's media as a read returned it. |
type |
string | Yes | const: "steps" |
required: ["document_id","type","data"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
after_block_id |
string or null | No | The block this one follows. Omit to append at the end. |
data |
object (fields) | Yes | additionalProperties: false; required: [] |
document_id |
string | Yes | The blog post id or site page variant id. |
level |
integer or null | No | Heading blocks only. maximum: 6; minimum: 1 |
media |
array of #/$defs/content_block_media (fields) | No | Required on image blocks: one item, the picture. Send a block's media as a read returned it. |
type |
string | Yes | const: "video_feature" |
required: ["document_id","type","data"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
after_block_id |
string or null | No | The block this one follows. Omit to append at the end. |
data |
object (fields) | Yes | additionalProperties: false; required: [] |
document_id |
string | Yes | The blog post id or site page variant id. |
level |
integer or null | No | Heading blocks only. maximum: 6; minimum: 1 |
media |
array of #/$defs/content_block_media (fields) | No | Required on image blocks: one item, the picture. Send a block's media as a read returned it. |
type |
string | Yes | const: "media_text" |
required: ["document_id","type","data"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
after_block_id |
string or null | No | The block this one follows. Omit to append at the end. |
data |
object (fields) | Yes | additionalProperties: false; required: [] |
document_id |
string | Yes | The blog post id or site page variant id. |
level |
integer or null | No | Heading blocks only. maximum: 6; minimum: 1 |
media |
array of #/$defs/content_block_media (fields) | No | Required on image blocks: one item, the picture. Send a block's media as a read returned it. |
type |
string | Yes | const: "contact_form" |
required: ["document_id","type","data"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
after_block_id |
string or null | No | The block this one follows. Omit to append at the end. |
data |
object (fields) | Yes | additionalProperties: false; required: [] |
document_id |
string | Yes | The blog post id or site page variant id. |
level |
integer or null | No | Heading blocks only. maximum: 6; minimum: 1 |
media |
array of #/$defs/content_block_media (fields) | No | Required on image blocks: one item, the picture. Send a block's media as a read returned it. |
type |
string | Yes | const: "team_grid" |
required: ["document_id","type","data"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
after_block_id |
string or null | No | The block this one follows. Omit to append at the end. |
data |
object (fields) | Yes | additionalProperties: false; required: [] |
document_id |
string | Yes | The blog post id or site page variant id. |
level |
integer or null | No | Heading blocks only. maximum: 6; minimum: 1 |
media |
array of #/$defs/content_block_media (fields) | No | Required on image blocks: one item, the picture. Send a block's media as a read returned it. |
type |
string | Yes | const: "testimonial_grid" |
required: ["document_id","type","data"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
after_block_id |
string or null | No | The block this one follows. Omit to append at the end. |
data |
object (fields) | Yes | additionalProperties: false; required: [] |
document_id |
string | Yes | The blog post id or site page variant id. |
level |
integer or null | No | Heading blocks only. maximum: 6; minimum: 1 |
media |
array of #/$defs/content_block_media (fields) | No | Required on image blocks: one item, the picture. Send a block's media as a read returned it. |
type |
string | Yes | const: "donation_choices" |
required: ["document_id","type","data"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
after_block_id |
string or null | No | The block this one follows. Omit to append at the end. |
data |
object (fields) | Yes | additionalProperties: false; required: ["page_ids"] |
document_id |
string | Yes | The blog post id or site page variant id. |
level |
integer or null | No | Heading blocks only. maximum: 6; minimum: 1 |
media |
array of #/$defs/content_block_media (fields) | No | Required on image blocks: one item, the picture. Send a block's media as a read returned it. |
type |
string | Yes | const: "page_grid" |
required: ["document_id","type","data"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
after_block_id |
string or null | No | The block this one follows. Omit to append at the end. |
data |
object (fields) | Yes | additionalProperties: false; required: [] |
document_id |
string | Yes | The blog post id or site page variant id. |
level |
integer or null | No | Heading blocks only. maximum: 6; minimum: 1 |
media |
array of #/$defs/content_block_media (fields) | No | Required on image blocks: one item, the picture. Send a block's media as a read returned it. |
type |
string | Yes | const: "product_grid" |
required: ["document_id","type","data"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
after_block_id |
string or null | No | The block this one follows. Omit to append at the end. |
data |
object (fields) | Yes | additionalProperties: false; required: [] |
document_id |
string | Yes | The blog post id or site page variant id. |
level |
integer or null | No | Heading blocks only. maximum: 6; minimum: 1 |
media |
array of #/$defs/content_block_media (fields) | No | Required on image blocks: one item, the picture. Send a block's media as a read returned it. |
type |
string | Yes | const: "location_grid" |
required: ["document_id","type","data"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
after_block_id |
string or null | No | The block this one follows. Omit to append at the end. |
data |
object (fields) | Yes | additionalProperties: false; required: [] |
document_id |
string | Yes | The blog post id or site page variant id. |
level |
integer or null | No | Heading blocks only. maximum: 6; minimum: 1 |
media |
array of #/$defs/content_block_media (fields) | No | Required on image blocks: one item, the picture. Send a block's media as a read returned it. |
type |
string | Yes | const: "social_posts" |
required: ["document_id","type","data"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
after_block_id |
string or null | No | The block this one follows. Omit to append at the end. |
data |
object (fields) | Yes | additionalProperties: false; required: [] |
document_id |
string | Yes | The blog post id or site page variant id. |
level |
integer or null | No | Heading blocks only. maximum: 6; minimum: 1 |
media |
array of #/$defs/content_block_media (fields) | No | Required on image blocks: one item, the picture. Send a block's media as a read returned it. |
type |
string | Yes | const: "ai_assistance" |
required: ["document_id","type","data"]
array of object fields
Value: array of object.
Array items: object.
array of object fields
Value: array of object.
Array items: object.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
admin_edit_url |
string or null | Yes | |
blocks |
array of object (fields) | Yes | |
document |
object (fields) | Yes | required: ["id","updated_at"] |
id |
string | Yes | minLength: 1 |
locale |
string | Yes | minLength: 1 |
organization_id |
string | Yes | minLength: 1 |
page_id |
string | Yes | minLength: 1 |
page_type |
string | Yes | enum: ["custom","recipe","legal","system"] |
path |
string | Yes | |
product_id |
string or null | Yes | |
recipe |
string or null | Yes | |
sort_order |
number | Yes | |
summary |
string or null | Yes | |
title |
string | Yes | |
updated_at |
string | Yes | minLength: 1 |
required: ["id","page_id","organization_id","product_id","locale","path","title","summary","page_type","recipe","sort_order","updated_at","blocks","document","admin_edit_url"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
id |
string | Yes | |
locale |
string | Yes | |
path |
string | Yes | |
removed_locales |
array of string (fields) | Yes |
required: ["id","path","locale","removed_locales"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
accessibility_contact_required |
boolean | Yes | |
additional_notes_html |
string or null | No | |
advance_notice_minutes |
number or null | No | |
created_at |
string | Yes | |
deposit_amount |
integer or null | No | Total deposit per reservation, in deposit_currency minor units. minimum: 1 |
deposit_currency |
string or null | No | ISO 4217 currency code. pattern: "^[A-Z]{3}$" |
deposit_required |
boolean | Yes | |
deposit_tax_behavior |
string or null | No | enum: ["inclusive","exclusive",null] |
deposit_trigger_party_size |
number or null | No | |
duration_minutes |
integer | Yes | minimum: 1 |
free_cancellation_until_minutes |
number or null | No | |
location_id |
string | Yes | |
minimum_guest_age |
number or null | No | |
questions |
array of object (fields) | Yes | The tenant's own questions asked beside the required reservation fields; create_table_reservation answers them by ID. maxItems: 20 |
questions_revision |
string | Yes | Send as expected_questions_revision when replacing questions, and as questions_revision when submitting answers. |
reschedule_allowed |
boolean | Yes | |
reschedule_cutoff_minutes |
number or null | No | |
slot_capacity |
number or null | No | Guests seatable at one start time. Null means unlimited. |
updated_at |
string | Yes |
required: ["location_id","duration_minutes","reschedule_allowed","deposit_required","accessibility_contact_required","questions","questions_revision","created_at","updated_at"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
additional_notes_html |
string or null | Yes | |
heading |
string | Yes | |
items |
array of object (fields) | Yes |
required: ["heading","items","additional_notes_html"]
array of object fields
Value: array of object.
Array items: object.
array of object fields
Value: array of object.
Array items: object.
#/$defs/content_heading or #/$defs/content_markdown or #/$defs/content_image or #/$defs/content_gallery or #/$defs/content_video or #/$defs/content_faq or #/$defs/content_how_to or #/$defs/content_divider or #/$defs/content_cta or #/$defs/content_contact_cta or #/$defs/content_booking_cta or #/$defs/content_callout or #/$defs/content_hero or #/$defs/content_button_group or #/$defs/content_feature_grid or #/$defs/content_comparison or #/$defs/content_stat_grid or #/$defs/content_workflow_grid or #/$defs/content_showcase or #/$defs/content_language_reach or #/$defs/content_steps or #/$defs/content_video_feature or #/$defs/content_media_text or #/$defs/content_contact_form or #/$defs/content_team_grid or #/$defs/content_testimonial_grid or #/$defs/content_donation_choices or #/$defs/content_page_grid or #/$defs/content_product_grid or #/$defs/content_location_grid or #/$defs/content_social_posts or #/$defs/content_ai_assistance fields
Value: #/$defs/content_heading or #/$defs/content_markdown or #/$defs/content_image or #/$defs/content_gallery or #/$defs/content_video or #/$defs/content_faq or #/$defs/content_how_to or #/$defs/content_divider or #/$defs/content_cta or #/$defs/content_contact_cta or #/$defs/content_booking_cta or #/$defs/content_callout or #/$defs/content_hero or #/$defs/content_button_group or #/$defs/content_feature_grid or #/$defs/content_comparison or #/$defs/content_stat_grid or #/$defs/content_workflow_grid or #/$defs/content_showcase or #/$defs/content_language_reach or #/$defs/content_steps or #/$defs/content_video_feature or #/$defs/content_media_text or #/$defs/content_contact_form or #/$defs/content_team_grid or #/$defs/content_testimonial_grid or #/$defs/content_donation_choices or #/$defs/content_page_grid or #/$defs/content_product_grid or #/$defs/content_location_grid or #/$defs/content_social_posts or #/$defs/content_ai_assistance.
anyOf: shape 1, shape 2, shape 3, shape 4, shape 5, shape 6, shape 7, shape 8, shape 9, shape 10, shape 11, shape 12, shape 13, shape 14, shape 15, shape 16, shape 17, shape 18, shape 19, shape 20, shape 21, shape 22, shape 23, shape 24, shape 25, shape 26, shape 27, shape 28, shape 29, shape 30, shape 31, shape 32.
array of #/$defs/content_block_media fields
Value: array of #/$defs/content_block_media.
Array items: #/$defs/content_block_media.
array of object fields
Value: array of object.
maxItems: 20
Array items: object.
See schema fields
Value: See schema.
not: {"anyOf":[{"required":["free_cancellation_until_minutes"]},{"required":["reschedule_allowed"]},{"required":["reschedule_cutoff_minutes"]}],"required":["cancellation_policy"]}
array of string fields
Value: array of string.
Array items: string.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
location_id |
string or null | Yes | |
location_slug |
string or null | Yes | |
location_title |
string or null | Yes | |
organization_id |
string or null | Yes | |
organization_name |
string or null | Yes | |
organization_public_url |
string or null | Yes | |
organization_slug |
string or null | Yes | |
organization_subdomain |
string or null | Yes |
additionalProperties: false; required: ["organization_id","organization_name","organization_slug","organization_subdomain","organization_public_url","location_id","location_slug","location_title"]
array of object fields
Value: array of object.
Array items: object.
array of string fields
Value: array of string.
Array items: string.
array of object fields
Value: array of object.
Array items: object.
array of object fields
Value: array of object.
Array items: object.
See schema fields
Value: See schema.
required: ["organization_id"]
See schema fields
Value: See schema.
required: ["location_id"]
array of string fields
Value: array of string.
maxItems: 4; minItems: 2; uniqueItems: true
Array items: string.
array of string fields
Value: array of string.
maxItems: 15; minItems: 3; uniqueItems: true
Array items: string.
array of object fields
Value: array of object.
Array items: object.
array of object fields
Value: array of object.
Array items: object.
array of object fields
Value: array of object.
Array items: object.
array of object fields
Value: array of object.
Array items: object.
array of object fields
Value: array of object.
Array items: object.
See schema fields
Value: See schema.
not: {"anyOf":[{"required":["budget_id"]},{"required":["daily_budget_micros"]}]}; required: ["status"]
See schema fields
Value: See schema.
required: ["budget_id","daily_budget_micros"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
id |
string | Yes | minLength: 1 |
status |
string | Yes | const: "cancelled" |
additionalProperties: false; required: ["id","status"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
body |
string | Yes | minLength: 1 |
createdAt |
string | Yes | minLength: 1 |
entryId |
string or null | Yes | |
errorCode |
string or null | Yes | |
errorField |
string or null | Yes | |
id |
string | Yes | minLength: 1 |
organizationId |
string | Yes | minLength: 1 |
reason |
string or null | Yes | |
sendAt |
string | Yes | minLength: 1 |
sentAt |
string or null | Yes | |
status |
string | Yes | enum: ["pending","sending","sent","failed","needs_review","cancelled"] |
threadId |
string | Yes | minLength: 1 |
updatedAt |
string | Yes | minLength: 1 |
version |
integer | Yes | minimum: 1 |
required: ["id","organizationId","threadId","body","sendAt","status","reason","errorCode","errorField","entryId","version","sentAt","createdAt","updatedAt"]
object fields
Value: object.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
body |
string | Yes | minLength: 1 |
createdAt |
string | Yes | minLength: 1 |
id |
string | Yes | minLength: 1 |
organizationId |
string | Yes | minLength: 1 |
schedule |
object (fields) | Yes | |
title |
string | Yes | minLength: 1 |
updatedAt |
string | Yes | minLength: 1 |
version |
integer | Yes | minimum: 1 |
required: ["id","organizationId","title","body","schedule","version","createdAt","updatedAt"]
object or null fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
check_in_instructions |
string or null | Yes | |
check_in_method |
string or null | Yes | |
checkout_instructions |
array or null (fields) | Yes | |
directions |
string or null | Yes | |
house_manual |
string or null | Yes | |
name |
string | Yes | minLength: 1 |
product_id |
string | Yes | minLength: 1 |
timezone |
string | Yes | minLength: 1 |
wifi_network |
string or null | Yes | |
wifi_password |
string or null | Yes |
additionalProperties: false; required: ["product_id","name","timezone","check_in_method","check_in_instructions","wifi_network","wifi_password","directions","house_manual","checkout_instructions"]
object or null fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
adults |
integer | Yes | |
check_in_date |
string | Yes | minLength: 1 |
check_out_date |
string | Yes | minLength: 1 |
children |
integer | Yes | |
guest_name |
string or null | Yes | |
id |
string | Yes | minLength: 1 |
infants |
integer | Yes | |
product_id |
string | Yes | minLength: 1 |
status |
string | Yes | minLength: 1 |
additionalProperties: false; required: ["id","product_id","status","check_in_date","check_out_date","guest_name","adults","children","infants"]
array of object fields
Value: array of object.
Array items: object.
array of object fields
Value: array of object.
Array items: object.
array of object fields
Value: array of object.
Array items: object.
array of object fields
Value: array of object.
Array items: object.
See schema fields
Value: See schema.
required: ["check_in_method"]
See schema fields
Value: See schema.
required: ["check_in_instructions"]
See schema fields
Value: See schema.
required: ["wifi_network"]
See schema fields
Value: See schema.
required: ["wifi_password"]
See schema fields
Value: See schema.
required: ["directions"]
See schema fields
Value: See schema.
required: ["house_manual"]
See schema fields
Value: See schema.
required: ["checkout_instructions"]
array of object fields
Value: array of object.
Array items: object.
object or null fields
Value: object or null.
anyOf: shape 1, shape 2, shape 3.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
check_in_instructions |
string or null | No | |
check_in_method |
string or null | No | |
checkout_instructions |
array or null (fields) | No | |
directions |
string or null | No | |
house_manual |
string or null | No | |
wifi_network |
string or null | No | |
wifi_password |
string or null | No |
additionalProperties: false
array of object fields
Value: array of object.
Array items: object.
array of object fields
Value: array of object.
Array items: object.
array of object fields
Value: array of object.
Array items: object.
object fields
Value: object.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
address |
object (fields) | No | additionalProperties: false |
alt_text |
string | No | |
brand_description |
string | No | |
compliance |
object (fields) | No | additionalProperties: false |
consultation |
object (fields) | No | additionalProperties: false |
description |
string | No | |
details |
object (fields) | No | additionalProperties: false |
inquiry_questions |
object | No | Translated question wording keyed by question ID: { label?, help_text?, choices?: { |
marketing_features |
array of string (fields) | No | |
metadata |
object (fields) | No | additionalProperties: false |
name |
string | No | |
questions |
object | No | Translated question wording keyed by question ID: { label?, help_text?, choices?: { |
reservation |
object (fields) | No | additionalProperties: false |
reservation_questions |
object | No | Translated question wording keyed by question ID: { label?, help_text?, choices?: { |
seo_description |
string | No | |
seo_keywords |
string or null | No | |
seo_title |
string | No | |
short_description |
string | No | |
summary |
string or null | No | |
title |
string or null | No | |
unit_label |
string | No |
additionalProperties: false
See schema fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
resource_type |
string | No | const: "organization" |
values |
object (fields) | No | additionalProperties: false |
not: {"anyOf":[{"required":["content_blocks"]},{"required":["expected_updated_at"]}]}
See schema fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
resource_type |
string | No | const: "business_location" |
values |
object (fields) | No | additionalProperties: false |
not: {"anyOf":[{"required":["content_blocks"]},{"required":["expected_updated_at"]}]}
See schema fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
resource_type |
string | No | const: "product" |
values |
object (fields) | No | additionalProperties: false |
not: {"anyOf":[{"required":["content_blocks"]},{"required":["expected_updated_at"]}]}
See schema fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
resource_type |
string | No | const: "collection" |
values |
object (fields) | No | additionalProperties: false |
not: {"anyOf":[{"required":["content_blocks"]},{"required":["expected_updated_at"]}]}
See schema fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
resource_type |
string | No | const: "article_category" |
values |
object (fields) | No | additionalProperties: false |
not: {"anyOf":[{"required":["content_blocks"]},{"required":["expected_updated_at"]}]}
See schema fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
resource_type |
string | No | const: "media_asset" |
values |
object (fields) | No | additionalProperties: false |
not: {"anyOf":[{"required":["content_blocks"]},{"required":["expected_updated_at"]}]}
See schema fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
resource_type |
string | No | const: "content_document" |
values |
object (fields) | No | additionalProperties: false |
array of object fields
Value: array of object.
maxItems: 250; minItems: 1
Array items: object.
See schema fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
items |
array of See schema (fields) | No | |
resource_type |
string | No | const: "organization" |
See schema fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
items |
array of See schema (fields) | No | |
resource_type |
string | No | const: "business_location" |
See schema fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
items |
array of See schema (fields) | No | |
resource_type |
string | No | const: "product" |
See schema fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
items |
array of See schema (fields) | No | |
resource_type |
string | No | const: "collection" |
See schema fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
items |
array of See schema (fields) | No | |
resource_type |
string | No | const: "article_category" |
See schema fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
items |
array of See schema (fields) | No | |
resource_type |
string | No | const: "media_asset" |
array of object fields
Value: array of object.
Array items: object.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
address |
object or null (fields) | No | additionalProperties: false; required: ["regionCode","addressLines"] |
assigned_member_id |
string or null | No | Responsible Better Auth membership ID from list_organization_members, not userId. Null is unassigned. Choose a member or team, never both; clear assigned_team_id when choosing a member. |
assigned_team_id |
string or null | No | Responsible Better Auth Team ID from list_teams. Its current members receive assigned location work. Choose a member or team, never both; clear assigned_member_id when choosing a team. |
canonical_url |
string or null | No | |
created_at |
string | No | |
description |
string or null | No | |
email |
string or null | No | |
id |
string | No | minLength: 1 |
latitude |
number or null | No | maximum: 90; minimum: -90 |
longitude |
number or null | No | maximum: 180; minimum: -180 |
maps_url |
string or null | No | |
max_capacity |
number or null | No | Stored location capacity metadata; does not limit reservations. Reservation capacity uses location_reservation_configs.slot_capacity. |
media |
array of object (fields) | No | |
opening_hours |
null or object (fields) | No | |
phone |
string or null | No | |
rating |
number or null | No | |
review_count |
number or null | No | |
seo_description |
string or null | No | |
seo_title |
string or null | No | |
short_description |
string or null | No | |
slug |
string | No | minLength: 1 |
special_hours |
null or array of object (fields) | No | |
status |
string | No | Operational state. Inactive locations are hidden. Active locations follow the website’s publication rules; business locations and live homes are counted separately for billing. enum: ["active","inactive"] |
stay_map_sharing |
string | No | Public map precision for places to stay at this location; both choices keep their street address private. enum: ["general","specific"] |
timezone |
string | No | Explicit IANA timezone identifier, such as Asia/Bangkok. Missing timezone is an error, never the browser timezone. minLength: 1 |
title |
string | No | |
updated_at |
string | No | |
website_url |
string or null | No |
required: []
object or null fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
addressLines |
array of string (fields) | Yes | Address lines in order, unbounded. minItems: 1 |
administrativeArea |
string | No | State, province or region. |
languageCode |
string | No | BCP-47 tag when the address is written in a specific language. |
locality |
string | No | Town or city. |
postalCode |
string | No | |
regionCode |
string | Yes | Two-letter uppercase country code, e.g. TH. pattern: "^[A-Z]{2}$" |
sublocality |
string | No | Neighbourhood or sub-district. |
additionalProperties: false; required: ["regionCode","addressLines"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
id |
string | Yes | minLength: 1 |
status |
string | Yes | Current operational status. New locations are active; a retry returns the saved location’s current status. enum: ["active","inactive"] |
title |
string | Yes |
additionalProperties: false; required: ["id","title","status"]
array of string fields
Value: array of string.
Array items: string.
array of object fields
Value: array of object.
Array items: object.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
address |
object or null (fields) | No | additionalProperties: false; required: ["regionCode","addressLines"] |
assigned_member_id |
string or null | Yes | Responsible Better Auth membership ID from list_organization_members, not userId. Null is unassigned. Choose a member or team, never both; clear assigned_team_id when choosing a member. |
assigned_team_id |
string or null | Yes | Responsible Better Auth Team ID from list_teams. Its current members receive assigned location work. Choose a member or team, never both; clear assigned_member_id when choosing a team. |
canonical_url |
string or null | No | |
created_at |
string | Yes | |
description |
string or null | No | |
email |
string or null | No | |
id |
string | Yes | minLength: 1 |
latitude |
number or null | Yes | maximum: 90; minimum: -90 |
longitude |
number or null | Yes | maximum: 180; minimum: -180 |
maps_url |
string or null | No | |
max_capacity |
number or null | No | Stored location capacity metadata; does not limit reservations. Reservation capacity uses location_reservation_configs.slot_capacity. |
media |
array of object (fields) | Yes | |
opening_hours |
null or object (fields) | No | |
phone |
string or null | No | |
rating |
number or null | No | |
review_count |
number or null | No | |
seo_description |
string or null | No | |
seo_title |
string or null | No | |
short_description |
string or null | No | |
slug |
string | Yes | minLength: 1 |
special_hours |
null or array of object (fields) | No | |
status |
string | Yes | Operational state. Inactive locations are hidden. Active locations follow the website’s publication rules; business locations and live homes are counted separately for billing. enum: ["active","inactive"] |
stay_map_sharing |
string | Yes | Public map precision for places to stay at this location; both choices keep their street address private. enum: ["general","specific"] |
timezone |
string | Yes | Explicit IANA timezone identifier, such as Asia/Bangkok. Missing timezone is an error, never the browser timezone. minLength: 1 |
title |
string | Yes | |
updated_at |
string | Yes | |
website_url |
string or null | No |
required: ["id","slug","title","assigned_member_id","assigned_team_id","stay_map_sharing","latitude","longitude","status","timezone","created_at","updated_at","media"]
null or object fields
Value: null or object.
null or array of object fields
Value: null or array of object.
object fields
Value: object.
oneOf: shape 1, shape 2, shape 3, shape 4, shape 5, shape 6.
array of object fields
Value: array of object.
Array items: object.
object fields
Value: object.
oneOf: shape 1, shape 2, shape 3, shape 4, shape 5, shape 6, shape 7.
array of object fields
Value: array of object.
Array items: object.
array of object fields
Value: array of object.
Array items: object.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
download_url |
string | Yes | |
file_id |
string | Yes | |
file_name |
string | No | |
mime_type |
string | No |
required: ["download_url","file_id"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
download_url |
string | Yes | |
file_id |
string | Yes | |
file_name |
string | No | |
mime_type |
string | No |
required: ["download_url","file_id"]
object or null fields
Value: object or null.
object fields
Value: object.
oneOf: shape 1, shape 2, shape 3, shape 4, shape 5, shape 6.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
focus |
object (fields) | Yes | additionalProperties: false; required: ["x","y"] |
shape |
string | Yes | enum: ["original","square","circle"] |
additionalProperties: false; required: ["shape","focus"]
See schema fields
Value: See schema.
required: ["alt_text"]
See schema fields
Value: See schema.
required: ["category"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
delivery |
object or null (fields) | Yes | required: ["status","error"] |
email |
string | Yes | |
expiresAt |
string | Yes | format: "date-time" |
id |
string | Yes | |
role |
string | Yes | |
status |
string | Yes |
additionalProperties: false; required: ["id","email","role","status","expiresAt","delivery"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
id |
string | Yes | |
name |
string | Yes |
additionalProperties: false; required: ["id","name"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
brand_description |
string or null | No | |
created_at |
string | No | |
id |
string | Yes | |
media |
array of object (fields) | No | |
name |
string or null | No | |
organization_id |
string | No | |
public_url |
string or null | No | |
status |
string | Yes | |
subdomain |
string | Yes | |
theme |
string | No | |
updated_at |
string | No |
required: ["id","subdomain","status"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
address_visibility |
string | No | enum: ["visible","hidden"] |
announcement |
object or null (fields) | No | |
brand_description |
string or null | No | |
button_casing |
string | No | Button text casing: uppercase or none (natural case). Absent when the site uses the Default. enum: ["uppercase","none"] |
button_color |
string | No | Button fill: action (the palette's action color) or accent (the palette's accent color). Absent when the site uses the Default. enum: ["action","accent"] |
button_shape |
string | No | Button corner styling: pill (fully rounded), rounded (subtle radius), or sharp (square corners). Absent when the site uses the Default. enum: ["pill","rounded","sharp"] |
canonical_url |
string or null | No | |
careers_email |
string or null | No | |
catering_email |
string or null | No | |
contact_email |
string or null | No | |
created_at |
string | No | |
custom_domain_status |
string or null | No | |
default_currency |
string | Yes | |
font_preset |
string | No | enum: ["default","mali","sarabun","prompt","kanit","ibm-plex-sans-thai","noto-serif-thai","inter","dm-sans","montserrat","lora","playfair-display","cormorant-garamond","marcellus"] |
google_analytics_measurement_id |
string or null | No | |
heading_casing |
string | No | Display heading casing: uppercase or none (natural case). Absent when the site uses the Default. enum: ["uppercase","none"] |
id |
string | Yes | |
inquiry_questions |
array of object (fields) | No | The inquiry form's own questions, asked beside name, email, phone and message on every contact form the site places. maxItems: 20 |
inquiry_questions_revision |
string | No | Send as expected_inquiry_questions_revision when replacing inquiry_questions, and as questions_revision with an inquiry. |
integrations |
object (fields) | No | Saved connections and the provider account, property or site each acts on. A saved connection does not prove a report will pass; query_google_analytics, query_search_console and query_google_ads_report report their own failures. |
media |
array of object (fields) | No | |
name |
string or null | No | |
organization_id |
string | No | |
palette |
object or null (fields) | No | The colors the site renders, light and dark: its own, or the default. Null on KrabiClaw's own site. |
palette_source |
string or null | No | enum: ["custom","default",null] |
partnerships_email |
string or null | No | |
press_email |
string or null | No | |
public_url |
string or null | No | |
seo_description |
string or null | No | |
seo_title |
string or null | No | |
status |
string | No | |
subdomain |
string | Yes | |
theme |
string | No | |
timezone |
string | Yes | |
updated_at |
string | No |
required: ["id","subdomain","default_currency","timezone"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
address_line_2 |
string | No | |
city |
string | No | |
country |
string | No | pattern: "^[A-Z]{2}$" |
phone |
string | No | International number with its country calling code, e.g. +66812345678. |
postal_code |
string | No | |
region |
string | No | |
street_address |
string | No | |
website_url |
string | No | format: "uri" |
additionalProperties: false
array of string fields
Value: array of string.
Array items: string.
array of object fields
Value: array of object.
Array items: object.
array of object fields
Value: array of object.
Array items: object.
array of object fields
Value: array of object.
Array items: object.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
id |
string | Yes | |
isPlatformAdmin |
boolean | Yes |
required: ["id","isPlatformAdmin"]
array of object fields
Value: array of object.
Array items: object.
array of object fields
Value: array of object.
Array items: object.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
createdAt |
string | Yes | format: "date-time" |
id |
string | Yes | |
organizationId |
string | Yes | |
role |
string | Yes | |
userId |
string | Yes |
required: ["id","organizationId","userId","role","createdAt"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
external_url |
string or null | Yes | |
mode |
string | Yes | enum: ["native","external_url","native_disabled"] |
required: ["mode","external_url"]
object or null fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
cta_label |
string or null | No | Button label. Requires cta_url and vice versa. |
cta_url |
string or null | No | Button destination, http or https. Requires cta_label and vice versa. |
description |
string or null | No | maxLength: 500 |
dismissible |
boolean | No | Whether a visitor who closes it will not be shown it again on that device. |
enabled |
boolean | No | Whether the announcement is currently shown. false keeps the saved content without showing it. |
format |
string | No | Display style: modal popup dialog or top banner bar (default modal). enum: ["modal","banner"] |
headline |
string | Yes | Required in every write, even an empty string when disabling without discarding it. maxLength: 120 |
required: ["headline"]
array of object fields
Value: array of object.
maxItems: 20
Array items: object.
object or null fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
dark |
object (fields) | No | additionalProperties: false |
light |
object (fields) | No | additionalProperties: false |
starter |
string | No | enum: ["coastal","forest","terracotta","ink","blossom","saffron","slate","midnight"] |
additionalProperties: false
array of object fields
Value: array of object.
Array items: object.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
address_visibility |
string | No | enum: ["visible","hidden"] |
announcement |
object or null (fields) | No | |
brand_description |
string or null | No | |
button_casing |
string | No | Button text casing: uppercase or none (natural case). Absent when the site uses the Default. enum: ["uppercase","none"] |
button_color |
string | No | Button fill: action (the palette's action color) or accent (the palette's accent color). Absent when the site uses the Default. enum: ["action","accent"] |
button_shape |
string | No | Button corner styling: pill (fully rounded), rounded (subtle radius), or sharp (square corners). Absent when the site uses the Default. enum: ["pill","rounded","sharp"] |
canonical_url |
string or null | No | |
careers_email |
string or null | No | |
catering_email |
string or null | No | |
contact_email |
string or null | No | |
created_at |
string | No | |
custom_domain_status |
string or null | No | |
default_currency |
string | No | |
font_preset |
string | No | enum: ["default","mali","sarabun","prompt","kanit","ibm-plex-sans-thai","noto-serif-thai","inter","dm-sans","montserrat","lora","playfair-display","cormorant-garamond","marcellus"] |
google_analytics_measurement_id |
string or null | No | |
heading_casing |
string | No | Display heading casing: uppercase or none (natural case). Absent when the site uses the Default. enum: ["uppercase","none"] |
id |
string | No | |
inquiry_questions |
array of object (fields) | No | The inquiry form's own questions, asked beside name, email, phone and message on every contact form the site places. maxItems: 20 |
inquiry_questions_revision |
string | No | Send as expected_inquiry_questions_revision when replacing inquiry_questions, and as questions_revision with an inquiry. |
integrations |
object (fields) | No | Saved connections and the provider account, property or site each acts on. A saved connection does not prove a report will pass; query_google_analytics, query_search_console and query_google_ads_report report their own failures. |
media |
array of object (fields) | No | |
name |
string or null | No | |
organization_id |
string | No | |
palette |
object or null (fields) | No | The colors the site renders, light and dark: its own, or the default. Null on KrabiClaw's own site. |
palette_source |
string or null | No | enum: ["custom","default",null] |
partnerships_email |
string or null | No | |
press_email |
string or null | No | |
public_url |
string or null | No | |
seo_description |
string or null | No | |
seo_title |
string or null | No | |
status |
string | No | |
subdomain |
string | No | |
theme |
string | No | |
timezone |
string | No | |
updated_at |
string | No |
additionalProperties: false
array of object fields
Value: array of object.
Array items: object.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
amount |
integer | Yes | |
buyer_name |
string or null | No | |
captured_amount |
integer | Yes | |
created_at |
string | No | |
currency |
string | Yes | |
ends_at |
string or null | No | |
id |
string | Yes | |
image_url |
string or null | No | |
refunded_amount |
integer | Yes | |
starts_at |
string or null | No | |
state |
string | Yes | |
timezone |
string or null | No | |
title |
string | Yes | |
to |
string | Yes |
additionalProperties: false; required: ["id","currency","amount","captured_amount","refunded_amount","state","title","to"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
price |
object (fields) | No | |
product_id |
string or null | No | |
quantity |
integer | Yes | |
session_id |
string or null | No | |
title |
string | Yes | |
variant_id |
string or null | No |
required: ["title","quantity"]
array of object fields
Value: array of object.
Array items: object.
object or null fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
available |
array of object (fields) | Yes | |
pending |
array of object (fields) | Yes |
required: ["available","pending"]
array of object fields
Value: array of object.
Array items: object.
array of object fields
Value: array of object.
Array items: object.
array of object fields
Value: array of object.
Array items: object.
array of object fields
Value: array of object.
Array items: object.
string or null fields
Value: string or null.
object or null fields
Value: object or null.
string or null fields
Value: string or null.
array of object fields
Value: array of object.
Array items: object.
string or null fields
Value: string or null.
string or null fields
Value: string or null.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
body |
string or null | No | |
call_to_action |
object or null (fields) | No | |
canonical_url |
string or null | No | |
created_at |
string | No | |
id |
string | Yes | |
location_id |
string or null | No | |
media |
array of object (fields) | Yes | Cover, then gallery, in order. |
organization_id |
string | No | |
preview_url |
string or null | No | A signed link to the draft as visitors will see it. |
public_path |
string | No | |
public_url |
string or null | No | |
publications |
array of object (fields) | Yes | |
published_at |
string or null | No | |
slug |
string | Yes | |
source |
string | No | The organization authored this website post or created it from a template. enum: ["manual","template"] |
status |
string | Yes | enum: ["draft","published"] |
title |
string or null | No | |
updated_at |
string | Yes | The expected_updated_at update_post and publish_post take. |
view_url |
string or null | No | |
visibility |
string | Yes | enum: ["listed","unlisted"] |
required: ["id","slug","status","visibility","media","publications","updated_at"]
object or null fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
id |
string | Yes | |
state |
string | Yes | enum: ["removed"] |
required: ["id","state"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
body |
string or null | Yes | |
channel |
string | Yes | enum: ["facebook","instagram","discord"] |
media |
array of object (fields) | Yes | |
provider_post_id |
string | Yes | Native provider identity, not a website post_id. |
public_url |
string or null | Yes | The provider link. A Discord message link opens only for members of that channel. |
published_at |
string | Yes | |
target_id |
string | Yes |
additionalProperties: false; required: ["channel","target_id","provider_post_id","body","public_url","published_at","media"]
array of object fields
Value: array of object.
Array items: object.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
channel |
string | Yes | enum: ["organization"] |
label |
string | Yes | |
target_id |
string | Yes |
required: ["channel","target_id","label"]
array of object fields
Value: array of object.
Array items: object.
array of object fields
Value: array of object.
Array items: object.
array of object fields
Value: array of object.
maxItems: 4; minItems: 1
Array items: object.
array of object fields
Value: array of object.
Array items: object.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
channel |
string | Yes | enum: ["organization","facebook","instagram","discord"] |
code |
string | No | |
message |
string | No | |
public_url |
string or null | No | |
publication_id |
string | No | |
status |
string | Yes | enum: ["published","already_published","processing","failed","unknown","skipped"] |
target_id |
string | Yes |
additionalProperties: false; required: ["channel","target_id","status"]
string or null fields
Value: string or null.
See schema fields
Value: See schema.
required: ["body"]
See schema fields
Value: See schema.
required: ["call_to_action"]
array of object fields
Value: array of object.
maxItems: 400; minItems: 1
Array items: object.
array of object fields
Value: array of object.
Array items: object.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
description |
string or null | Yes | |
id |
string | Yes | |
image |
object or null (fields) | Yes | The section's own photo; set it with set_media owner_type collection, slot image. required: ["asset_id","kind","public_url","status"] |
location_id |
string or null | Yes | |
name |
string | Yes | |
organization_id |
string | Yes | |
slug |
string | Yes | |
sort_order |
integer | Yes |
additionalProperties: false; required: ["id","organization_id","location_id","name","slug","description","image","sort_order"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
assigned_member_id |
string or null | No | Host membership ID from list_organization_members → members[].id or get_member_scheduling → members[].id, not userId. Guests see this member’s approved public profile. Read get_member_public_profile; publication requires an approved profile with a nonblank public_name. Clear assigned_team_id when choosing a member. |
assigned_team_id |
string or null | No | Host team ID from list_teams. Guests see the team’s members with approved public profiles; at least one is required for publication. Clear assigned_member_id when choosing a team. |
confirmation_mode |
string | No | instant confirms immediately (default); review waits for staff approval. default: "instant"; enum: ["instant","review"] |
default_capacity |
integer or null | Yes | Places per session; null means unlimited. minimum: 1 |
duration_minutes |
integer | Yes | Minutes each visit occupies its booking slot or seats, independent of the interval between start times. minimum: 1 |
location_id |
string or null | Yes | |
online_payment_required |
boolean | No | True requires online payment when booking; false is the default and does not collect online. default: false |
scheduling_mode |
string | No | Legal consultations require provider scheduling with an explicitly assigned attorney or legal team. Experiences may use legacy business scheduling without one named provider. Physical provider times also respect the selected member’s availability; online times come from their working hours. enum: ["legacy","provider"] |
sessions |
array of object (fields) | No | maxItems: 100; minItems: 1 |
weekly_slots |
array of object (fields) | No | maxItems: 100; minItems: 1 |
additionalProperties: false; required: ["location_id","duration_minutes","default_capacity"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
allergens |
array of string (fields) | No | Allergens the merchant states this dish contains. maxItems: 100; uniqueItems: true |
cancellation_policy |
string | No | The merchant’s stated cancellation terms, displayed publicly; this text does not automate refunds. maxLength: 10000; minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
carbon_monoxide_detector_details |
string | No | Share where each carbon monoxide alarm is located. maxLength: 300; minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
climbing_structures |
boolean | No | Play or climbing structures are available to guests. |
climbing_structures_details |
string | No | Host-authored details about climbing or play structures. Requires its disclosure to be Yes. maxLength: 300; minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
commercial_photography_allowed |
boolean | No | Whether guests may take commercial photos or film at the property. |
dangerous_animals |
boolean | No | Animals that could cause harm live on or near the property. |
dangerous_animals_details |
string | No | Host-authored details about potentially dangerous animals. Requires its disclosure to be Yes. maxLength: 300; minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
dietary_notes |
array of string (fields) | No | Merchant-stated dietary facts displayed with a dish. maxItems: 100; uniqueItems: true |
events_allowed |
boolean | No | Whether guests may host events at the property. |
exterior_security_cameras |
boolean | No | Describe exterior cameras, what they monitor and whether they record audio or video. |
exterior_security_cameras_details |
string | No | Host-authored details about exterior security cameras. Requires its disclosure to be Yes. maxLength: 300; minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
featured |
boolean | No | Highlight this item on the menu and homepage. |
getting_around |
string | No | Host-authored transport and getting-around information for this home. maxLength: 10000; minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
guest_access |
string | No | The spaces and facilities guests can use during their stay. maxLength: 10000; minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
house_rules |
string | No | The host’s rules for guests staying in the home, shown with the listing. maxLength: 10000; minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
included_items |
array of string (fields) | No | Items or work included in the stated price, shown in their own public section. maxItems: 100; uniqueItems: true |
ingredients |
array of string (fields) | No | Ingredients shown in the dish details. maxItems: 100; uniqueItems: true |
interaction_with_guests |
string | No | How guests can contact the host and what support is available. maxLength: 10000; minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
limited_essentials |
boolean | No | Tell guests which everyday essentials are unavailable. |
limited_essentials_details |
string | No | Host-authored details about limited essential amenities. Requires its disclosure to be Yes. maxLength: 300; minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
meeting_point |
string | No | Instructions shown in the meeting section; meeting mode and video links are set in scheduling. maxLength: 10000; minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
nearby_water |
boolean | No | Guests can reach a body of water on or next to the property. |
nearby_water_details |
string | No | Host-authored details about nearby water. Requires its disclosure to be Yes. maxLength: 300; minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
neighborhood_description |
string | No | Host-authored information about the neighborhood around this home. maxLength: 10000; minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
no_property_parking |
boolean | No | Dedicated guest parking is not available on the property. |
no_property_parking_details |
string | No | Host-authored details about no parking on the property. Requires its disclosure to be Yes. maxLength: 300; minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
noise_decibel_monitors |
boolean | No | Devices measure sound levels without recording conversations. |
noise_decibel_monitors_details |
string | No | Host-authored details about noise decibel monitors. Requires its disclosure to be Yes. maxLength: 300; minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
noodle |
array of string (fields) | No | Authored noodle information shown as dish facts; these do not establish purchasable variants. maxItems: 100; uniqueItems: true |
other_details_to_note |
string | No | Additional information guests should know before booking. maxLength: 10000; minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
pets_allowed |
boolean | No | Let guests know if they can bring pets. |
potential_noise |
boolean | No | Guests may hear traffic, construction or other noise. |
potential_noise_details |
string | No | Host-authored details about potential noise during stays. Requires its disclosure to be Yes. maxLength: 300; minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
preparation |
string | No | Preparation instructions shown to customers before a session or appointment. maxLength: 10000; minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
pricing_note |
string | No | An explicitly stated price such as Market price; use only when no numeric price is set. maxLength: 1000; minLength: 1; pattern: "^(?=[\s\S]\S)[^\r\n]$" |
quiet_hours |
boolean | No | Hours when guests should keep noise to a minimum. |
quiet_hours_end |
string | No | Local end of quiet hours, required with quiet hours and its start time. enum: ["00:00","01:00","02:00","03:00","04:00","05:00","06:00","07:00","08:00","09:00","10:00","11:00","12:00","13:00","14:00","15:00","16:00","17:00","18:00","19:00","20:00","21:00","22:00","23:00"]; maxLength: 1000; minLength: 1; pattern: "^(?=[\s\S]\S)[^\r\n]$" |
quiet_hours_start |
string | No | Local start of quiet hours, required with quiet hours and its end time. enum: ["00:00","01:00","02:00","03:00","04:00","05:00","06:00","07:00","08:00","09:00","10:00","11:00","12:00","13:00","14:00","15:00","16:00","17:00","18:00","19:00","20:00","21:00","22:00","23:00"]; maxLength: 1000; minLength: 1; pattern: "^(?=[\s\S]\S)[^\r\n]$" |
resident_pets |
boolean | No | Guests may encounter animals that live here. |
resident_pets_details |
string | No | Host-authored details about pets live on the property. Requires its disclosure to be Yes. maxLength: 300; minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
shared_spaces |
boolean | No | Guests share some spaces with other people. |
shared_spaces_details |
string | No | Host-authored details about shared spaces. Requires its disclosure to be Yes. maxLength: 300; minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
sizes |
array of string (fields) | No | Authored serving information; priced choices belong in variants. maxItems: 100; uniqueItems: true |
smoke_detector_details |
string | No | Share where each smoke alarm is located. maxLength: 300; minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
smoking_allowed |
boolean | No | Whether guests may smoke or vape at the property. |
soup |
array of string (fields) | No | Authored soup information shown with the dish. maxItems: 100; uniqueItems: true |
special_safety_considerations |
string | No | Other property features that guests should know could be unsafe, and why. maxLength: 300; minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
stairs_required |
boolean | No | Guests need to use stairs during their stay. |
stairs_required_details |
string | No | Host-authored details about guests must climb stairs. Requires its disclosure to be Yes. maxLength: 300; minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
tagline |
string | No | A short sentence shown below the product title. maxLength: 1000; minLength: 1; pattern: "^(?=[\s\S]\S)[^\r\n]$" |
toppings |
array of string (fields) | No | Authored topping information; priced choices belong in variants. maxItems: 100; uniqueItems: true |
unprotected_heights |
boolean | No | Elevated areas are accessible without a railing or other protection. |
unprotected_heights_details |
string | No | Host-authored details about unprotected heights. Requires its disclosure to be Yes. maxLength: 300; minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
unsecured_pool |
boolean | No | Guests can reach a pool or hot tub without a gate or lock. |
unsecured_pool_details |
string | No | Host-authored details about unsecured pool or hot tub. Requires its disclosure to be Yes. maxLength: 300; minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
weapons_on_property |
boolean | No | Tell guests about weapons stored on the property. |
weapons_on_property_details |
string | No | Host-authored details about weapons on the property. Requires its disclosure to be Yes. maxLength: 300; minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
what_to_bring |
array of string (fields) | No | Items customers should bring, shown in the preparation section. maxItems: 100; uniqueItems: true |
your_property |
string | No | The spaces and features guests should know about this home. maxLength: 10000; minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
additionalProperties: false
array of string fields
Value: array of string.
maxItems: 15
Array items: string.
array of object fields
Value: array of object.
maxItems: 3
Array items: object.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
blocks |
array of object (fields) | Yes | Complete canonical block array. Each existing block must retain its id unless its removal is explicitly confirmed. Block data never contains asset IDs or delivery URLs. Omit media to preserve that block's current placements; provide media explicitly to replace them, or call set_media with owner_type "content_block", the block id, and the intended slot. |
pageType |
string | No | The page's type. Send the page_type from the last read unless you are changing it. enum: ["custom","recipe","legal","system"] |
path |
string | No | The page's public path. A practice area or consultation may omit it to get the first free /services/ |
recipe |
string or null | No | The site section this page fills, or null for a page that fills none. Send the recipe from the last read unless you are changing it; an omitted recipe is not kept. |
sortOrder |
number | No | The page's position in the site's page list. Send the sort_order from the last read unless you are reordering. |
summary |
string or null | No | Omit to preserve on update; null clears it. |
title |
string | Yes | The page's name, e.g. About. The site name is appended to the browser title. Always sent in full — an omitted title is not kept. |
additionalProperties: false; required: ["title","blocks"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
amenities |
array of string (fields) | No | Amenity codes the home offers; replaces the whole positive list. Empty offers none. uniqueItems: true |
amenity_answers |
array of object (fields) | No | Sparse amenity answer patch: true offers it, false explicitly reports absence, null clears to unknown. Omitted codes remain. Positive-list edits preserve false reports and remove omitted positive reports to unknown. Contradictions between amenities and amenity_answers are refused. |
assigned_member_id |
string or null | No | Host membership ID from list_organization_members → members[].id or get_member_scheduling → members[].id, not userId. This assignment grants the member access to the home’s stays and shows their approved public profile to guests. Publication requires an approved profile with a nonblank public_name; read get_member_public_profile. Clear assigned_team_id when choosing a member. |
assigned_team_id |
string or null | No | Host team ID from list_teams. This assignment grants the team access to the home’s stays and shows its members with approved public profiles to guests. At least one approved profile is required for publication. Clear assigned_member_id when choosing a team. |
bathrooms |
number or null | No | Whole and half baths, such as 1.5. maximum: 50; minimum: 0; multipleOf: 0.5 |
bedrooms |
integer or null | No | Bedrooms; 0 is a studio. maximum: 50; minimum: 0 |
beds |
integer or null | No | maximum: 50; minimum: 1 |
calendar_rules |
object or null (fields) | No | Actual optional listing rules. Null removes them. Dated overrides take precedence over weekday minimums, then the required default. Friday/Saturday use the weekend price when supplied. additionalProperties: false |
cancellation_policy |
string | No | Policy shown to guests for stays under 28 nights. A home always has one: a new home starts on Flexible, as a new Airbnb listing does, and an Airbnb import takes the listing’s own. It does not refund by itself. enum: ["flexible","moderate","limited","firm","strict"] |
check_in_end_time |
string or null | No | Local 24-hour end of the check-in window; null is a flexible end. A time earlier than check_in_time is after midnight. pattern: "^([01]\d|2[0-3]):[0-5]\d$" |
check_in_time |
string | Yes | Local 24-hour time guests may arrive from, in the location’s timezone. pattern: "^([01]\d|2[0-3]):[0-5]\d$" |
check_out_time |
string | Yes | Local 24-hour time guests leave by. pattern: "^([01]\d|2[0-3]):[0-5]\d$" |
listing_floor |
integer or null | No | The listing’s floor, counted from 1. Cannot exceed total_floors when both are known; null when not said. maximum: 9007199254740991; minimum: 1 |
listing_type |
string or null | No | Whether guests book the entire place, a private room or a shared room. Null when not said. enum: ["entire_place","private_room","shared_room",null] |
location_id |
string | Yes | |
long_term_cancellation_policy |
string | No | Policy shown to guests for stays of 28 nights or more. A home always has one: a new home starts on Firm Long Term, as a new Airbnb listing does, and an Airbnb import takes the listing’s own. enum: ["firm","strict"] |
max_guests |
integer | Yes | maximum: 99; minimum: 1 |
min_nights |
integer | Yes | The listing’s required default minimum; individual arrival dates may override it. maximum: 1125; minimum: 1 |
property_size |
number or null | No | Property area in property_size_unit. Size and unit must both be set or both null. exclusiveMinimum: 0 |
property_size_unit |
string or null | No | The unit of property_size. Size and unit must both be set or both null. enum: ["square_meters","square_feet",null] |
property_type |
string or null | No | Airbnb property type, one the property_type_group offers. Null with property_type_group when not said. enum: ["apartment","condominium","serviced_apartment","loft","house","townhouse","bungalow","cabin","chalet","earthhouse","hut","lighthouse","villa","dome","cottage","farmstay","houseboat","tiny_house","guesthouse","private_suite","boat","castle","cave","igloo","island","plane","rv","tent","tipi","train","treehouse","yurt","other","barn","campsite","windmill","bus","holiday_park","ranch","religious_building","riad","shipping_container","tower","bnb","nature_eco_lodge","boutique_hotel","hostel","aparthotel","hotel","resort",null] |
property_type_group |
string or null | No | Airbnb's property group: apartments (Apartment: apartment, condominium, serviced_apartment, loft); houses (House: house, townhouse, bungalow, cabin, chalet, earthhouse, hut, lighthouse, villa, dome, cottage, farmstay, houseboat, tiny_house); secondary_units (Secondary unit: guesthouse, private_suite, farmstay); unique_homes (Unique space: boat, castle, cave, earthhouse, hut, igloo, island, lighthouse, plane, rv, tent, tipi, train, treehouse, yurt, other, dome, barn, campsite, farmstay, houseboat, tiny_house, windmill, bus, holiday_park, ranch, religious_building, riad, shipping_container, tower); bnb (Bed and breakfast: bnb, nature_eco_lodge, farmstay); boutique_hotels_and_more (Boutique hotel: boutique_hotel, nature_eco_lodge, hostel, serviced_apartment, aparthotel, hotel, resort). Supply property_type with it; both are set or both null. enum: ["apartments","houses","secondary_units","unique_homes","bnb","boutique_hotels_and_more",null] |
total_floors |
integer or null | No | Total floors in the property; null when not said. maximum: 9007199254740991; minimum: 1 |
year_built |
integer or null | No | Year the property was built; null when not said. maximum: 9007199254740991; minimum: 1 |
additionalProperties: false; required: ["location_id","check_in_time","check_out_time","max_guests","min_nights"]
array of object fields
Value: array of object.
maxItems: 250; minItems: 1
Array items: object.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
active |
boolean | Yes | The merchant sale switch. Not visibility and not stock: a disabled product is not sold out. |
admin_edit_url |
string or null | No | The dashboard editor for this product, on the platform host. |
booking |
object or null (fields) | No | required: ["duration_minutes","default_capacity","confirmation_mode","online_payment_required","held_online","questions","questions_revision"] |
booking_readiness |
object or null (fields) | No | required: ["ready","missing"] |
collections |
array of object (fields) | Yes | |
created_at |
string | Yes | |
description |
string | Yes | |
details |
object (fields) | Yes | additionalProperties: false |
gallery |
array of object (fields) | No | |
id |
string | Yes | |
image |
object or null (fields) | No | required: ["asset_id","kind","public_url","status"] |
kind |
string | Yes | enum: ["dish","experience","service","stay"] |
locations |
array of object (fields) | Yes | |
marketing_features |
array of string (fields) | No | |
metadata |
object | No | additionalProperties: {"type":"string"} |
name |
string | Yes | |
options |
array of object (fields) | Yes | |
order_url |
string or null | No | |
page |
object or null (fields) | No | The source page this product owns, or null. Edit its content with the site-page tools; its binding is the page's product_id. required: ["id","path","title"] |
public_url |
string or null | No | |
publications |
array of object (fields) | Yes | |
slug |
string | Yes | |
source |
string | Yes | enum: ["manual","template","ai","import","copy"] |
stay |
object or null (fields) | No | Non-null exactly for a place to stay: its one location and stay settings (arrival, departure, guests, minimum nights, who looks after it, what it is and offers, its cancellation policies). Guest-facing house rules are the house_rules detail. Authored photo_rooms and listing accessibility are read-only here and use their stay operations. required: ["location_id","check_in_time","check_in_end_time","check_out_time","max_guests","min_nights","calendar_rules","assigned_member_id","assigned_team_id","photo_rooms","accessibility","questions","questions_revision","property_type_group","property_type","listing_type","total_floors","listing_floor","year_built","property_size","property_size_unit","bedrooms","beds","bathrooms","amenities","amenity_answers","cancellation_policy","long_term_cancellation_policy"] |
tax_code |
string or null | No | |
unit_label |
string or null | No | |
updated_at |
string | Yes | |
variants |
array of object (fields) | Yes |
additionalProperties: false; required: ["id","kind","name","slug","description","active","options","variants","details","publications","locations","collections","source","created_at","updated_at"]
array of object fields
Value: array of object.
Array items: object.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
by_kind |
object (fields) | Yes | additionalProperties: false; required: ["dish","experience","service","stay"] |
total |
integer | Yes | minimum: 0 |
additionalProperties: false; required: ["total","by_kind"]
array of object fields
Value: array of object.
Array items: object.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
featured |
boolean | No | |
kind |
string | Yes | enum: ["dish","experience","service","stay","all"] |
location_id |
string | No | |
organization_id |
string | Yes | |
published_only |
boolean | Yes | |
view |
string | Yes | const: "catalog" |
additionalProperties: false; required: ["view","organization_id","kind","published_only"]
array of object fields
Value: array of object.
maxItems: 200
Array items: object.
array of object fields
Value: array of object.
Array items: object.
array of string fields
Value: array of string.
minItems: 1; uniqueItems: true
Array items: string.
array of string fields
Value: array of string.
uniqueItems: true
Array items: string.
array of object fields
Value: array of object.
Array items: object.
array of object fields
Value: array of object.
Array items: object.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
created |
integer | Yes | |
existing |
integer | Yes | |
skipped |
array of object (fields) | Yes |
additionalProperties: false; required: ["created","existing","skipped"]
array of string fields
Value: array of string.
maxItems: 2000; uniqueItems: true
Array items: string.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
collection_id |
string | Yes | minLength: 1 |
expected_product_ids |
array of string (fields) | Yes | maxItems: 2000; uniqueItems: true |
additionalProperties: false; required: ["collection_id","expected_product_ids"]
array of string fields
Value: array of string.
maxItems: 2000; uniqueItems: true
Array items: string.
See schema fields
Value: See schema.
if: {"required":["move_to"]}; then: {"required":["expected_product_ids"]}
array of object fields
Value: array of object.
maxItems: 20
Array items: object.
object or null fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
assigned_member_id |
string or null | No | Better Auth organization membership ID of the assigned host; null when no individual host is selected. |
assigned_team_id |
string or null | No | Better Auth team ID of the assigned host team; null when no team is selected. |
confirmation_mode |
string | Yes | instant confirms immediately (default); review waits for staff approval. default: "instant"; enum: ["instant","review"] |
default_capacity |
integer or null | Yes | minimum: 0 |
duration_minutes |
integer or null | Yes | minimum: 1 |
held_online |
boolean | Yes | True holds the offering online: its times are its provider's working hours, in the provider's timezone. Requires scheduling_mode provider with an assigned member or team. |
online_payment_required |
boolean | Yes | True requires online payment when booking; false is the default and does not collect online. default: false |
organization_id |
string | No | |
product_id |
string | No | |
questions |
array of object (fields) | Yes | The tenant's own questions asked beside the required booking fields; create_product_booking answers them by ID. maxItems: 20 |
questions_revision |
string | Yes | Send as expected_questions_revision when replacing questions, and as questions_revision when submitting answers. |
scheduling_mode |
string | No | Legal consultations require provider scheduling with an explicitly assigned attorney or legal team. Experiences may use legacy business scheduling without one named provider. Physical provider times also respect the selected member’s availability; online times come from their working hours. enum: ["legacy","provider"] |
required: ["duration_minutes","default_capacity","confirmation_mode","online_payment_required","held_online","questions","questions_revision"]
array of object fields
Value: array of object.
maxItems: 30; minItems: 1
Array items: object.
array of object fields
Value: array of object.
Array items: object.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
allergens |
array of string or null (fields) | No | Allergens the merchant states this dish contains. |
cancellation_policy |
string or null (fields) | No | The merchant’s stated cancellation terms, displayed publicly; this text does not automate refunds. |
carbon_monoxide_detector_details |
string or null (fields) | No | Share where each carbon monoxide alarm is located. |
climbing_structures |
boolean or null | No | Play or climbing structures are available to guests. |
climbing_structures_details |
string or null (fields) | No | Host-authored details about climbing or play structures. Requires its disclosure to be Yes. |
commercial_photography_allowed |
boolean or null | No | Whether guests may take commercial photos or film at the property. |
dangerous_animals |
boolean or null | No | Animals that could cause harm live on or near the property. |
dangerous_animals_details |
string or null (fields) | No | Host-authored details about potentially dangerous animals. Requires its disclosure to be Yes. |
dietary_notes |
array of string or null (fields) | No | Merchant-stated dietary facts displayed with a dish. |
events_allowed |
boolean or null | No | Whether guests may host events at the property. |
exterior_security_cameras |
boolean or null | No | Describe exterior cameras, what they monitor and whether they record audio or video. |
exterior_security_cameras_details |
string or null (fields) | No | Host-authored details about exterior security cameras. Requires its disclosure to be Yes. |
featured |
boolean or null | No | Highlight this item on the menu and homepage. |
getting_around |
string or null (fields) | No | Host-authored transport and getting-around information for this home. |
guest_access |
string or null (fields) | No | The spaces and facilities guests can use during their stay. |
house_rules |
string or null (fields) | No | The host’s rules for guests staying in the home, shown with the listing. |
included_items |
array of string or null (fields) | No | Items or work included in the stated price, shown in their own public section. |
ingredients |
array of string or null (fields) | No | Ingredients shown in the dish details. |
interaction_with_guests |
string or null (fields) | No | How guests can contact the host and what support is available. |
limited_essentials |
boolean or null | No | Tell guests which everyday essentials are unavailable. |
limited_essentials_details |
string or null (fields) | No | Host-authored details about limited essential amenities. Requires its disclosure to be Yes. |
meeting_point |
string or null (fields) | No | Instructions shown in the meeting section; meeting mode and video links are set in scheduling. |
nearby_water |
boolean or null | No | Guests can reach a body of water on or next to the property. |
nearby_water_details |
string or null (fields) | No | Host-authored details about nearby water. Requires its disclosure to be Yes. |
neighborhood_description |
string or null (fields) | No | Host-authored information about the neighborhood around this home. |
no_property_parking |
boolean or null | No | Dedicated guest parking is not available on the property. |
no_property_parking_details |
string or null (fields) | No | Host-authored details about no parking on the property. Requires its disclosure to be Yes. |
noise_decibel_monitors |
boolean or null | No | Devices measure sound levels without recording conversations. |
noise_decibel_monitors_details |
string or null (fields) | No | Host-authored details about noise decibel monitors. Requires its disclosure to be Yes. |
noodle |
array of string or null (fields) | No | Authored noodle information shown as dish facts; these do not establish purchasable variants. |
other_details_to_note |
string or null (fields) | No | Additional information guests should know before booking. |
pets_allowed |
boolean or null | No | Let guests know if they can bring pets. |
potential_noise |
boolean or null | No | Guests may hear traffic, construction or other noise. |
potential_noise_details |
string or null (fields) | No | Host-authored details about potential noise during stays. Requires its disclosure to be Yes. |
preparation |
string or null (fields) | No | Preparation instructions shown to customers before a session or appointment. |
pricing_note |
string or null (fields) | No | An explicitly stated price such as Market price; use only when no numeric price is set. |
quiet_hours |
boolean or null | No | Hours when guests should keep noise to a minimum. |
quiet_hours_end |
string or null (fields) | No | Local end of quiet hours, required with quiet hours and its start time. |
quiet_hours_start |
string or null (fields) | No | Local start of quiet hours, required with quiet hours and its end time. |
resident_pets |
boolean or null | No | Guests may encounter animals that live here. |
resident_pets_details |
string or null (fields) | No | Host-authored details about pets live on the property. Requires its disclosure to be Yes. |
shared_spaces |
boolean or null | No | Guests share some spaces with other people. |
shared_spaces_details |
string or null (fields) | No | Host-authored details about shared spaces. Requires its disclosure to be Yes. |
sizes |
array of string or null (fields) | No | Authored serving information; priced choices belong in variants. |
smoke_detector_details |
string or null (fields) | No | Share where each smoke alarm is located. |
smoking_allowed |
boolean or null | No | Whether guests may smoke or vape at the property. |
soup |
array of string or null (fields) | No | Authored soup information shown with the dish. |
special_safety_considerations |
string or null (fields) | No | Other property features that guests should know could be unsafe, and why. |
stairs_required |
boolean or null | No | Guests need to use stairs during their stay. |
stairs_required_details |
string or null (fields) | No | Host-authored details about guests must climb stairs. Requires its disclosure to be Yes. |
tagline |
string or null (fields) | No | A short sentence shown below the product title. |
toppings |
array of string or null (fields) | No | Authored topping information; priced choices belong in variants. |
unprotected_heights |
boolean or null | No | Elevated areas are accessible without a railing or other protection. |
unprotected_heights_details |
string or null (fields) | No | Host-authored details about unprotected heights. Requires its disclosure to be Yes. |
unsecured_pool |
boolean or null | No | Guests can reach a pool or hot tub without a gate or lock. |
unsecured_pool_details |
string or null (fields) | No | Host-authored details about unsecured pool or hot tub. Requires its disclosure to be Yes. |
weapons_on_property |
boolean or null | No | Tell guests about weapons stored on the property. |
weapons_on_property_details |
string or null (fields) | No | Host-authored details about weapons on the property. Requires its disclosure to be Yes. |
what_to_bring |
array of string or null (fields) | No | Items customers should bring, shown in the preparation section. |
your_property |
string or null (fields) | No | The spaces and features guests should know about this home. |
additionalProperties: false
array of object fields
Value: array of object.
maxItems: 3
Array items: object.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
amenities |
array of string (fields) | No | Amenity codes the home offers; replaces the whole positive list. Empty offers none. uniqueItems: true |
amenity_answers |
array of object (fields) | No | Sparse amenity answer patch: true offers it, false explicitly reports absence, null clears to unknown. Omitted codes remain. Positive-list edits preserve false reports and remove omitted positive reports to unknown. Contradictions between amenities and amenity_answers are refused. |
assigned_member_id |
string or null | No | Host membership ID from list_organization_members → members[].id or get_member_scheduling → members[].id, not userId. This assignment grants the member access to the home’s stays and shows their approved public profile to guests. Publication requires an approved profile with a nonblank public_name; read get_member_public_profile. Clear assigned_team_id when choosing a member. |
assigned_team_id |
string or null | No | Host team ID from list_teams. This assignment grants the team access to the home’s stays and shows its members with approved public profiles to guests. At least one approved profile is required for publication. Clear assigned_member_id when choosing a team. |
bathrooms |
number or null | No | Whole and half baths, such as 1.5. maximum: 50; minimum: 0; multipleOf: 0.5 |
bedrooms |
integer or null | No | Bedrooms; 0 is a studio. maximum: 50; minimum: 0 |
beds |
integer or null | No | maximum: 50; minimum: 1 |
calendar_rules |
object or null (fields) | No | Actual optional listing rules. Null removes them. Dated overrides take precedence over weekday minimums, then the required default. Friday/Saturday use the weekend price when supplied. additionalProperties: false |
cancellation_policy |
string | No | Policy shown to guests for stays under 28 nights. A home always has one: a new home starts on Flexible, as a new Airbnb listing does, and an Airbnb import takes the listing’s own. It does not refund by itself. enum: ["flexible","moderate","limited","firm","strict"] |
check_in_end_time |
string or null | No | Local 24-hour end of the check-in window; null is a flexible end. A time earlier than check_in_time is after midnight. pattern: "^([01]\d|2[0-3]):[0-5]\d$" |
check_in_time |
string | No | Local 24-hour time guests may arrive from, in the location’s timezone. pattern: "^([01]\d|2[0-3]):[0-5]\d$" |
check_out_time |
string | No | Local 24-hour time guests leave by. pattern: "^([01]\d|2[0-3]):[0-5]\d$" |
expected_questions_revision |
string | No | stay.questions_revision from get_product; required with questions. |
listing_floor |
integer or null | No | The listing’s floor, counted from 1. Cannot exceed total_floors when both are known; null when not said. maximum: 9007199254740991; minimum: 1 |
listing_type |
string or null | No | Whether guests book the entire place, a private room or a shared room. Null when not said. enum: ["entire_place","private_room","shared_room",null] |
long_term_cancellation_policy |
string | No | Policy shown to guests for stays of 28 nights or more. A home always has one: a new home starts on Firm Long Term, as a new Airbnb listing does, and an Airbnb import takes the listing’s own. enum: ["firm","strict"] |
max_guests |
integer | No | maximum: 99; minimum: 1 |
min_nights |
integer | No | The listing’s required default minimum; individual arrival dates may override it. maximum: 1125; minimum: 1 |
property_size |
number or null | No | Property area in property_size_unit. Size and unit must both be set or both null. exclusiveMinimum: 0 |
property_size_unit |
string or null | No | The unit of property_size. Size and unit must both be set or both null. enum: ["square_meters","square_feet",null] |
property_type |
string or null | No | Airbnb property type, one the property_type_group offers. Null with property_type_group when not said. enum: ["apartment","condominium","serviced_apartment","loft","house","townhouse","bungalow","cabin","chalet","earthhouse","hut","lighthouse","villa","dome","cottage","farmstay","houseboat","tiny_house","guesthouse","private_suite","boat","castle","cave","igloo","island","plane","rv","tent","tipi","train","treehouse","yurt","other","barn","campsite","windmill","bus","holiday_park","ranch","religious_building","riad","shipping_container","tower","bnb","nature_eco_lodge","boutique_hotel","hostel","aparthotel","hotel","resort",null] |
property_type_group |
string or null | No | Airbnb's property group: apartments (Apartment: apartment, condominium, serviced_apartment, loft); houses (House: house, townhouse, bungalow, cabin, chalet, earthhouse, hut, lighthouse, villa, dome, cottage, farmstay, houseboat, tiny_house); secondary_units (Secondary unit: guesthouse, private_suite, farmstay); unique_homes (Unique space: boat, castle, cave, earthhouse, hut, igloo, island, lighthouse, plane, rv, tent, tipi, train, treehouse, yurt, other, dome, barn, campsite, farmstay, houseboat, tiny_house, windmill, bus, holiday_park, ranch, religious_building, riad, shipping_container, tower); bnb (Bed and breakfast: bnb, nature_eco_lodge, farmstay); boutique_hotels_and_more (Boutique hotel: boutique_hotel, nature_eco_lodge, hostel, serviced_apartment, aparthotel, hotel, resort). Supply property_type with it; both are set or both null. enum: ["apartments","houses","secondary_units","unique_homes","bnb","boutique_hotels_and_more",null] |
questions |
array of object (fields) | No | Replace the questions asked with each direct stay booking. Read get_product first and keep existing question IDs. maxItems: 20 |
total_floors |
integer or null | No | Total floors in the property; null when not said. maximum: 9007199254740991; minimum: 1 |
year_built |
integer or null | No | Year the property was built; null when not said. maximum: 9007199254740991; minimum: 1 |
additionalProperties: false
array of object fields
Value: array of object.
maxItems: 250; minItems: 1
Array items: object.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
active |
boolean | Yes | The merchant sale switch. Not visibility and not stock: a disabled product is not sold out. |
admin_edit_url |
string or null | No | The dashboard editor for this product, on the platform host. |
booking |
object or null (fields) | No | required: ["duration_minutes","default_capacity","confirmation_mode","online_payment_required","held_online","questions","questions_revision"] |
booking_readiness |
object or null (fields) | No | required: ["ready","missing"] |
channel_push |
object or null (fields) | Yes | |
collections |
array of object (fields) | Yes | |
created_at |
string | Yes | |
description |
string | Yes | |
details |
object (fields) | Yes | additionalProperties: false |
gallery |
array of object (fields) | No | |
id |
string | Yes | |
image |
object or null (fields) | No | required: ["asset_id","kind","public_url","status"] |
kind |
string | Yes | enum: ["dish","experience","service","stay"] |
locations |
array of object (fields) | Yes | |
marketing_features |
array of string (fields) | No | |
metadata |
object | No | additionalProperties: {"type":"string"} |
name |
string | Yes | |
options |
array of object (fields) | Yes | |
order_url |
string or null | No | |
page |
object or null (fields) | No | The source page this product owns, or null. Edit its content with the site-page tools; its binding is the page's product_id. required: ["id","path","title"] |
public_url |
string or null | No | |
publications |
array of object (fields) | Yes | |
slug |
string | Yes | |
source |
string | Yes | enum: ["manual","template","ai","import","copy"] |
stay |
object or null (fields) | No | Non-null exactly for a place to stay: its one location and stay settings (arrival, departure, guests, minimum nights, who looks after it, what it is and offers, its cancellation policies). Guest-facing house rules are the house_rules detail. Authored photo_rooms and listing accessibility are read-only here and use their stay operations. required: ["location_id","check_in_time","check_in_end_time","check_out_time","max_guests","min_nights","calendar_rules","assigned_member_id","assigned_team_id","photo_rooms","accessibility","questions","questions_revision","property_type_group","property_type","listing_type","total_floors","listing_floor","year_built","property_size","property_size_unit","bedrooms","beds","bathrooms","amenities","amenity_answers","cancellation_policy","long_term_cancellation_policy"] |
tax_code |
string or null | No | |
unit_label |
string or null | No | |
updated_at |
string | Yes | |
variants |
array of object (fields) | Yes |
additionalProperties: false; required: ["id","kind","name","slug","description","active","options","variants","details","publications","locations","collections","source","created_at","updated_at","channel_push"]
object or null fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
member_id |
string | Yes | |
public_approved |
integer | Yes | 1 approves this authored profile for display as a host on public offerings; 0 withholds it. enum: [0,1] |
public_bio |
string or null | Yes | |
public_name |
string or null | Yes | |
public_photo_url |
string or null | Yes | |
updated_at |
string | Yes |
additionalProperties: false; required: ["member_id","updated_at","public_name","public_photo_url","public_bio","public_approved"]
array of object fields
Value: array of object.
Array items: object.
object or null fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
busy_checked_at |
string or null | Yes | |
busy_error |
string or null | Yes | |
busy_from |
string or null | Yes | |
busy_until |
string or null | Yes | |
calendar_account_id |
string or null | Yes | |
calendar_conflict_count |
integer | Yes | |
calendar_conflicts |
array of object (fields) | Yes | |
calendar_ids |
array of string (fields) | Yes | |
calendar_status |
string | Yes | enum: ["internal","disconnected","error","stale","ready"] |
member_id |
string | Yes | |
time_off |
array or null (fields) | Yes | |
timezone |
string or null | Yes | |
updated_at |
string | Yes | |
weekly |
array or null (fields) | Yes |
additionalProperties: false; required: ["member_id","timezone","updated_at","weekly","time_off","calendar_account_id","calendar_ids","calendar_status","busy_from","busy_until","busy_checked_at","busy_error","calendar_conflict_count","calendar_conflicts"]
See schema fields
Value: See schema.
required: ["scheduling"]
See schema fields
Value: See schema.
required: ["members"]
array of string fields
Value: array of string.
maxItems: 10; uniqueItems: true
Array items: string.
See schema fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
account_id |
string | No | minLength: 1 |
See schema fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
account_id |
null | No | |
calendar_ids |
See schema | No | maxItems: 0 |
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
calendar_account_id |
string or null | Yes | |
calendar_conflict_count |
integer | Yes | |
calendar_ids |
array of string (fields) | Yes | |
calendar_status |
string | Yes | enum: ["internal","disconnected","error","stale","ready"] |
member_id |
string | Yes | |
updated_at |
string | Yes |
additionalProperties: false; required: ["member_id","updated_at","calendar_account_id","calendar_ids","calendar_status","calendar_conflict_count"]
array of object fields
Value: array of object.
maxItems: 100
Array items: object.
array of object fields
Value: array of object.
maxItems: 28
Array items: object.
See schema fields
Value: See schema.
required: ["timezone"]
See schema fields
Value: See schema.
required: ["weekly"]
See schema fields
Value: See schema.
required: ["time_off"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
member_id |
string | Yes | |
time_off |
array or null (fields) | Yes | |
timezone |
string or null | Yes | |
updated_at |
string | Yes | |
weekly |
array or null (fields) | Yes |
additionalProperties: false; required: ["member_id","updated_at","timezone","weekly","time_off"]
See schema fields
Value: See schema.
required: ["public_name"]
See schema fields
Value: See schema.
required: ["public_photo_url"]
See schema fields
Value: See schema.
required: ["public_bio"]
See schema fields
Value: See schema.
required: ["public_approved"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
member_id |
string | Yes | |
public_approved |
integer | Yes | 1 approves this authored profile for display as a host on public offerings; 0 withholds it. enum: [0,1] |
public_bio |
string or null | Yes | |
public_name |
string or null | Yes | |
public_photo_url |
string or null | Yes | |
updated_at |
string | Yes |
additionalProperties: false; required: ["member_id","updated_at","public_name","public_photo_url","public_bio","public_approved"]
See schema fields
Value: See schema.
not: {"properties":{"location_id":{"type":"string"},"page_path":{"type":"string"}},"required":["location_id","page_path"]}
array of object fields
Value: array of object.
Array items: object.
array of object fields
Value: array of object.
minItems: 1
Array items: object.
See schema fields
Value: See schema.
required: ["question"]
See schema fields
Value: See schema.
required: ["answer"]
See schema fields
Value: See schema.
required: ["question_author"]
See schema fields
Value: See schema.
required: ["is_owner_answer"]
See schema fields
Value: See schema.
required: ["sort_order"]
array of object fields
Value: array of object.
Array items: object.
array of object fields
Value: array of object.
maxItems: 50; minItems: 1
Array items: object.
See schema fields
Value: See schema.
not: {"required":["new_room_type"]}; required: ["room_id"]
See schema fields
Value: See schema.
not: {"required":["room_id"]}; required: ["new_room_type"]
array of string fields
Value: array of string.
minItems: 1; uniqueItems: true
Array items: string.
object or null fields
Value: object or null.
anyOf: shape 1, shape 2, shape 3.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
cancellation_reason |
string or null | Yes | |
cancelled_at |
string or null | Yes | |
check_in_date |
string | Yes | pattern: "^\d{4}-\d{2}-\d{2}$" |
check_out_date |
string | Yes | pattern: "^\d{4}-\d{2}-\d{2}$" |
id |
string | Yes | minLength: 1 |
product_id |
string | Yes | minLength: 1 |
request_id |
string or null | Yes | |
status |
string | Yes | enum: ["pending","confirmed","cancelled"] |
updated_at |
string | Yes | minLength: 1 |
version |
integer | Yes |
additionalProperties: false; required: ["id","product_id","request_id","status","version","updated_at","check_in_date","check_out_date","cancelled_at","cancellation_reason"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
details_version |
integer | Yes | Revision of this room’s details. minimum: 1 |
id |
string | Yes | minLength: 1 |
photo_ids |
array of string (fields) | Yes | uniqueItems: true |
type |
string | Yes | enum: ["art_studio","backyard","balcony","bedroom","bowling_alley","childrens_playroom","courtyard","darkroom","deck","dining_area","event_room","exterior","front_yard","full_bathroom","full_kitchen","game_room","garage","garden","gym","half_bathroom","hot_tub","kitchenette","laundry_area","library","living_room","movie_theater","music_studio","office","patio","photography_studio","pool","porch","rooftop","sunroom","terrace","theme_room","wine_cellar","woodshop","workshop","workspace"] |
additionalProperties: false; required: ["id","type","photo_ids","details_version"]
array of object fields
Value: array of object.
maxItems: 20
Array items: object.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
check_in_date |
string | Yes | pattern: "^\d{4}-\d{2}-\d{2}$" |
check_out_date |
string | Yes | pattern: "^\d{4}-\d{2}-\d{2}$" |
id |
string | Yes | minLength: 1 |
product_id |
string | Yes | minLength: 1 |
request_id |
string or null | Yes | |
status |
string | Yes | enum: ["pending","confirmed","cancelled"] |
updated_at |
string | Yes | minLength: 1 |
version |
integer | Yes |
additionalProperties: false; required: ["id","product_id","request_id","status","version","updated_at","check_in_date","check_out_date"]
array of object fields
Value: array of object.
Array items: object.
object fields
Value: object.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
base_price_minor |
integer or null | Yes | |
base_price_tax_behavior |
string or null | Yes | enum: ["unspecified","inclusive","exclusive",null] |
calendar_rules |
object or null (fields) | Yes | Actual optional listing rules. Null removes them. Dated overrides take precedence over weekday minimums, then the required default. Friday/Saturday use the weekend price when supplied. additionalProperties: false |
channel |
object or null (fields) | Yes | The channel this home is connected to; null when it is kept only in KrabiClaw and its night changes go nowhere else. required: ["provider","status"] |
check_in_end_time |
string or null | Yes | The end of the check-in window, local HH:MM; null is a flexible end. |
check_in_time |
string | Yes | minLength: 1 |
check_out_time |
string | Yes | minLength: 1 |
currency |
string | Yes | minLength: 1 |
location_id |
string | Yes | minLength: 1 |
max_guests |
integer | Yes | |
min_nights |
integer | Yes | |
name |
string | Yes | minLength: 1 |
product_id |
string | Yes | minLength: 1 |
timezone |
string | Yes | minLength: 1 |
additionalProperties: false; required: ["product_id","name","location_id","timezone","currency","base_price_minor","base_price_tax_behavior","check_in_time","check_in_end_time","check_out_time","max_guests","min_nights","calendar_rules","channel"]
array of object fields
Value: array of object.
Array items: object.
array of object fields
Value: array of object.
Array items: object.
array of object fields
Value: array of object.
Array items: object.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
amount_minor |
integer | Yes | |
created_at |
string | Yes | minLength: 1 |
currency |
string | Yes | minLength: 1 |
id |
string | Yes | minLength: 1 |
method |
string | Yes | enum: ["cash","bank_transfer","card_external","other"] |
note |
string or null | Yes | |
paid_on |
string | Yes | pattern: "^\d{4}-\d{2}-\d{2}$" |
reference |
string or null | Yes | |
stay_id |
string | Yes | minLength: 1 |
additionalProperties: false; required: ["id","stay_id","amount_minor","currency","method","paid_on","reference","note","created_at"]
array of integer fields
Value: array of integer.
maxItems: 7; minItems: 1; uniqueItems: true
Array items: integer.
See schema fields
Value: See schema.
not: {"required":["price_minor","price_change_percent"]}
See schema fields
Value: See schema.
not: {"properties":{"reset":{"const":true}},"required":["reset","price_change_percent"]}
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
available |
boolean or null | Yes | The host’s answer, without a review or approval status. Null clears the answer to unknown. |
feature |
string | Yes | enum: ["disabled_parking_spot","path_to_entrance_lit_at_night","home_step_free_access","home_wide_doorway","pool_hoist","ceiling_hoist"] |
photo_ids |
array of string (fields) | Yes | Same-organization active image asset IDs in canonical Product photo order. A true answer needs evidence; false/null requires []. Save appends selected library images to Product photos atomically, preserving existing cover/order without assigning a tour room. maxItems: 50; uniqueItems: true |
additionalProperties: false; required: ["feature","available","photo_ids"]
array of object fields
Value: array of object.
maxItems: 6; minItems: 6
Array items: object.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
available |
boolean or null | Yes | The host’s answer, without a review or approval status. Null clears the answer to unknown. |
feature |
string | Yes | enum: ["step_free_access","wide_doorway"] |
photo_ids |
array of string (fields) | Yes | Same-organization active image asset IDs in canonical Product photo order. A true answer needs evidence; false/null requires []. Save appends selected library images to Product photos atomically, preserving existing cover/order without assigning a tour room. maxItems: 50; uniqueItems: true |
additionalProperties: false; required: ["feature","available","photo_ids"]
array of string fields
Value: array of string.
uniqueItems: true
Array items: string.
array or null fields
Value: array or null.
maxItems: 14
Array items: object.
See schema fields
Value: See schema.
required: ["sleeping_arrangements"]
See schema fields
Value: See schema.
required: ["private_attached_bathroom"]
See schema fields
Value: See schema.
required: ["amenities"]
See schema fields
Value: See schema.
required: ["accessibility"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
accessibility |
array of object (fields) | Yes | Both bedroom features in catalog order, including unanswered null rows; [] for other room types. maxItems: 2 |
amenities |
array of string (fields) | Yes | Amenities assigned to this room, each once. uniqueItems: true |
details_version |
integer | Yes | Revision of this room’s details. minimum: 1 |
id |
string | Yes | minLength: 1 |
photo_ids |
array of string (fields) | Yes | uniqueItems: true |
private_attached_bathroom |
boolean or null | Yes | Whether this bedroom has a private attached bathroom. Null is unanswered. Only bedrooms may author this fact. |
sleeping_arrangements |
array or null (fields) | Yes | This room’s allocated beds. Null is unanswered; [] explicitly states none. maxItems: 14 |
type |
string | Yes | enum: ["art_studio","backyard","balcony","bedroom","bowling_alley","childrens_playroom","courtyard","darkroom","deck","dining_area","event_room","exterior","front_yard","full_bathroom","full_kitchen","game_room","garage","garden","gym","half_bathroom","hot_tub","kitchenette","laundry_area","library","living_room","movie_theater","music_studio","office","patio","photography_studio","pool","porch","rooftop","sunroom","terrace","theme_room","wine_cellar","woodshop","workshop","workspace"] |
additionalProperties: false; required: ["id","type","photo_ids","details_version","sleeping_arrangements","private_attached_bathroom","amenities","accessibility"]
See schema fields
Value: See schema.
required: ["check_in_date"]
See schema fields
Value: See schema.
required: ["check_out_date"]
See schema fields
Value: See schema.
required: ["arrival_time"]
See schema fields
Value: See schema.
required: ["adults"]
See schema fields
Value: See schema.
required: ["children"]
See schema fields
Value: See schema.
required: ["infants"]
See schema fields
Value: See schema.
required: ["guest_name"]
See schema fields
Value: See schema.
required: ["guest_surname"]
See schema fields
Value: See schema.
required: ["guest_email"]
See schema fields
Value: See schema.
required: ["guest_phone"]
See schema fields
Value: See schema.
required: ["total_minor"]
See schema fields
Value: See schema.
required: ["notes"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
adults |
integer | No | |
arrival_time |
string or null | No | pattern: "^([01]\d|2[0-3]):[0-5]\d$" |
check_in_date |
string | No | pattern: "^\d{4}-\d{2}-\d{2}$" |
check_out_date |
string | No | pattern: "^\d{4}-\d{2}-\d{2}$" |
children |
integer | No | |
guest_email |
string or null | No | |
guest_name |
string or null | No | |
guest_phone |
string or null | No | |
guest_surname |
string or null | No | |
infants |
integer | No | |
notes |
string or null | No | |
total_minor |
integer | No |
additionalProperties: false; minProperties: 1
array of object fields
Value: array of object.
maxItems: 20
Array items: object.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
answers |
array of object (fields) | Yes | Answers to the tenant's own questions, with the wording the guest answered. Later edits to the questions do not change them. |
archived |
boolean | Yes | |
entries |
array of object (fields) | Yes | |
guest |
object (fields) | Yes | required: ["name","email","phone"] |
operational_record |
object or null (fields) | Yes | For a stay, check_in_date and check_out_date are its nights and id is the stay for get_stay; its starts_at and ends_at only order and archive the conversation. required: ["id","kind","status","starts_at","ends_at","timezone","party_size","check_in_date","check_out_date"] |
participant_label |
string | Yes | |
reply_channel |
string | Yes | enum: ["email","airbnb"] |
request_id |
string | Yes | |
state |
string or null | Yes | |
type |
string | Yes | enum: ["contact","reservation","booking","stay"] |
updated_at |
string | Yes |
required: ["request_id","type","state","archived","updated_at","participant_label","reply_channel","guest","answers","operational_record","entries"]
array of object fields
Value: array of object.
Array items: object.
array of object fields
Value: array of object.
Array items: object.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
by_status |
object | Yes | Count of reservations per status. |
total |
number | Yes |
required: ["total","by_status"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
download_url |
string | Yes | |
file_id |
string | Yes | |
file_name |
string | No | |
mime_type |
string | No |
required: ["download_url","file_id"]
See schema fields
Value: See schema.
required: ["message"]
See schema fields
Value: See schema.
required: ["file"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
archived |
boolean | Yes | |
request_id |
string | Yes | |
state |
string or null | Yes | |
updated_at |
string | Yes |
additionalProperties: false; required: ["request_id","state","archived","updated_at"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
ok |
boolean | Yes | const: true |
required: ["ok"]
array of object fields
Value: array of object.
Array items: object.
array of object fields
Value: array of object.
Array items: object.
array of object fields
Value: array of object.
Array items: object.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
download_url |
string | Yes | |
file_id |
string | Yes | |
file_name |
string | No | |
mime_type |
string | No |
required: ["download_url","file_id"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
attachments |
array of object (fields) | Yes | |
body |
string | Yes | |
createdAt |
string | Yes | |
deliveries |
array of object (fields) | Yes | |
id |
string | Yes | |
senderId |
string or null | Yes | |
threadId |
string | Yes |
required: ["id","threadId","senderId","body","createdAt","attachments","deliveries"]
array of string fields
Value: array of string.
maxItems: 49; minItems: 1; uniqueItems: true
Array items: string.
array of string fields
Value: array of string.
maxItems: 49; minItems: 1; uniqueItems: true
Array items: string.
See schema fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
action |
string | No | const: "rename" |
required: ["name"]
See schema fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
action |
string | No | const: "add" |
required: ["member_user_ids"]
See schema fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
action |
string | No | const: "remove" |
required: ["user_id"]
See schema fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
action |
string | No | const: "leave" |
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
campaign |
string or null | Yes | |
collectedMinor |
number | Yes | |
content |
string or null | Yes | |
currency |
string | Yes | |
medium |
string or null | Yes | |
netMinor |
number | Yes | |
purchases |
integer | Yes | maximum: 9007199254740991; minimum: 0 |
refundedMinor |
number | Yes | |
source |
string or null | Yes |
additionalProperties: false; required: ["source","medium","campaign","content","currency","collectedMinor","refundedMinor","netMinor","purchases"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
campaign |
string or null | Yes | |
content |
string or null | Yes | |
convertingSessions |
integer | Yes | maximum: 9007199254740991; minimum: 0 |
medium |
string | Yes | |
outcomeEvents |
integer | Yes | maximum: 9007199254740991; minimum: 0 |
sessionConversionRate |
number or null | Yes | |
sessions |
integer | Yes | maximum: 9007199254740991; minimum: 0 |
source |
string | Yes |
additionalProperties: false; required: ["source","medium","campaign","content","sessions","outcomeEvents","convertingSessions","sessionConversionRate"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
bookings |
integer | Yes | maximum: 9007199254740991; minimum: 0 |
currency |
string or null | Yes | |
locationId |
string or null | Yes | |
productId |
string or null | Yes | |
productName |
string or null | Yes | |
quotedValueMinor |
number | Yes | |
valuedBookings |
integer | Yes | maximum: 9007199254740991; minimum: 0 |
additionalProperties: false; required: ["productId","productName","locationId","currency","bookings","valuedBookings","quotedValueMinor"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
city |
string | Yes | |
countryCode |
string | Yes | |
region |
string or null | Yes | |
views |
integer | Yes | maximum: 9007199254740991; minimum: 0 |
additionalProperties: false; required: ["city","region","countryCode","views"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
conversionType |
string or null | Yes | |
convertingSessions |
integer | Yes | maximum: 9007199254740991; minimum: 0 |
distinctEntities |
integer | Yes | maximum: 9007199254740991; minimum: 0 |
eventName |
string | Yes | |
events |
integer | Yes | maximum: 9007199254740991; minimum: 0 |
nonbrowserEvents |
integer | Yes | maximum: 9007199254740991; minimum: 0 |
sessionConversionRate |
number or null | Yes | |
stage |
string | Yes |
additionalProperties: false; required: ["eventName","stage","conversionType","events","distinctEntities","convertingSessions","nonbrowserEvents","sessionConversionRate"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
country |
string | Yes | |
countryCode |
string | Yes | |
percentOfTotal |
number | Yes | |
views |
integer | Yes | maximum: 9007199254740991; minimum: 0 |
additionalProperties: false; required: ["country","countryCode","views","percentOfTotal"]
array of object fields
Value: array of object.
Array items: object.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
date |
string | Yes | |
events |
integer | Yes | maximum: 9007199254740991; minimum: 0 |
additionalProperties: false; required: ["date","events"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
avgDuration |
number | Yes | minimum: 0 |
date |
string | Yes | |
pageViews |
integer | Yes | maximum: 9007199254740991; minimum: 0 |
sessions |
integer | Yes | maximum: 9007199254740991; minimum: 0 |
additionalProperties: false; required: ["date","pageViews","sessions","avgDuration"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
percentOfTotal |
number | Yes | |
type |
string | Yes | |
views |
integer | Yes | maximum: 9007199254740991; minimum: 0 |
additionalProperties: false; required: ["type","views","percentOfTotal"]
array of object fields
Value: array of object.
Array items: object.
array of object fields
Value: array of object.
Array items: object.
array of object fields
Value: array of object.
Array items: object.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
collectedMinor |
number | Yes | |
currency |
string | Yes | |
netMinor |
number | Yes | |
refundedMinor |
number | Yes |
additionalProperties: false; required: ["currency","collectedMinor","refundedMinor","netMinor"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
campaign |
string or null | Yes | |
content |
string or null | Yes | |
distinctEntities |
integer | Yes | maximum: 9007199254740991; minimum: 0 |
eventName |
string | Yes | |
events |
integer | Yes | maximum: 9007199254740991; minimum: 0 |
medium |
string | Yes | |
source |
string | Yes |
additionalProperties: false; required: ["source","medium","campaign","content","eventName","events","distinctEntities"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
percentOfTotal |
number | Yes | |
source |
string | Yes | |
views |
integer | Yes | maximum: 9007199254740991; minimum: 0 |
additionalProperties: false; required: ["source","views","percentOfTotal"]
array of object fields
Value: array of object.
Array items: object.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
path |
string | Yes | |
percentOfTotal |
number | Yes | |
views |
integer | Yes | maximum: 9007199254740991; minimum: 0 |
additionalProperties: false; required: ["path","views","percentOfTotal"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
basis |
string | Yes | enum: ["quoted","purchase","refund"] |
collectedMinor |
number or null | Yes | |
currency |
string | Yes | |
eventName |
string | Yes | |
events |
integer | Yes | maximum: 9007199254740991; minimum: 0 |
valueMinor |
number | Yes |
additionalProperties: false; required: ["eventName","basis","currency","events","valueMinor","collectedMinor"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
end_date |
string | Yes | pattern: "^\d{4}-\d{2}-\d{2}$" |
name |
string | No | Names the range in the dateRange dimension GA4 adds when there is more than one. maxLength: 40 |
start_date |
string | Yes | pattern: "^\d{4}-\d{2}-\d{2}$" |
additionalProperties: false; required: ["start_date","end_date"]
string fields
Value: string.
pattern: "^[A-Za-z0-9_:]+$"
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
dimension |
string | Yes | pattern: "^[A-Za-z0-9_:]+$" |
match |
string | Yes | enum: ["EXACT","BEGINS_WITH","ENDS_WITH","CONTAINS","FULL_REGEXP"] |
value |
string | Yes | maxLength: 500 |
additionalProperties: false; required: ["dimension","match","value"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
dimensions |
object | Yes | additionalProperties: {"type":"string"} |
metrics |
object | Yes | additionalProperties: {"type":"number"} |
required: ["dimensions","metrics"]
string fields
Value: string.
enum: ["kind","event_name","stage","surface","page_path","source_path","page_id","page_type","product_id","variant_id","location_id","locale","entity_type","entity_id","session_id","visitor_id","device","country","region","city","currency","value_basis","conversion_type","attribution_basis","actor_id","member_id","tenant_organization_id","ga4_delivery_status","source","medium","campaign","content","term","referrer_host","gclid","gbraid","wbraid","fbclid","msclkid"]
string fields
Value: string.
enum: ["events","page_views","interactions","outcomes","sessions","visitors","entities","quoted_value_minor","purchase_value_minor","collected_minor","refunded_minor","net_collected_minor","converting_sessions","eligible_sessions","session_conversion_rate","checkouts_started","payments_paid","refunds_sent","checkout_conversion_rate","refund_rate","payments_volume_minor","avg_decision_seconds"]
string fields
Value: string.
enum: ["occurred_at_desc","occurred_at_asc"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
direction |
string | No | enum: ["asc","desc"] |
metric |
string | No |
additionalProperties: false
object fields
Value: object.
string fields
Value: string.
enum: ["query","page","country","device","date","searchAppearance"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
dimension |
string | Yes | enum: ["query","page","country","device","searchAppearance"] |
expression |
string | Yes | maxLength: 4096 |
operator |
string | Yes | enum: ["equals","notEquals","contains","notContains","includingRegex","excludingRegex"] |
additionalProperties: false; required: ["dimension","operator","expression"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
clicks |
number | Yes | |
ctr |
number | Yes | Clicks per impression, 0 to 1. |
impressions |
number | Yes | |
keys |
object | Yes | additionalProperties: {"type":"string"} |
position |
number | Yes | Average position, 1 is the top. |
required: ["keys","clicks","impressions","ctr","position"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
data |
#/$defs/content_heading or #/$defs/content_markdown or #/$defs/content_image or #/$defs/content_gallery or #/$defs/content_video or #/$defs/content_faq or #/$defs/content_how_to or #/$defs/content_divider or #/$defs/content_ai_assistance or #/$defs/content_cta or #/$defs/content_callout (fields) | Yes | |
id |
string | No | |
level |
number or null | No | |
media |
array of #/$defs/content_block_media (fields) | No | Required on image blocks: one item, the picture. A block read back keeps its media by sending it as read. |
parent_block_id |
string or null | No | |
source_block_id |
string or null | No | |
type |
string | Yes | enum: ["heading","markdown","image","gallery","video","faq","how_to","divider","ai_assistance","cta","callout"] |
updated_at |
string or null | No | As read. Ignored on a whole-document write. |
additionalProperties: false; required: ["type","data"]
anyOf: shape 1, shape 2, shape 3, shape 4, shape 5, shape 6, shape 7, shape 8, shape 9, shape 10, shape 11.
object or null fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
id |
string | Yes | |
name |
string | Yes | |
slug |
string | Yes |
additionalProperties: false; required: ["id","name","slug"]
array of object fields
Value: array of object.
Array items: object.
object or null fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
alt_text |
string or null | Yes | |
asset_id |
string | Yes | |
height |
number or null | Yes | |
kind |
string or null | Yes | |
public_url |
string or null | Yes | |
thumbnail_url |
string or null | Yes | |
width |
number or null | Yes |
additionalProperties: false; required: ["asset_id","public_url","thumbnail_url","kind","alt_text","width","height"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
admin_edit_url |
string or null | Yes | |
category |
object or null (fields) | Yes | additionalProperties: false; required: ["id","name","slug"] |
collection |
string | Yes | enum: ["blog","docs"] |
cover |
object or null (fields) | Yes | additionalProperties: false; required: ["asset_id","public_url","thumbnail_url","kind","alt_text","width","height"] |
created_at |
string | Yes | |
edit_url |
string or null | Yes | |
excerpt |
string or null | Yes | |
id |
string | Yes | |
preview_url |
string or null | Yes | |
public_path |
string or null | Yes | |
public_url |
string or null | Yes | |
published |
boolean | Yes | |
published_at |
string or null | Yes | |
seo_keywords |
string or null | Yes | |
slug |
string | Yes | |
sort_order |
integer | Yes | |
status |
string | Yes | enum: ["draft","published"] |
title |
string | Yes | |
updated_at |
string | Yes | |
view_url |
string or null | Yes | |
visibility |
string | Yes | enum: ["listed","unlisted"] |
additionalProperties: false; required: ["id","title","slug","excerpt","collection","category","sort_order","seo_keywords","published","published_at","status","visibility","created_at","updated_at","cover","admin_edit_url","edit_url","public_path","public_url","preview_url","view_url"]
string fields
Value: string.
string fields
Value: string.
minLength: 1
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
question_id |
string | Yes | |
value |
string or array of string or boolean (fields) | Yes |
additionalProperties: false; required: ["question_id","value"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
help_text |
string or null | Yes | |
label |
string | Yes | |
question_id |
string | Yes | |
selected_choices |
array of object (fields) | Yes | |
type |
string | Yes | enum: ["short_text","long_text","single_choice","multiple_choice","yes_no"] |
value |
string or array of string or boolean (fields) | Yes | Text, the selected choice ID, the selected choice IDs, or true/false for yes/no. |
additionalProperties: false; required: ["question_id","label","type","help_text","value","selected_choices"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
assigned_member_id |
string or null | Yes | |
ends_at |
string | Yes | minLength: 1 |
guest |
object or null (fields) | Yes | additionalProperties: false; required: ["name"] |
is_complete |
boolean | Yes | |
location_id |
string or null | Yes | |
operational_booking_id |
string | Yes | minLength: 1 |
party_size |
integer | Yes | |
product_id |
string | Yes | minLength: 1 |
product_session_id |
string | Yes | minLength: 1 |
product_variant_id |
string or null | Yes | |
provenance |
object or null (fields) | Yes | required: ["source","external_reference","guest_acknowledgement"] |
request_id |
string or null | Yes | |
starts_at |
string | Yes | minLength: 1 |
status |
string | Yes | enum: ["pending","confirmed","cancelled"] |
timezone |
string | Yes | minLength: 1 |
updated_at |
string | Yes | minLength: 1 |
required: ["operational_booking_id","request_id","product_id","product_variant_id","product_session_id","status","is_complete","party_size","updated_at","assigned_member_id","location_id","starts_at","ends_at","timezone","guest","provenance"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
text |
string | Yes |
additionalProperties: false; required: ["text"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
editor_mode |
string | Yes | enum: ["rich","source"] |
markdown |
string | Yes | Markdown. |
title |
string or null | No |
additionalProperties: false; required: ["markdown","editor_mode"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
caption |
string or null | No |
additionalProperties: false; required: []
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
caption |
string or null | No |
additionalProperties: false; required: []
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
caption |
string or null | No | |
title |
string | Yes | |
upload_date |
string or null | No | |
url |
string | Yes |
additionalProperties: false; required: ["url","title"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
source |
string | Yes | enum: ["page_qa","organization_qa"] |
title |
string or null | No |
additionalProperties: false; required: ["source"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
description |
string or null | No | |
estimated_time |
string or null | No | |
label |
string or null | No | |
steps |
array of object (fields) | Yes | minItems: 1 |
supply_items |
array of string (fields) | No | |
title |
string or null | No | |
tool_items |
array of string (fields) | No |
additionalProperties: false; required: ["steps"]
object fields
Value: object.
additionalProperties: false; required: []
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
accent |
string or null | No | |
description |
string or null | No | |
label |
string or null | No | |
layout |
string or null | No | enum: ["centered","compact",null] |
secondary_label |
string or null | No | |
secondary_url |
string or null | No | |
title |
string or null | No | |
url |
string or null | No |
additionalProperties: false; required: []
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
accent |
string or null | No | |
description |
string or null | No | |
label |
string or null | No | |
layout |
string or null | No | enum: ["centered","compact",null] |
secondary_label |
string or null | No | |
secondary_url |
string or null | No | |
title |
string or null | No | |
url |
string or null | No |
additionalProperties: false; required: []
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
accent |
string or null | No | |
description |
string or null | No | |
label |
string or null | No | |
layout |
string or null | No | enum: ["centered","compact",null] |
notice |
string or null | No | |
price_line |
string or null | No | |
secondary_label |
string or null | No | |
secondary_url |
string or null | No | |
title |
string or null | No | |
url |
string or null | No |
additionalProperties: false; required: []
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
badge |
string or null | No | |
body |
string or null | No | |
buttons |
array of object (fields) | No | |
items |
array of object (fields) | No | |
title |
string or null | No | |
tone |
string or null | No | enum: ["neutral","info","success","warning","danger",null] |
additionalProperties: false; required: []
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
accent |
string or null | No | |
caption |
string or null | No | |
cta_label |
string or null | No | |
cta_url |
string or null | No | |
eyebrow |
string or null | No | |
image_position |
string or null | No | enum: ["top","center","bottom",null] |
image_ratio |
string or null | No | enum: ["original","portrait","square","landscape",null] |
rotating_accents |
array of string (fields) | No | |
secondary_label |
string or null | No | |
secondary_url |
string or null | No | |
subtitle |
string or null | No | |
title |
string | Yes |
additionalProperties: false; required: ["title"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
buttons |
array of object (fields) | No | |
layout |
string or null | No | enum: ["buttons","links",null] |
additionalProperties: false; required: []
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
calculator |
object (fields) | No | |
cta_label |
string or null | No | |
cta_url |
string or null | No | |
description |
string or null | No | |
eyebrow |
string or null | No | |
items |
array of object (fields) | No | |
layout |
string or null | No | enum: ["cards","pictures","columns","strip",null] |
limit |
integer | No | minimum: 1 |
source |
string or null | No | enum: ["manual","organization_posts","calculator","billing_plans","billing_features",null] |
title |
string or null | No | |
title_muted |
string or null | No |
additionalProperties: false; required: []
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
description |
string or null | No | |
problem_items |
array of object (fields) | No | |
problem_label |
string or null | No | |
problem_title |
string or null | No | |
solution_items |
array of object (fields) | No | |
solution_label |
string or null | No | |
solution_title |
string or null | No | |
title |
string or null | No |
additionalProperties: false; required: []
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
description |
string or null | No | |
items |
array of object (fields) | No | |
label |
string or null | No | |
title |
string or null | No |
additionalProperties: false; required: []
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
cta_label |
string or null | No | |
cta_url |
string or null | No | |
description |
string or null | No | |
items |
array of object (fields) | No | |
label |
string or null | No | |
prompt_heading |
string or null | No | |
title |
string or null | No |
additionalProperties: false; required: []
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
items |
array of object (fields) | No |
additionalProperties: false; required: []
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
description |
string or null | No | |
items |
array of object (fields) | No | |
pin_label |
string or null | No | |
subtitle |
string or null | No | |
title |
string or null | No |
additionalProperties: false; required: []
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
cta_label |
string or null | No | |
cta_url |
string or null | No | |
items |
array of object (fields) | No | |
title |
string or null | No |
additionalProperties: false; required: []
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
description |
string or null | No | |
items |
array of object (fields) | No | |
title |
string or null | No | |
upload_date |
string or null | No | |
video_title |
string or null | No | |
video_url |
string or null | No |
additionalProperties: false; required: []
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
body |
string or null | No | |
caption |
string or null | No | |
example_type |
string or null | No | enum: ["websites","posts","app_screens",null] |
eyebrow |
string or null | No | |
image_position |
string or null | No | enum: ["top","center","bottom",null] |
image_ratio |
string or null | No | enum: ["original","portrait","square","landscape",null] |
items |
array of object (fields) | No | |
label |
string or null | No | |
layout |
string or null | No | enum: ["standard","editorial",null] |
title |
string or null | No | |
tone |
string or null | No | enum: ["light","dark",null] |
url |
string or null | No |
additionalProperties: false; required: []
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
booking_label |
string or null | No | |
booking_product_id |
string or null | No | |
description |
string or null | No | |
title |
string or null | No |
additionalProperties: false; required: []
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
description |
string or null | No | |
items |
array of object (fields) | No | |
title |
string or null | No |
additionalProperties: false; required: []
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
description |
string or null | No | |
title |
string or null | No |
additionalProperties: false; required: []
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
description |
string or null | No | |
destination |
string or null | No | |
tiers |
array of object (fields) | No | |
title |
string or null | No |
additionalProperties: false; required: []
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
accent |
string or null | No | |
description |
string or null | No | |
page_ids |
array of string (fields) | Yes | minItems: 1; uniqueItems: true |
title |
string or null | No |
additionalProperties: false; required: ["page_ids"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
collection_id |
string or null | No | |
description |
string or null | No | |
product_ids |
array of string (fields) | No | uniqueItems: true |
title |
string or null | No |
additionalProperties: false; required: []
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
description |
string or null | No | |
location_ids |
array of string (fields) | No | uniqueItems: true |
title |
string or null | No |
additionalProperties: false; required: []
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
call_to_action |
object (fields) | No | additionalProperties: false; required: [] |
description |
string or null | No | |
limit |
integer | No | maximum: 12; minimum: 1 |
location_id |
string or null | No | |
title |
string or null | No |
additionalProperties: false; required: []
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
intro |
string or null | No | |
label |
string or null | No | |
prompts |
array of object (fields) | No |
additionalProperties: false; required: []
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
alt_text |
string or null | No | |
asset_id |
string | Yes | |
file_name |
string or null | No | |
height |
number or null | No | |
kind |
string or null | No | |
public_url |
string or null | No | |
slot |
string (fields) | Yes | |
sort_order |
number or null | No | |
thumbnail_url |
string or null | No | |
width |
number or null | No |
additionalProperties: false; required: ["asset_id","slot"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
text |
string | Yes |
additionalProperties: false; required: ["text"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
editor_mode |
string | Yes | enum: ["rich","source"] |
markdown |
string | Yes | Markdown. |
title |
string or null | No |
additionalProperties: false; required: ["markdown","editor_mode"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
caption |
string or null | No |
additionalProperties: false; required: []
array of #/$defs/content_block_media fields
Value: array of #/$defs/content_block_media.
maxItems: 1; minItems: 1
Array items: #/$defs/content_block_media.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
caption |
string or null | No | |
title |
string | Yes | |
upload_date |
string or null | No | |
url |
string | Yes |
additionalProperties: false; required: ["url","title"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
source |
string | Yes | enum: ["page_qa","organization_qa"] |
title |
string or null | No |
additionalProperties: false; required: ["source"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
description |
string or null | No | |
estimated_time |
string or null | No | |
label |
string or null | No | |
steps |
array of object (fields) | Yes | minItems: 1 |
supply_items |
array of string (fields) | No | |
title |
string or null | No | |
tool_items |
array of string (fields) | No |
additionalProperties: false; required: ["steps"]
object fields
Value: object.
additionalProperties: false; required: []
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
accent |
string or null | No | |
description |
string or null | No | |
label |
string or null | No | |
layout |
string or null | No | enum: ["centered","compact",null] |
secondary_label |
string or null | No | |
secondary_url |
string or null | No | |
title |
string or null | No | |
url |
string or null | No |
additionalProperties: false; required: []
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
accent |
string or null | No | |
description |
string or null | No | |
label |
string or null | No | |
layout |
string or null | No | enum: ["centered","compact",null] |
notice |
string or null | No | |
price_line |
string or null | No | |
secondary_label |
string or null | No | |
secondary_url |
string or null | No | |
title |
string or null | No | |
url |
string or null | No |
additionalProperties: false; required: []
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
badge |
string or null | No | |
body |
string or null | No | |
buttons |
array of object (fields) | No | |
items |
array of object (fields) | No | |
title |
string or null | No | |
tone |
string or null | No | enum: ["neutral","info","success","warning","danger",null] |
additionalProperties: false; required: []
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
accent |
string or null | No | |
caption |
string or null | No | |
cta_label |
string or null | No | |
cta_url |
string or null | No | |
eyebrow |
string or null | No | |
image_position |
string or null | No | enum: ["top","center","bottom",null] |
image_ratio |
string or null | No | enum: ["original","portrait","square","landscape",null] |
rotating_accents |
array of string (fields) | No | |
secondary_label |
string or null | No | |
secondary_url |
string or null | No | |
subtitle |
string or null | No | |
title |
string | Yes |
additionalProperties: false; required: ["title"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
buttons |
array of object (fields) | No | |
layout |
string or null | No | enum: ["buttons","links",null] |
additionalProperties: false; required: []
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
calculator |
object (fields) | No | |
cta_label |
string or null | No | |
cta_url |
string or null | No | |
description |
string or null | No | |
eyebrow |
string or null | No | |
items |
array of object (fields) | No | |
layout |
string or null | No | enum: ["cards","pictures","columns","strip",null] |
limit |
integer | No | minimum: 1 |
source |
string or null | No | enum: ["manual","organization_posts","calculator","billing_plans","billing_features",null] |
title |
string or null | No | |
title_muted |
string or null | No |
additionalProperties: false; required: []
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
description |
string or null | No | |
problem_items |
array of object (fields) | No | |
problem_label |
string or null | No | |
problem_title |
string or null | No | |
solution_items |
array of object (fields) | No | |
solution_label |
string or null | No | |
solution_title |
string or null | No | |
title |
string or null | No |
additionalProperties: false; required: []
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
description |
string or null | No | |
items |
array of object (fields) | No | |
label |
string or null | No | |
title |
string or null | No |
additionalProperties: false; required: []
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
cta_label |
string or null | No | |
cta_url |
string or null | No | |
description |
string or null | No | |
items |
array of object (fields) | No | |
label |
string or null | No | |
prompt_heading |
string or null | No | |
title |
string or null | No |
additionalProperties: false; required: []
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
items |
array of object (fields) | No |
additionalProperties: false; required: []
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
description |
string or null | No | |
items |
array of object (fields) | No | |
pin_label |
string or null | No | |
subtitle |
string or null | No | |
title |
string or null | No |
additionalProperties: false; required: []
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
cta_label |
string or null | No | |
cta_url |
string or null | No | |
items |
array of object (fields) | No | |
title |
string or null | No |
additionalProperties: false; required: []
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
description |
string or null | No | |
items |
array of object (fields) | No | |
title |
string or null | No | |
upload_date |
string or null | No | |
video_title |
string or null | No | |
video_url |
string or null | No |
additionalProperties: false; required: []
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
body |
string or null | No | |
caption |
string or null | No | |
example_type |
string or null | No | enum: ["websites","posts","app_screens",null] |
eyebrow |
string or null | No | |
image_position |
string or null | No | enum: ["top","center","bottom",null] |
image_ratio |
string or null | No | enum: ["original","portrait","square","landscape",null] |
items |
array of object (fields) | No | |
label |
string or null | No | |
layout |
string or null | No | enum: ["standard","editorial",null] |
title |
string or null | No | |
tone |
string or null | No | enum: ["light","dark",null] |
url |
string or null | No |
additionalProperties: false; required: []
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
booking_label |
string or null | No | |
booking_product_id |
string or null | No | |
description |
string or null | No | |
title |
string or null | No |
additionalProperties: false; required: []
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
description |
string or null | No | |
items |
array of object (fields) | No | |
title |
string or null | No |
additionalProperties: false; required: []
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
description |
string or null | No | |
title |
string or null | No |
additionalProperties: false; required: []
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
description |
string or null | No | |
destination |
string or null | No | |
tiers |
array of object (fields) | No | |
title |
string or null | No |
additionalProperties: false; required: []
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
accent |
string or null | No | |
description |
string or null | No | |
page_ids |
array of string (fields) | Yes | minItems: 1; uniqueItems: true |
title |
string or null | No |
additionalProperties: false; required: ["page_ids"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
collection_id |
string or null | No | |
description |
string or null | No | |
product_ids |
array of string (fields) | No | uniqueItems: true |
title |
string or null | No |
additionalProperties: false; required: []
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
description |
string or null | No | |
location_ids |
array of string (fields) | No | uniqueItems: true |
title |
string or null | No |
additionalProperties: false; required: []
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
call_to_action |
object (fields) | No | additionalProperties: false; required: [] |
description |
string or null | No | |
limit |
integer | No | maximum: 12; minimum: 1 |
location_id |
string or null | No | |
title |
string or null | No |
additionalProperties: false; required: []
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
intro |
string or null | No | |
label |
string or null | No | |
prompts |
array of object (fields) | No |
additionalProperties: false; required: []
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
data |
object | Yes | |
id |
string | Yes | |
level |
number or null | Yes | |
media |
array of #/$defs/content_block_media (fields) | Yes | |
parent_block_id |
string or null | Yes | |
position |
integer | No | |
source_block_id |
string or null | No | |
type |
string | Yes | enum: ["heading","markdown","image","gallery","video","faq","how_to","divider","cta","contact_cta","booking_cta","callout","hero","button_group","feature_grid","comparison","stat_grid","workflow_grid","showcase","language_reach","steps","video_feature","media_text","contact_form","team_grid","testimonial_grid","donation_choices","page_grid","product_grid","location_grid","social_posts","ai_assistance"] |
updated_at |
string | Yes | The block's own concurrency token, for replace_content_block and delete_content_block. |
additionalProperties: false; required: ["id","parent_block_id","type","level","data","media","updated_at"]
anyOf: shape 1, shape 2, shape 3, shape 4, shape 5, shape 6, shape 7, shape 8, shape 9, shape 10, shape 11, shape 12, shape 13, shape 14, shape 15, shape 16, shape 17, shape 18, shape 19, shape 20, shape 21, shape 22, shape 23, shape 24, shape 25, shape 26, shape 27, shape 28, shape 29, shape 30, shape 31, shape 32.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
data |
#/$defs/content_heading or #/$defs/content_markdown or #/$defs/content_image or #/$defs/content_gallery or #/$defs/content_video or #/$defs/content_faq or #/$defs/content_how_to or #/$defs/content_divider or #/$defs/content_cta or #/$defs/content_contact_cta or #/$defs/content_booking_cta or #/$defs/content_callout or #/$defs/content_hero or #/$defs/content_button_group or #/$defs/content_feature_grid or #/$defs/content_comparison or #/$defs/content_stat_grid or #/$defs/content_workflow_grid or #/$defs/content_showcase or #/$defs/content_language_reach or #/$defs/content_steps or #/$defs/content_video_feature or #/$defs/content_media_text or #/$defs/content_contact_form or #/$defs/content_team_grid or #/$defs/content_testimonial_grid or #/$defs/content_donation_choices or #/$defs/content_page_grid or #/$defs/content_product_grid or #/$defs/content_location_grid or #/$defs/content_social_posts or #/$defs/content_ai_assistance (fields) | Yes | |
id |
string | No | |
level |
integer or null | No | maximum: 6; minimum: 1 |
media |
array of #/$defs/content_block_media (fields) | No | |
parent_block_id |
string or null | No | |
source_block_id |
string or null | No | |
type |
string | Yes | enum: ["heading","markdown","image","gallery","video","faq","how_to","divider","cta","contact_cta","booking_cta","callout","hero","button_group","feature_grid","comparison","stat_grid","workflow_grid","showcase","language_reach","steps","video_feature","media_text","contact_form","team_grid","testimonial_grid","donation_choices","page_grid","product_grid","location_grid","social_posts","ai_assistance"] |
updated_at |
string or null | No | As read. Ignored on a whole-document write. |
additionalProperties: false; required: ["type","data"]
anyOf: shape 1, shape 2, shape 3, shape 4, shape 5, shape 6, shape 7, shape 8, shape 9, shape 10, shape 11, shape 12, shape 13, shape 14, shape 15, shape 16, shape 17, shape 18, shape 19, shape 20, shape 21, shape 22, shape 23, shape 24, shape 25, shape 26, shape 27, shape 28, shape 29, shape 30, shape 31, shape 32.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
id |
string | Yes | minLength: 1 |
updated_at |
string | Yes | minLength: 1 |
required: ["id","updated_at"]
array of object fields
Value: array of object.
maxItems: 20
Array items: object.
array of object fields
Value: array of object.
Array items: object.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
path |
string | Yes | |
public_url |
string or null | Yes | |
recipe |
string or null | Yes |
required: ["path","recipe","public_url"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
admin_edit_url |
string or null | Yes | |
id |
string | Yes | minLength: 1 |
locale |
string | Yes | minLength: 1 |
page_id |
string | Yes | minLength: 1 |
page_type |
string | Yes | enum: ["custom","recipe","legal","system"] |
path |
string | Yes | |
product_id |
string or null | Yes | |
recipe |
string or null | Yes | |
removable |
boolean | Yes | |
sort_order |
number | Yes | |
title |
string | Yes | |
updated_at |
string | Yes | minLength: 1 |
additionalProperties: false; required: ["id","page_id","locale","path","title","page_type","recipe","sort_order","updated_at","product_id","removable","admin_edit_url"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
choices |
array of object (fields) | No | maxItems: 20 |
help_text |
string or null | No | maxLength: 500 |
id |
string | No | Existing question ID to keep. Omit for a new question; one is assigned from its label. maxLength: 64; pattern: "^[a-z0-9][a-z0-9_-]{0,63}$" |
label |
string | Yes | maxLength: 200; minLength: 1 |
required |
boolean | Yes | |
type |
string | Yes | enum: ["short_text","long_text","single_choice","multiple_choice","yes_no"] |
additionalProperties: false; required: ["label","type","required"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
active |
boolean | Yes | True when this is the currently active MCP location context. |
id |
string | Yes | |
place_name |
string or null | No | The neighbourhood this location's address names, or its town. Derived from the address; call get_location for the address itself. |
slug |
string | Yes | |
status |
string | Yes | |
title |
string | Yes |
required: ["id","slug","title","status","active"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
active |
boolean | Yes | True when this is the currently active MCP organization context. |
id |
string | Yes | |
name |
string or null | No | |
slug |
string or null | No |
required: ["id","active"]
string fields
Value: string.
maxLength: 90; minLength: 1
string fields
Value: string.
maxLength: 30; minLength: 1
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
match_type |
string | No | enum: ["EXACT","PHRASE","BROAD"] |
text |
string | Yes | minLength: 1 |
required: ["text"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
id |
string | Yes | |
name |
string | Yes | |
status |
string | Yes |
required: ["id","name","status"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
matchType |
string | Yes | |
negative |
boolean | Yes | |
status |
string or null | Yes | |
text |
string | Yes |
required: ["text","matchType","status","negative"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
budgetAmountMicros |
number | Yes | |
budgetId |
string or null | No | |
channelType |
string | Yes | |
clicks |
number | Yes | |
conversions |
number | Yes | |
costMicros |
number | Yes | |
id |
string | Yes | |
impressions |
number | Yes | |
name |
string | Yes | |
status |
string | Yes |
required: ["id","name","status","channelType","budgetAmountMicros","clicks","impressions","costMicros","conversions"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
adGroupId |
string or null | Yes | |
campaignId |
string or null | Yes | |
campaignName |
string or null | Yes | |
clicks |
number | Yes | |
conversions |
number | Yes | |
conversionsValue |
number | Yes | |
costMicros |
number | Yes | |
date |
string or null | Yes | campaign_daily: the day. |
detail |
string or null | Yes | keywords: match type; search_terms: whether the term was added or excluded; geography: physical presence or area of interest. |
impressions |
number | Yes | |
text |
string | Yes | The campaign, search term, keyword, landing page URL or country. |
required: ["text","detail","date","campaignId","campaignName","adGroupId","impressions","clicks","costMicros","conversions","conversionsValue"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
delayMinutes |
number | Yes | const: 5 |
productIds |
array of string (fields) | Yes | maxItems: 100; minItems: 1; uniqueItems: true |
trigger |
string | Yes | const: "booking_received" |
additionalProperties: false; required: ["trigger","delayMinutes","productIds"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
localTime |
string | Yes | pattern: "^([01]\d|2[0-3]):[0-5]\d$" |
offsetDays |
integer | Yes | maximum: 7; minimum: -7 |
productIds |
array of string (fields) | Yes | maxItems: 100; minItems: 1; uniqueItems: true |
trigger |
string | Yes | enum: ["check_in","check_out"] |
additionalProperties: false; required: ["trigger","offsetDays","localTime","productIds"]
array or null fields
Value: array or null.
Array items: object.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
body |
string | Yes | minLength: 1 |
createdAt |
string | Yes | minLength: 1 |
dueAt |
string or null | Yes | |
entryId |
string or null | Yes | |
errorCode |
string or null | Yes | |
errorField |
string or null | Yes | |
id |
string | Yes | minLength: 1 |
organizationId |
string | Yes | minLength: 1 |
productId |
string | Yes | minLength: 1 |
reason |
string or null | Yes | |
requestId |
string or null | Yes | |
sentAt |
string or null | Yes | |
startedAt |
string or null | Yes | |
status |
string | Yes | enum: ["pending","sending","sent","failed","needs_review","cancelled","skipped"] |
stayId |
string | Yes | minLength: 1 |
templateId |
string or null | Yes | |
templateVersion |
integer | Yes | minimum: 1 |
timezone |
string | Yes | minLength: 1 |
title |
string | Yes | minLength: 1 |
updatedAt |
string | Yes | minLength: 1 |
required: ["id","organizationId","productId","stayId","requestId","templateId","title","templateVersion","body","dueAt","timezone","status","reason","errorCode","errorField","entryId","startedAt","sentAt","createdAt","updatedAt"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
details |
string or null | Yes | Required for additional. maxLength: 500; minLength: 1 |
task |
string | Yes | enum: ["gather_towels","throw_trash","turn_off","lock_up","return_keys","additional"] |
additionalProperties: false; required: ["task","details"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
airbnb_url |
string | Yes | format: "uri" |
field |
string | Yes | minLength: 1 |
additionalProperties: false; required: ["field","airbnb_url"]
null fields
Value: null.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
detail |
null | Yes | |
state |
string | Yes | const: "pushed" |
required: ["state","detail"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
detail |
string | Yes | minLength: 1 |
state |
string | Yes | const: "pending" |
required: ["state","detail"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
created_at |
string | Yes | |
id |
string | Yes | |
is_source |
boolean | Yes | |
label |
string or null | Yes | |
locale |
string | Yes | |
organization_id |
string | Yes | |
status |
string | Yes | enum: ["published","disabled"] |
updated_at |
string | Yes |
additionalProperties: false; required: ["id","organization_id","locale","label","is_source","status","created_at","updated_at"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
id |
string | Yes | |
localization |
object or null (fields) | Yes | additionalProperties: false; required: ["values"] |
location_id |
string or null | Yes | |
source |
object (fields) | Yes | additionalProperties: false; required: ["name","description"] |
additionalProperties: false; required: ["id","location_id","source","localization"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
id |
string | Yes | |
kind |
string | Yes | enum: ["dish","experience","service","stay"] |
localization |
object or null (fields) | Yes | additionalProperties: false; required: ["values","route_path"] |
source |
object (fields) | Yes | additionalProperties: false; required: ["name","description","marketing_features","unit_label","details"] |
additionalProperties: false; required: ["id","kind","source","localization"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
created_at |
string | Yes | |
created_by_user_id |
string | Yes | |
id |
string | Yes | |
locale |
string | Yes | |
organization_id |
string | Yes | |
resource_id |
string | Yes | |
resource_type |
string | Yes | enum: ["organization","business_location","product","collection","article_category","media_asset"] |
route_path |
string or null | Yes | |
updated_at |
string | Yes | |
updated_by_user_id |
string | Yes | |
values |
object | Yes |
additionalProperties: false; required: ["id","organization_id","locale","created_at","updated_at","resource_type","resource_id","values","route_path","created_by_user_id","updated_by_user_id"]
anyOf: shape 1, shape 2, shape 3, shape 4, shape 5, shape 6.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
content_blocks |
array of object (fields) | Yes | |
created_at |
string | Yes | |
id |
string | Yes | |
kind |
string | Yes | enum: ["page","article","social_post","qa"] |
locale |
string | Yes | |
metadata |
object | Yes | additionalProperties: true |
organization_id |
string | Yes | |
path |
string or null | Yes | |
root_id |
string | Yes | |
row_role |
string | Yes | const: "representation" |
seo_keywords |
string or null | Yes | |
slug |
string or null | Yes | |
summary |
string or null | Yes | |
title |
string or null | Yes | |
updated_at |
string | Yes |
additionalProperties: false; required: ["id","organization_id","locale","created_at","updated_at","kind","row_role","root_id","title","summary","slug","path","seo_keywords","metadata","content_blocks"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
addressLines |
array of string (fields) | No | |
administrativeArea |
string | No | |
locality |
string | No | |
sublocality |
string | No |
additionalProperties: false
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
disclaimer |
string | No | |
footer_disclaimer |
string | No | |
service_area |
string | No |
additionalProperties: false
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
cta_label |
string | No |
additionalProperties: false
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
allergens |
array of string (fields) | No | Allergens the merchant states this dish contains. maxItems: 100; uniqueItems: true |
cancellation_policy |
string | No | The merchant’s stated cancellation terms, displayed publicly; this text does not automate refunds. maxLength: 10000; minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
carbon_monoxide_detector_details |
string | No | Share where each carbon monoxide alarm is located. maxLength: 300; minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
climbing_structures_details |
string | No | Host-authored details about climbing or play structures. Requires its disclosure to be Yes. maxLength: 300; minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
dangerous_animals_details |
string | No | Host-authored details about potentially dangerous animals. Requires its disclosure to be Yes. maxLength: 300; minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
dietary_notes |
array of string (fields) | No | Merchant-stated dietary facts displayed with a dish. maxItems: 100; uniqueItems: true |
exterior_security_cameras_details |
string | No | Host-authored details about exterior security cameras. Requires its disclosure to be Yes. maxLength: 300; minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
getting_around |
string | No | Host-authored transport and getting-around information for this home. maxLength: 10000; minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
guest_access |
string | No | The spaces and facilities guests can use during their stay. maxLength: 10000; minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
house_rules |
string | No | The host’s rules for guests staying in the home, shown with the listing. maxLength: 10000; minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
included_items |
array of string (fields) | No | Items or work included in the stated price, shown in their own public section. maxItems: 100; uniqueItems: true |
ingredients |
array of string (fields) | No | Ingredients shown in the dish details. maxItems: 100; uniqueItems: true |
interaction_with_guests |
string | No | How guests can contact the host and what support is available. maxLength: 10000; minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
limited_essentials_details |
string | No | Host-authored details about limited essential amenities. Requires its disclosure to be Yes. maxLength: 300; minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
meeting_point |
string | No | Instructions shown in the meeting section; meeting mode and video links are set in scheduling. maxLength: 10000; minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
nearby_water_details |
string | No | Host-authored details about nearby water. Requires its disclosure to be Yes. maxLength: 300; minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
neighborhood_description |
string | No | Host-authored information about the neighborhood around this home. maxLength: 10000; minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
no_property_parking_details |
string | No | Host-authored details about no parking on the property. Requires its disclosure to be Yes. maxLength: 300; minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
noise_decibel_monitors_details |
string | No | Host-authored details about noise decibel monitors. Requires its disclosure to be Yes. maxLength: 300; minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
noodle |
array of string (fields) | No | Authored noodle information shown as dish facts; these do not establish purchasable variants. maxItems: 100; uniqueItems: true |
other_details_to_note |
string | No | Additional information guests should know before booking. maxLength: 10000; minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
potential_noise_details |
string | No | Host-authored details about potential noise during stays. Requires its disclosure to be Yes. maxLength: 300; minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
preparation |
string | No | Preparation instructions shown to customers before a session or appointment. maxLength: 10000; minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
pricing_note |
string | No | An explicitly stated price such as Market price; use only when no numeric price is set. maxLength: 1000; minLength: 1; pattern: "^(?=[\s\S]\S)[^\r\n]$" |
resident_pets_details |
string | No | Host-authored details about pets live on the property. Requires its disclosure to be Yes. maxLength: 300; minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
shared_spaces_details |
string | No | Host-authored details about shared spaces. Requires its disclosure to be Yes. maxLength: 300; minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
sizes |
array of string (fields) | No | Authored serving information; priced choices belong in variants. maxItems: 100; uniqueItems: true |
smoke_detector_details |
string | No | Share where each smoke alarm is located. maxLength: 300; minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
soup |
array of string (fields) | No | Authored soup information shown with the dish. maxItems: 100; uniqueItems: true |
special_safety_considerations |
string | No | Other property features that guests should know could be unsafe, and why. maxLength: 300; minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
stairs_required_details |
string | No | Host-authored details about guests must climb stairs. Requires its disclosure to be Yes. maxLength: 300; minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
tagline |
string | No | A short sentence shown below the product title. maxLength: 1000; minLength: 1; pattern: "^(?=[\s\S]\S)[^\r\n]$" |
toppings |
array of string (fields) | No | Authored topping information; priced choices belong in variants. maxItems: 100; uniqueItems: true |
unprotected_heights_details |
string | No | Host-authored details about unprotected heights. Requires its disclosure to be Yes. maxLength: 300; minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
unsecured_pool_details |
string | No | Host-authored details about unsecured pool or hot tub. Requires its disclosure to be Yes. maxLength: 300; minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
weapons_on_property_details |
string | No | Host-authored details about weapons on the property. Requires its disclosure to be Yes. maxLength: 300; minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
what_to_bring |
array of string (fields) | No | Items customers should bring, shown in the preparation section. maxItems: 100; uniqueItems: true |
your_property |
string | No | The spaces and features guests should know about this home. maxLength: 10000; minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
additionalProperties: false
array of string fields
Value: array of string.
Array items: string.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
call_to_action |
object (fields) | No | additionalProperties: false; required: ["label"] |
additionalProperties: false
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
policy |
object (fields) | No | additionalProperties: false |
additionalProperties: false
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
brand_description |
string | No | |
compliance |
object (fields) | No | additionalProperties: false |
consultation |
object (fields) | No | additionalProperties: false |
inquiry_questions |
object | No | Translated question wording keyed by question ID: { label?, help_text?, choices?: { |
name |
string | No | |
seo_description |
string | No | |
seo_title |
string | No |
additionalProperties: false
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
address |
object (fields) | No | additionalProperties: false |
description |
string | No | |
reservation |
object (fields) | No | additionalProperties: false |
reservation_questions |
object | No | Translated question wording keyed by question ID: { label?, help_text?, choices?: { |
seo_description |
string | No | |
seo_title |
string | No | |
short_description |
string | No | |
title |
string | No |
additionalProperties: false
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
description |
string | No | |
details |
object (fields) | No | additionalProperties: false |
marketing_features |
array of string (fields) | No | |
name |
string | No | |
questions |
object | No | Translated question wording keyed by question ID: { label?, help_text?, choices?: { |
unit_label |
string | No |
additionalProperties: false
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
description |
string | No | |
name |
string | No |
additionalProperties: false
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
alt_text |
string | No |
additionalProperties: false
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
metadata |
object (fields) | No | additionalProperties: false |
seo_keywords |
string or null | No | |
summary |
string or null | No | |
title |
string or null | No |
additionalProperties: false
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
resource_id |
string | Yes | |
route_path |
null | No | |
values |
object (fields) | Yes | additionalProperties: false |
additionalProperties: false; required: ["resource_id","values"]
array of See schema fields
Value: array of See schema.
Array items: See schema.
array of See schema fields
Value: array of See schema.
Array items: See schema.
array of See schema fields
Value: array of See schema.
Array items: See schema.
array of See schema fields
Value: array of See schema.
Array items: See schema.
array of See schema fields
Value: array of See schema.
Array items: See schema.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
assignedMemberId |
string or null | No | |
assignedMemberName |
string or null | No | |
dayKey |
string | Yes | |
endsAt |
string or null | Yes | |
guestImageUrl |
string or null | No | |
id |
string | Yes | |
kind |
string | Yes | enum: ["reservation","booking","post","stay"] |
locationId |
string or null | Yes | |
locationTitle |
string or null | No | |
operationalBookingId |
string or null | Yes | |
operationalReservationId |
string or null | Yes | |
organizationId |
string | Yes | |
partySize |
integer or null | Yes | |
productId |
string or null | Yes | |
requestId |
string or null | Yes | |
resourceImageUrl |
string or null | No | |
resourceTitle |
string or null | No | |
showTimeZone |
boolean | No | |
startsAt |
string | Yes | |
status |
string | Yes | |
stayChannel |
string or null | Yes | enum: ["airbnb","vrbo","booking_com","direct",null] |
stayId |
string or null | Yes | For a stay row, the stay to read with get_stay; one stay is its arrival and its departure. |
stayMoment |
string or null | Yes | enum: ["arrival","departure","turnover","current",null] |
subtitle |
string or null | No | |
timeZone |
string | Yes | |
title |
string | Yes | |
to |
string | No |
required: ["id","kind","requestId","operationalBookingId","operationalReservationId","stayId","productId","stayChannel","stayMoment","startsAt","endsAt","dayKey","timeZone","title","status","organizationId","locationId","partySize"]
array of object fields
Value: array of object.
Array items: object.
null or object fields
Value: null or object.
null or array of object fields
Value: null or array of object.
array of string fields
Value: array of string.
minItems: 1
Array items: string.
string fields
Value: string.
enum: ["reservation","booking","post","stay"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
date |
string | Yes | |
location_id |
string | Yes | |
note |
string or null | No | |
reason |
string | Yes | enum: ["inactive","closure","dated_hours","regular_hours"] |
required: ["date","location_id","reason"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
periods |
array of object (fields) | Yes |
additionalProperties: false; required: ["periods"]
array of object fields
Value: array of object.
Array items: object.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
owner_id |
string | Yes | |
owner_type |
string | Yes | enum: ["organization"] |
slot |
string | Yes | enum: ["compliance_document"] |
additionalProperties: false; required: ["owner_type","owner_id","slot"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
owner_id |
string | Yes | |
owner_type |
string | Yes | enum: ["business_location"] |
slot |
string | Yes | enum: ["gallery"] |
additionalProperties: false; required: ["owner_type","owner_id","slot"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
owner_id |
string | Yes | |
owner_type |
string | Yes | enum: ["product"] |
slot |
string | Yes | enum: ["gallery"] |
additionalProperties: false; required: ["owner_type","owner_id","slot"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
owner_id |
string | Yes | |
owner_type |
string | Yes | enum: ["content_document"] |
slot |
string | Yes | enum: ["gallery"] |
additionalProperties: false; required: ["owner_type","owner_id","slot"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
owner_id |
string | Yes | |
owner_type |
string | Yes | enum: ["content_block"] |
slot |
string | Yes | enum: ["gallery"] |
additionalProperties: false; required: ["owner_type","owner_id","slot"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
owner_id |
string | Yes | |
owner_type |
string | Yes | enum: ["review_request"] |
slot |
string | Yes | enum: ["gallery"] |
additionalProperties: false; required: ["owner_type","owner_id","slot"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
alt_text |
string or null | No | |
asset_id |
string | Yes | |
duration |
number or null | No | |
height |
number or null | No | |
kind |
string | Yes | enum: ["image","video","file"] |
mime_type |
string or null | No | |
provider |
string | No | |
public_url |
string | Yes | |
status |
string | Yes | enum: ["active"] |
thumbnail_url |
string or null | No | |
width |
number or null | No |
required: ["asset_id","kind","public_url","status"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
owner_id |
string | Yes | |
owner_type |
string | Yes | enum: ["organization"] |
slot |
string | Yes | enum: ["logo","logo_dark","favicon","social_share","compliance_document","announcement"] |
additionalProperties: false; required: ["owner_type","owner_id","slot"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
owner_id |
string | Yes | |
owner_type |
string | Yes | enum: ["business_location"] |
slot |
string | Yes | enum: ["hero","gallery"] |
additionalProperties: false; required: ["owner_type","owner_id","slot"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
owner_id |
string | Yes | |
owner_type |
string | Yes | enum: ["product"] |
slot |
string | Yes | enum: ["image","gallery"] |
additionalProperties: false; required: ["owner_type","owner_id","slot"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
owner_id |
string | Yes | |
owner_type |
string | Yes | enum: ["collection"] |
slot |
string | Yes | enum: ["image"] |
additionalProperties: false; required: ["owner_type","owner_id","slot"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
owner_id |
string | Yes | |
owner_type |
string | Yes | enum: ["content_document"] |
slot |
string | Yes | enum: ["cover","gallery"] |
additionalProperties: false; required: ["owner_type","owner_id","slot"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
owner_id |
string | Yes | |
owner_type |
string | Yes | enum: ["content_block"] |
slot |
string (fields) | Yes |
additionalProperties: false; required: ["owner_type","owner_id","slot"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
alt_text |
string or null | Yes | |
asset_id |
string | Yes | |
category |
string or null | Yes | |
created_at |
string | Yes | |
duration |
number or null | Yes | Video duration in seconds. |
file_name |
string or null | Yes | |
file_size |
integer or null | Yes | Stored file size in bytes. |
height |
integer or null | Yes | |
kind |
string | Yes | enum: ["image","video","file"] |
mime_type |
string or null | Yes | |
provider |
string | Yes | |
public_url |
string or null | Yes | |
source |
string | Yes | |
status |
string | Yes | enum: ["pending","active","deleted","failed"] |
thumbnail_url |
string or null | Yes | |
updated_at |
string | Yes | |
width |
integer or null | Yes |
additionalProperties: false; required: ["asset_id","kind","provider","source","public_url","thumbnail_url","alt_text","category","status","file_name","created_at","mime_type","file_size","width","height","duration","updated_at"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
after_asset_id |
string | No | |
asset_id |
string | Yes | |
before_asset_id |
string | No |
additionalProperties: false; not: {"required":["before_asset_id","after_asset_id"]}; required: ["asset_id"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
owner_id |
string | Yes | |
owner_type |
string | Yes | enum: ["organization"] |
slot |
string | Yes | enum: ["logo","logo_dark","favicon","social_share","announcement"] |
additionalProperties: false; required: ["owner_type","owner_id","slot"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
owner_id |
string | Yes | |
owner_type |
string | Yes | enum: ["business_location"] |
slot |
string | Yes | enum: ["hero"] |
additionalProperties: false; required: ["owner_type","owner_id","slot"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
owner_id |
string | Yes | |
owner_type |
string | Yes | enum: ["product"] |
slot |
string | Yes | enum: ["image"] |
additionalProperties: false; required: ["owner_type","owner_id","slot"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
owner_id |
string | Yes | |
owner_type |
string | Yes | enum: ["content_document"] |
slot |
string | Yes | enum: ["cover"] |
additionalProperties: false; required: ["owner_type","owner_id","slot"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
owner_id |
string | Yes | |
owner_type |
string | Yes | enum: ["content_block"] |
slot |
string (fields) | Yes |
additionalProperties: false; required: ["owner_type","owner_id","slot"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
x |
number | Yes | maximum: 1; minimum: 0 |
y |
number | Yes | maximum: 1; minimum: 0 |
additionalProperties: false; required: ["x","y"]
object or null fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
error |
string or null | Yes | |
status |
string | Yes |
required: ["status","error"]
array of object fields
Value: array of object.
Array items: object.
object or null fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
cta_label |
string or null | No | |
cta_url |
string or null | No | |
description |
string or null | No | |
dismissible |
boolean | No | |
enabled |
boolean | No | |
format |
string | No | enum: ["modal","banner"] |
headline |
string | No |
array of object fields
Value: array of object.
maxItems: 20
Array items: object.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
google_ads |
object or null (fields) | No | |
google_analytics |
object or null (fields) | No | |
google_search_console |
object or null (fields) | No |
object or null fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
dark |
object (fields) | No | additionalProperties: false |
light |
object (fields) | No | additionalProperties: false |
string fields
Value: string.
enum: ["source_locale","currency","timezone","subdomain"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
amount_minor |
integer | No | minimum: 0 |
category |
string | No | |
name |
string | Yes | minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
additionalProperties: false; required: ["name"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
createdAt |
string | Yes | format: "date-time" |
id |
string | Yes | |
organizationId |
string | Yes | |
role |
string | Yes | |
user |
object (fields) | Yes | required: ["id","name","email"] |
userId |
string | Yes |
required: ["id","organizationId","userId","role","createdAt","user"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
active |
boolean | Yes | True when this is the currently active MCP organization context. |
id |
string | Yes | |
name |
string | Yes | Business name, or the subdomain slug when it has none. |
orgSlug |
string or null | No | Organization slug — combine with locationSlug from list_locations to build the dashboard URL: https://krabiclaw.com/dashboard/{orgSlug}/locations/{locationSlug} |
publicUrl |
string or null | No | |
status |
string | Yes | enum: ["active","inactive","suspended"] |
subdomain |
string or null | No |
required: ["id","name","status","active"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
createdAt |
string | Yes | format: "date-time" |
id |
string | Yes | |
members |
array of object (fields) | Yes | |
name |
string | Yes | |
organizationId |
string | Yes | |
updatedAt |
string | No | format: "date-time" |
required: ["id","name","organizationId","createdAt","members"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
accent |
string | No | Emphasis, decoration and highlighted buttons. |
action |
string | No | Buttons, links and selected states. |
ground |
string | No | The page background. |
muted |
string | No | Captions, details and supporting copy. |
surface |
string | No | Cards, the header and footer, dialogs and fields. |
text |
string | No | Body copy and headings. |
additionalProperties: false
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
minimum |
number | Yes | |
mode |
string | Yes | |
pair |
string | Yes | |
ratio |
number | Yes |
required: ["mode","pair","ratio","minimum"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
amount |
integer | No | |
currency |
string | No | |
evidence_due_at |
string or null | No | |
id |
string | No | |
reason |
string | No | |
status |
string | No | |
updated_at |
string | No |
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
currency |
string | No | |
tax_behavior |
string | No | |
type |
string | No | |
unit_amount |
integer | No |
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
amount |
integer | Yes | |
id |
string | Yes | |
status |
string | Yes |
required: ["id","amount","status"]
array of object fields
Value: array of object.
Array items: object.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
amount |
integer | Yes | |
arrival_date |
integer | No | |
automatic |
boolean | No | |
created |
integer | No | |
currency |
string | Yes | |
dashboard_url |
string | Yes | |
id |
string | Yes | |
status |
string | Yes |
required: ["id","amount","currency","status","dashboard_url"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
captured_amount |
integer | Yes | |
currency |
string | Yes | |
disputed_amount |
integer | Yes | |
refunded_amount |
integer | Yes |
required: ["currency","captured_amount","refunded_amount","disputed_amount"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
amount |
integer | Yes | |
currency |
string | Yes | |
kind |
string | Yes | |
pending_delivery |
integer | Yes |
required: ["currency","kind","amount","pending_delivery"]
string fields
Value: string.
maxLength: 5000
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
label |
string | Yes | maxLength: 60; minLength: 1 |
url |
string | Yes | https://…, http://… or tel:+… |
additionalProperties: false; required: ["label","url"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
asset_id |
string | Yes | minLength: 1 |
slot |
enum | Yes | enum: ["cover","gallery"] |
additionalProperties: false; required: ["asset_id","slot"]
string fields
Value: string.
maxLength: 200
object or null fields
Value: object or null.
array of object fields
Value: array of object.
Array items: object.
array of object fields
Value: array of object.
Array items: object.
array of object fields
Value: array of object.
Array items: object.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
channel |
string | Yes | enum: ["facebook","instagram","discord"] |
connect_url |
string | Yes | Where a person connects or changes this account in the dashboard. |
connected |
boolean | Yes | |
connection_revision |
string or null | Yes | |
deletion_unavailable_reason |
string or null | Yes | |
problems |
array of object (fields) | Yes | |
supported_formats |
array of string (fields) | Yes | |
supported_operations |
array of string (fields) | Yes | |
target_id |
string or null | Yes | |
target_name |
string or null | Yes |
required: ["channel","connected","target_id","target_name","connection_revision","supported_formats","problems","supported_operations","deletion_unavailable_reason","connect_url"]
object fields
Value: object.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
active |
boolean | No | Enable or disable this product. Increasing the number of live homes requires the dashboard. |
description |
string | No | |
details |
object (fields) | No | Named customer-facing facts for the product kind. This is a complete replacement map; preserve fields to retain. pricing_note contains explicitly stated price wording and requires empty numeric prices. additionalProperties: false |
kind |
string | Yes | The customer-facing kind: dish (food or drink), experience (experience or class), service (practice area or consultation), or stay (place to stay). Determines the allowed descriptive fields; booking and stock remain separate capabilities. enum: ["dish","experience","service","stay"] |
marketing_features |
array of string (fields) | No | Generic selling bullets. Inclusions, preparation instructions and policies are separate details. maxItems: 15 |
metadata |
object | No | Opaque string annotations for integrations. No pricing, scheduling, stock or filtering behavior may read these. additionalProperties: {"type":"string"} |
name |
string | Yes | |
options |
array of object (fields) | No | maxItems: 3 |
order_url |
string or null | No | External ordering or booking destination, such as Uber Eats, an experience checkout, or Clio Grow. When set, public actions use this URL instead of native booking. Null restores the configured native flow. |
stay |
object (fields) | No | Required for kind stay and refused for every other kind: the location the home is at (fixed once created) and its stay settings. Guest-facing house rules go in details.house_rules. Base nightly rate is the variant price. additionalProperties: false; required: ["location_id","check_in_time","check_out_time","max_guests","min_nights"] |
tax_code |
string or null | No | |
unit_label |
string or null | No | A unit noun such as "person" or "night". Never pricing prose. |
variants |
array of object (fields) | No | Omit to create a single default variant. Required once the product has options. maxItems: 250; minItems: 1 |
additionalProperties: false; required: ["name","kind"]
object or null fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
alt_text |
string or null | No | |
asset_id |
string | Yes | |
duration |
number or null | No | |
height |
number or null | No | |
kind |
string | Yes | enum: ["image","video","file"] |
mime_type |
string or null | No | |
provider |
string | No | |
public_url |
string | Yes | |
status |
string | Yes | enum: ["active"] |
thumbnail_url |
string or null | No | |
width |
number or null | No |
required: ["asset_id","kind","public_url","status"]
array of object fields
Value: array of object.
maxItems: 100; minItems: 1
Array items: object.
array of object fields
Value: array of object.
maxItems: 100; minItems: 1
Array items: object.
array of string fields
Value: array of string.
maxItems: 100; uniqueItems: true
Array items: string.
array of string fields
Value: array of string.
maxItems: 100; uniqueItems: true
Array items: string.
array of string fields
Value: array of string.
maxItems: 100; uniqueItems: true
Array items: string.
array of string fields
Value: array of string.
maxItems: 100; uniqueItems: true
Array items: string.
array of string fields
Value: array of string.
maxItems: 100; uniqueItems: true
Array items: string.
array of string fields
Value: array of string.
maxItems: 100; uniqueItems: true
Array items: string.
array of string fields
Value: array of string.
maxItems: 100; uniqueItems: true
Array items: string.
array of string fields
Value: array of string.
maxItems: 100; uniqueItems: true
Array items: string.
array of string fields
Value: array of string.
maxItems: 100; uniqueItems: true
Array items: string.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
id |
string | No | |
name |
string | Yes | |
sort_order |
integer | No | |
values |
array of object (fields) | Yes | maxItems: 100; minItems: 1 |
additionalProperties: false; required: ["name","values"]
array of string fields
Value: array of string.
uniqueItems: true
Array items: string.
array of object fields
Value: array of object.
Array items: object.
object or null fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
day_of_week_min_nights |
array of integer (fields) | No | Monday-first minimum nights. -1 means this weekday inherits the listing default. maxItems: 7; minItems: 7 |
weekend_price_minor |
integer | No | Whole minor units of the organization currency, e.g. cents. minimum: 0 |
additionalProperties: false
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
active |
boolean | No | |
id |
string | No | |
name |
string | Yes | |
option_values |
object | No | Option id to option value id. Every option must be answered exactly once, and no two variants may answer identically. additionalProperties: {"type":"string"} |
prices |
array of object (fields) | No | maxItems: 20 |
sku |
string or null | No | |
sort_order |
integer | No |
additionalProperties: false; required: ["name"]
object or null fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
missing |
array of string (fields) | Yes | |
ready |
boolean | Yes |
required: ["ready","missing"]
array of object fields
Value: array of object.
Array items: object.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
allergens |
array of string (fields) | No | Allergens the merchant states this dish contains. maxItems: 100; uniqueItems: true |
cancellation_policy |
string | No | The merchant’s stated cancellation terms, displayed publicly; this text does not automate refunds. maxLength: 10000; minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
carbon_monoxide_detector_details |
string | No | Share where each carbon monoxide alarm is located. maxLength: 300; minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
climbing_structures |
boolean | No | Play or climbing structures are available to guests. |
climbing_structures_details |
string | No | Host-authored details about climbing or play structures. Requires its disclosure to be Yes. maxLength: 300; minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
commercial_photography_allowed |
boolean | No | Whether guests may take commercial photos or film at the property. |
dangerous_animals |
boolean | No | Animals that could cause harm live on or near the property. |
dangerous_animals_details |
string | No | Host-authored details about potentially dangerous animals. Requires its disclosure to be Yes. maxLength: 300; minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
dietary_notes |
array of string (fields) | No | Merchant-stated dietary facts displayed with a dish. maxItems: 100; uniqueItems: true |
events_allowed |
boolean | No | Whether guests may host events at the property. |
exterior_security_cameras |
boolean | No | Describe exterior cameras, what they monitor and whether they record audio or video. |
exterior_security_cameras_details |
string | No | Host-authored details about exterior security cameras. Requires its disclosure to be Yes. maxLength: 300; minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
featured |
boolean | No | Highlight this item on the menu and homepage. |
getting_around |
string | No | Host-authored transport and getting-around information for this home. maxLength: 10000; minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
guest_access |
string | No | The spaces and facilities guests can use during their stay. maxLength: 10000; minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
house_rules |
string | No | The host’s rules for guests staying in the home, shown with the listing. maxLength: 10000; minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
included_items |
array of string (fields) | No | Items or work included in the stated price, shown in their own public section. maxItems: 100; uniqueItems: true |
ingredients |
array of string (fields) | No | Ingredients shown in the dish details. maxItems: 100; uniqueItems: true |
interaction_with_guests |
string | No | How guests can contact the host and what support is available. maxLength: 10000; minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
limited_essentials |
boolean | No | Tell guests which everyday essentials are unavailable. |
limited_essentials_details |
string | No | Host-authored details about limited essential amenities. Requires its disclosure to be Yes. maxLength: 300; minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
meeting_point |
string | No | Instructions shown in the meeting section; meeting mode and video links are set in scheduling. maxLength: 10000; minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
nearby_water |
boolean | No | Guests can reach a body of water on or next to the property. |
nearby_water_details |
string | No | Host-authored details about nearby water. Requires its disclosure to be Yes. maxLength: 300; minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
neighborhood_description |
string | No | Host-authored information about the neighborhood around this home. maxLength: 10000; minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
no_property_parking |
boolean | No | Dedicated guest parking is not available on the property. |
no_property_parking_details |
string | No | Host-authored details about no parking on the property. Requires its disclosure to be Yes. maxLength: 300; minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
noise_decibel_monitors |
boolean | No | Devices measure sound levels without recording conversations. |
noise_decibel_monitors_details |
string | No | Host-authored details about noise decibel monitors. Requires its disclosure to be Yes. maxLength: 300; minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
noodle |
array of string (fields) | No | Authored noodle information shown as dish facts; these do not establish purchasable variants. maxItems: 100; uniqueItems: true |
other_details_to_note |
string | No | Additional information guests should know before booking. maxLength: 10000; minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
pets_allowed |
boolean | No | Let guests know if they can bring pets. |
potential_noise |
boolean | No | Guests may hear traffic, construction or other noise. |
potential_noise_details |
string | No | Host-authored details about potential noise during stays. Requires its disclosure to be Yes. maxLength: 300; minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
preparation |
string | No | Preparation instructions shown to customers before a session or appointment. maxLength: 10000; minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
pricing_note |
string | No | An explicitly stated price such as Market price; use only when no numeric price is set. maxLength: 1000; minLength: 1; pattern: "^(?=[\s\S]\S)[^\r\n]$" |
quiet_hours |
boolean | No | Hours when guests should keep noise to a minimum. |
quiet_hours_end |
string | No | Local end of quiet hours, required with quiet hours and its start time. enum: ["00:00","01:00","02:00","03:00","04:00","05:00","06:00","07:00","08:00","09:00","10:00","11:00","12:00","13:00","14:00","15:00","16:00","17:00","18:00","19:00","20:00","21:00","22:00","23:00"]; maxLength: 1000; minLength: 1; pattern: "^(?=[\s\S]\S)[^\r\n]$" |
quiet_hours_start |
string | No | Local start of quiet hours, required with quiet hours and its end time. enum: ["00:00","01:00","02:00","03:00","04:00","05:00","06:00","07:00","08:00","09:00","10:00","11:00","12:00","13:00","14:00","15:00","16:00","17:00","18:00","19:00","20:00","21:00","22:00","23:00"]; maxLength: 1000; minLength: 1; pattern: "^(?=[\s\S]\S)[^\r\n]$" |
resident_pets |
boolean | No | Guests may encounter animals that live here. |
resident_pets_details |
string | No | Host-authored details about pets live on the property. Requires its disclosure to be Yes. maxLength: 300; minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
shared_spaces |
boolean | No | Guests share some spaces with other people. |
shared_spaces_details |
string | No | Host-authored details about shared spaces. Requires its disclosure to be Yes. maxLength: 300; minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
sizes |
array of string (fields) | No | Authored serving information; priced choices belong in variants. maxItems: 100; uniqueItems: true |
smoke_detector_details |
string | No | Share where each smoke alarm is located. maxLength: 300; minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
smoking_allowed |
boolean | No | Whether guests may smoke or vape at the property. |
soup |
array of string (fields) | No | Authored soup information shown with the dish. maxItems: 100; uniqueItems: true |
special_safety_considerations |
string | No | Other property features that guests should know could be unsafe, and why. maxLength: 300; minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
stairs_required |
boolean | No | Guests need to use stairs during their stay. |
stairs_required_details |
string | No | Host-authored details about guests must climb stairs. Requires its disclosure to be Yes. maxLength: 300; minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
tagline |
string | No | A short sentence shown below the product title. maxLength: 1000; minLength: 1; pattern: "^(?=[\s\S]\S)[^\r\n]$" |
toppings |
array of string (fields) | No | Authored topping information; priced choices belong in variants. maxItems: 100; uniqueItems: true |
unprotected_heights |
boolean | No | Elevated areas are accessible without a railing or other protection. |
unprotected_heights_details |
string | No | Host-authored details about unprotected heights. Requires its disclosure to be Yes. maxLength: 300; minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
unsecured_pool |
boolean | No | Guests can reach a pool or hot tub without a gate or lock. |
unsecured_pool_details |
string | No | Host-authored details about unsecured pool or hot tub. Requires its disclosure to be Yes. maxLength: 300; minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
weapons_on_property |
boolean | No | Tell guests about weapons stored on the property. |
weapons_on_property_details |
string | No | Host-authored details about weapons on the property. Requires its disclosure to be Yes. maxLength: 300; minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
what_to_bring |
array of string (fields) | No | Items customers should bring, shown in the preparation section. maxItems: 100; uniqueItems: true |
your_property |
string | No | The spaces and features guests should know about this home. maxLength: 10000; minLength: 1; pattern: "^[\s\S]\S[\s\S]$" |
additionalProperties: false
object or null fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
alt_text |
string or null | No | |
asset_id |
string | Yes | |
duration |
number or null | No | |
height |
number or null | No | |
kind |
string | Yes | enum: ["image","video","file"] |
mime_type |
string or null | No | |
provider |
string | No | |
public_url |
string | Yes | |
status |
string | Yes | enum: ["active"] |
thumbnail_url |
string or null | No | |
width |
number or null | No |
required: ["asset_id","kind","public_url","status"]
array of object fields
Value: array of object.
Array items: object.
array of object fields
Value: array of object.
Array items: object.
object or null fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
id |
string | Yes | |
path |
string | Yes | |
title |
string | Yes |
required: ["id","path","title"]
array of object fields
Value: array of object.
Array items: object.
object or null fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
accessibility |
array of object (fields) | Yes | All six home accessibility features in catalog order, including unanswered null rows. maxItems: 6; minItems: 6 |
amenities |
array of string (fields) | Yes | Amenity codes the home offers. Empty means no positive amenity answers. uniqueItems: true |
amenity_answers |
array of object (fields) | Yes | Explicit amenity reports, each code once, in catalog order. Missing codes are unknown. amenities is the true-only projection. |
assigned_member_id |
string or null | Yes | Better Auth organization membership ID of the home’s assigned host; null when no individual host is selected. |
assigned_team_id |
string or null | Yes | Better Auth team ID assigned to host and look after the home; null when no team is selected. |
bathrooms |
number or null | Yes | Whole and half baths, such as 1.5. maximum: 50; minimum: 0; multipleOf: 0.5 |
bedrooms |
integer or null | Yes | Bedrooms; 0 is a studio. maximum: 50; minimum: 0 |
beds |
integer or null | Yes | maximum: 50; minimum: 1 |
calendar_rules |
object or null (fields) | Yes | Actual optional listing rules. Null removes them. Dated overrides take precedence over weekday minimums, then the required default. Friday/Saturday use the weekend price when supplied. additionalProperties: false |
cancellation_policy |
string | Yes | Policy shown to guests for stays under 28 nights. A home always has one: a new home starts on Flexible, as a new Airbnb listing does, and an Airbnb import takes the listing’s own. It does not refund by itself. enum: ["flexible","moderate","limited","firm","strict"] |
check_in_end_time |
string or null | Yes | Local 24-hour end of the check-in window; null is a flexible end. A time earlier than check_in_time is after midnight. pattern: "^([01]\d|2[0-3]):[0-5]\d$" |
check_in_time |
string | Yes | Local 24-hour time guests may arrive from, in the location’s timezone. pattern: "^([01]\d|2[0-3]):[0-5]\d$" |
check_out_time |
string | Yes | Local 24-hour time guests leave by. pattern: "^([01]\d|2[0-3]):[0-5]\d$" |
listing_floor |
integer or null | Yes | The listing’s floor, counted from 1. Cannot exceed total_floors when both are known; null when not said. maximum: 9007199254740991; minimum: 1 |
listing_type |
string or null | Yes | Whether guests book the entire place, a private room or a shared room. Null when not said. enum: ["entire_place","private_room","shared_room",null] |
location_id |
string | Yes | |
long_term_cancellation_policy |
string | Yes | Policy shown to guests for stays of 28 nights or more. A home always has one: a new home starts on Firm Long Term, as a new Airbnb listing does, and an Airbnb import takes the listing’s own. enum: ["firm","strict"] |
max_guests |
integer | Yes | maximum: 99; minimum: 1 |
min_nights |
integer | Yes | The listing’s required default minimum; individual arrival dates may override it. maximum: 1125; minimum: 1 |
photo_rooms |
array of object (fields) | Yes | |
property_size |
number or null | Yes | Property area in property_size_unit. Size and unit must both be set or both null. exclusiveMinimum: 0 |
property_size_unit |
string or null | Yes | The unit of property_size. Size and unit must both be set or both null. enum: ["square_meters","square_feet",null] |
property_type |
string or null | Yes | Airbnb property type, one the property_type_group offers. Null with property_type_group when not said. enum: ["apartment","condominium","serviced_apartment","loft","house","townhouse","bungalow","cabin","chalet","earthhouse","hut","lighthouse","villa","dome","cottage","farmstay","houseboat","tiny_house","guesthouse","private_suite","boat","castle","cave","igloo","island","plane","rv","tent","tipi","train","treehouse","yurt","other","barn","campsite","windmill","bus","holiday_park","ranch","religious_building","riad","shipping_container","tower","bnb","nature_eco_lodge","boutique_hotel","hostel","aparthotel","hotel","resort",null] |
property_type_group |
string or null | Yes | Airbnb's property group: apartments (Apartment: apartment, condominium, serviced_apartment, loft); houses (House: house, townhouse, bungalow, cabin, chalet, earthhouse, hut, lighthouse, villa, dome, cottage, farmstay, houseboat, tiny_house); secondary_units (Secondary unit: guesthouse, private_suite, farmstay); unique_homes (Unique space: boat, castle, cave, earthhouse, hut, igloo, island, lighthouse, plane, rv, tent, tipi, train, treehouse, yurt, other, dome, barn, campsite, farmstay, houseboat, tiny_house, windmill, bus, holiday_park, ranch, religious_building, riad, shipping_container, tower); bnb (Bed and breakfast: bnb, nature_eco_lodge, farmstay); boutique_hotels_and_more (Boutique hotel: boutique_hotel, nature_eco_lodge, hostel, serviced_apartment, aparthotel, hotel, resort). enum: ["apartments","houses","secondary_units","unique_homes","bnb","boutique_hotels_and_more",null] |
questions |
array of object (fields) | Yes | The host's own questions asked with each direct stay booking. maxItems: 20 |
questions_revision |
string | Yes | Send as expected_questions_revision when replacing questions, and as questions_revision when submitting answers. |
total_floors |
integer or null | Yes | Total floors in the property; null when not said. maximum: 9007199254740991; minimum: 1 |
year_built |
integer or null | Yes | Year the property was built; null when not said. maximum: 9007199254740991; minimum: 1 |
required: ["location_id","check_in_time","check_in_end_time","check_out_time","max_guests","min_nights","calendar_rules","assigned_member_id","assigned_team_id","photo_rooms","accessibility","questions","questions_revision","property_type_group","property_type","listing_type","total_floors","listing_floor","year_built","property_size","property_size_unit","bedrooms","beds","bathrooms","amenities","amenity_answers","cancellation_policy","long_term_cancellation_policy"]
array of object fields
Value: array of object.
Array items: object.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
dish |
integer | Yes | minimum: 0 |
experience |
integer | Yes | minimum: 0 |
service |
integer | Yes | minimum: 0 |
stay |
integer | Yes | minimum: 0 |
additionalProperties: false; required: ["dish","experience","service","stay"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
active |
boolean | Yes | |
collections |
array of object (fields) | Yes | |
featured |
boolean | Yes | |
id |
string | Yes | |
kind |
string | Yes | enum: ["dish","experience","service","stay"] |
locations |
array of object (fields) | Yes | |
name |
string | Yes | |
prices |
array of object (fields) | Yes | |
pricing_note |
string | No | |
publications |
array of object (fields) | Yes | |
slug |
string | Yes | |
variant_count |
integer | Yes |
required: ["id","kind","name","slug","active","featured","variant_count","collections","publications","locations","prices"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
active |
boolean | No | Enable or disable this product. Increasing the number of live homes requires the dashboard. |
description |
string | No | |
details |
object (fields) | No | Named customer-facing facts for the product kind. This is a complete replacement map; preserve fields to retain. pricing_note contains explicitly stated price wording and requires empty numeric prices. additionalProperties: false |
kind |
string | Yes | The customer-facing kind: dish (food or drink), experience (experience or class), service (practice area or consultation), or stay (place to stay). Determines the allowed descriptive fields; booking and stock remain separate capabilities. enum: ["dish","experience","service","stay"] |
marketing_features |
array of string (fields) | No | Generic selling bullets. Inclusions, preparation instructions and policies are separate details. maxItems: 15 |
metadata |
object | No | Opaque string annotations for integrations. No pricing, scheduling, stock or filtering behavior may read these. additionalProperties: {"type":"string"} |
name |
string | Yes | |
options |
array of object (fields) | No | maxItems: 3 |
order_url |
string or null | No | External ordering or booking destination, such as Uber Eats, an experience checkout, or Clio Grow. When set, public actions use this URL instead of native booking. Null restores the configured native flow. |
product_id |
string | No | minLength: 1 |
stay |
object (fields) | No | Required for kind stay and refused for every other kind: the location the home is at (fixed once created) and its stay settings. Guest-facing house rules go in details.house_rules. Base nightly rate is the variant price. additionalProperties: false; required: ["location_id","check_in_time","check_out_time","max_guests","min_nights"] |
tax_code |
string or null | No | |
unit_label |
string or null | No | A unit noun such as "person" or "night". Never pricing prose. |
variants |
array of object (fields) | No | Omit to create a single default variant. Required once the product has options. maxItems: 250; minItems: 1 |
additionalProperties: false; required: ["name","kind"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
start_time |
string | Yes | Local HH:mm time. |
weekday |
integer | Yes | maximum: 6; minimum: 0 |
additionalProperties: false; required: ["weekday","start_time"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
id |
string | Yes | |
location_id |
string | Yes | |
organization_id |
string | Yes | |
product_id |
string | Yes | |
start_time |
string | Yes | |
timezone |
string | Yes | |
weekday |
integer | Yes | maximum: 6; minimum: 0 |
additionalProperties: false; required: ["id","organization_id","product_id","location_id","timezone","weekday","start_time"]
array of object fields
Value: array of object.
Array items: object.
array of object fields
Value: array of object.
maxItems: 20
Array items: object.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
collection_id |
string | No | |
items |
array of object (fields) | Yes | maxItems: 100; minItems: 1 |
name |
string | Yes | minLength: 1 |
additionalProperties: false; required: ["name","items"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
collection |
object (fields) | Yes | additionalProperties: false; required: ["id","organization_id","location_id","name","slug","description","image","sort_order"] |
products |
array of object (fields) | Yes |
additionalProperties: false; required: ["collection","products"]
array of string or null fields
Value: array of string or null.
string or null fields
Value: string or null.
string or null fields
Value: string or null.
string or null fields
Value: string or null.
string or null fields
Value: string or null.
array of string or null fields
Value: array of string or null.
string or null fields
Value: string or null.
string or null fields
Value: string or null.
string or null fields
Value: string or null.
string or null fields
Value: string or null.
array of string or null fields
Value: array of string or null.
array of string or null fields
Value: array of string or null.
string or null fields
Value: string or null.
string or null fields
Value: string or null.
string or null fields
Value: string or null.
string or null fields
Value: string or null.
string or null fields
Value: string or null.
string or null fields
Value: string or null.
string or null fields
Value: string or null.
array of string or null fields
Value: array of string or null.
string or null fields
Value: string or null.
string or null fields
Value: string or null.
string or null fields
Value: string or null.
string or null fields
Value: string or null.
string or null fields
Value: string or null.
string or null fields
Value: string or null.
string or null fields
Value: string or null.
string or null fields
Value: string or null.
array of string or null fields
Value: array of string or null.
string or null fields
Value: string or null.
array of string or null fields
Value: array of string or null.
string or null fields
Value: string or null.
string or null fields
Value: string or null.
string or null fields
Value: string or null.
array of string or null fields
Value: array of string or null.
string or null fields
Value: string or null.
string or null fields
Value: string or null.
string or null fields
Value: string or null.
array of string or null fields
Value: array of string or null.
string or null fields
Value: string or null.
array of object fields
Value: array of object.
maxItems: 20
Array items: object.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
active |
boolean | No | |
id |
string | No | |
name |
string | No | |
option_values |
object | No | Option id to option value id. Every option must be answered exactly once, and no two variants may answer identically. additionalProperties: {"type":"string"} |
prices |
array of object (fields) | No | Partial existing prices by id or new offers. Omitted prices remain unless prices_mode is replace. A new offer requires unit_amount. maxItems: 20 |
prices_mode |
string | No | merge keeps prices omitted from the supplied list. replace explicitly removes omitted prices; an empty list clears them. Applies only with prices. default: "merge"; enum: ["merge","replace"] |
sku |
string or null | No | |
sort_order |
integer | No |
additionalProperties: false; required: []
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
id |
string | Yes | |
image |
string or null | Yes | |
name |
string | Yes | |
scheduling |
object or null (fields) | Yes | additionalProperties: false; required: ["member_id","timezone","updated_at","weekly","time_off","calendar_account_id","calendar_ids","calendar_status","busy_from","busy_until","busy_checked_at","busy_error","calendar_conflict_count","calendar_conflicts"] |
self |
boolean | Yes |
required: ["id","name","image","self","scheduling"]
array of object fields
Value: array of object.
Array items: object.
array or null fields
Value: array or null.
Array items: object.
array or null fields
Value: array or null.
Array items: object.
string fields
Value: string.
maxLength: 1024; minLength: 1
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
end |
string | Yes | format: "date-time" |
start |
string | Yes | format: "date-time" |
additionalProperties: false; required: ["start","end"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
end |
string | Yes | pattern: "^([01][0-9]|2[0-3]):[0-5][0-9]$" |
start |
string | Yes | pattern: "^([01][0-9]|2[0-3]):[0-5][0-9]$" |
weekday |
integer | Yes | maximum: 6; minimum: 0 |
additionalProperties: false; required: ["weekday","start","end"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
answer |
string or null | Yes | |
created_at |
string | Yes | |
id |
string | Yes | |
location_id |
string or null | Yes | |
question |
string | Yes | |
sort_order |
number | Yes | |
source |
string | Yes | |
status |
string | Yes | enum: ["published","hidden"] |
updated_at |
string | Yes |
required: ["id","question","answer","sort_order","location_id","source","status","created_at","updated_at"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
id |
string | Yes | minLength: 1 |
sort_order |
integer | Yes |
additionalProperties: false; required: ["id","sort_order"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
author_name |
string or null | No | |
category_ratings |
array of object (fields) | No | The guest's optional 1-5 scores for the visit's fixed questions; a skipped question has no entry. |
collection_method |
string or null | No | |
content |
string or null | No | |
created_at |
string or null | Yes | |
id |
string | Yes | |
location_id |
string or null | No | |
original_reference |
string or null | No | |
original_review_date |
string or null | No | |
owner_reply |
string or null | No | |
private_feedback |
string or null | No | What the guest told the business privately. Never published. |
publication_authorized |
boolean | Yes | |
rating |
number | Yes | |
source |
string | Yes | |
status |
string | Yes | |
title |
string or null | No | |
updated_at |
string | Yes | |
verified |
boolean | Yes |
required: ["id","rating","source","status","created_at","updated_at","publication_authorized","verified"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
expected_room_id |
string or null | Yes | Containing room’s id from get_product → product.stay.photo_rooms; null if no room contains this photo. A changed membership refuses the whole assignment. |
photo_id |
string | Yes | Image or video asset ID already placed on this home: get_product → product.image.asset_id or product.gallery[].asset_id. minLength: 1 |
additionalProperties: false; required: ["photo_id","expected_room_id"]
array of string fields
Value: array of string.
uniqueItems: true
Array items: string.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
photo_id |
string | Yes | minLength: 1 |
room_id |
string or null | Yes |
additionalProperties: false; required: ["photo_id","room_id"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
adults |
integer | Yes | |
answers |
array of object (fields) | Yes | The guest's answers to the home's questions, worded as they answered them. The stay keeps them even when its conversation is deleted. |
arrival_time |
string or null | Yes | pattern: "^([01]\d|2[0-3]):[0-5]\d$" |
cancellation_policy |
string or null | Yes | The home cancellation policy the guest booked under on the site; it decides what their own cancellation refunds. Null for a stay not paid on the site. enum: ["flexible","moderate","limited","firm","strict","long_term_firm","long_term_strict",null] |
cancellation_reason |
string or null | Yes | |
cancelled_at |
string or null | Yes | |
channel |
string | Yes | enum: ["airbnb","vrbo","booking_com","direct"] |
channel_booking_id |
string or null | Yes | |
channel_booking_url |
string or null | Yes | The reservation on its channel (Airbnb's host reservation page), where a channel stay is changed or cancelled. Null for other stays. |
channel_push |
object or null (fields) | No | What the home's connected channel took from this change: null when no channel push is needed; pushed when delivery completed; pending, with the reason, while it waits out Channex's rate limit or an unconfirmed attempt it sends again. A refused channel update returns a committed error. |
check_in_date |
string | Yes | pattern: "^\d{4}-\d{2}-\d{2}$" |
check_out_date |
string | Yes | pattern: "^\d{4}-\d{2}-\d{2}$" |
children |
integer | Yes | |
created_at |
string | Yes | minLength: 1 |
currency |
string | Yes | minLength: 1 |
external_booking_id |
string or null | Yes | |
guest_email |
string or null | Yes | |
guest_image_url |
string or null | Yes | The linked Better Auth account’s current portrait. Null for guests without an account portrait. |
guest_name |
string or null | Yes | |
guest_phone |
string or null | Yes | |
guest_surname |
string or null | Yes | |
id |
string | Yes | minLength: 1 |
infants |
integer | Yes | |
location_id |
string | Yes | minLength: 1 |
no_show_at |
string or null | Yes | When the host recorded that the guest never arrived; null otherwise. |
notes |
string or null | Yes | |
online_payment |
object or null (fields) | Yes | The Stripe payment the guest made when booking this stay on the site; null for a stay booked any other way. paid_minor counts it net of refunds. required: ["payment_id","state","currency","amount_minor","captured_minor","refunded_minor","receipt_url","created_at"] |
overbooked |
boolean | Yes | |
owner |
string | Yes | enum: ["app","channel"] |
paid_minor |
integer | Yes | |
payment_status |
string or null | Yes | enum: ["unpaid","partial","paid","overpaid",null] |
payments |
array of object (fields) | Yes | |
product_id |
string | Yes | minLength: 1 |
provider |
string or null | Yes | |
request_id |
string or null | Yes | The guest conversation about this stay, for get_guest_conversation and reply_to_guest. Null until a named guest with email or phone opens one; an existing conversation is retained. |
status |
string | Yes | enum: ["pending","confirmed","cancelled"] |
timezone |
string | Yes | minLength: 1 |
total_minor |
integer | Yes | |
updated_at |
string | Yes | minLength: 1 |
user_id |
string or null | Yes | |
version |
integer | Yes |
required: ["id","product_id","location_id","timezone","channel","owner","status","overbooked","check_in_date","check_out_date","arrival_time","adults","children","infants","guest_name","guest_surname","guest_email","guest_phone","user_id","total_minor","currency","notes","provider","external_booking_id","channel_booking_id","channel_booking_url","request_id","cancelled_at","cancellation_reason","cancellation_policy","no_show_at","answers","version","created_at","updated_at","guest_image_url","payments","online_payment","paid_minor","payment_status"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
adults |
integer | Yes | |
arrival_time |
string or null | Yes | pattern: "^([01]\d|2[0-3]):[0-5]\d$" |
check_in_date |
string | Yes | pattern: "^\d{4}-\d{2}-\d{2}$" |
check_out_date |
string | Yes | pattern: "^\d{4}-\d{2}-\d{2}$" |
children |
integer | Yes | |
guest_name |
string or null | Yes | |
id |
string | Yes | minLength: 1 |
infants |
integer | Yes | |
location_id |
string | Yes | minLength: 1 |
no_show_at |
string or null | Yes | When the host recorded that the guest never arrived; null otherwise. |
product_id |
string | Yes | minLength: 1 |
status |
string | Yes | enum: ["pending","confirmed","cancelled"] |
timezone |
string | Yes | minLength: 1 |
additionalProperties: false; required: ["id","product_id","location_id","timezone","status","check_in_date","check_out_date","arrival_time","adults","children","infants","guest_name","no_show_at"]
object or null fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
provider |
string | Yes | enum: ["channex"] |
status |
string | Yes | enum: ["importing","connected","disconnected"] |
required: ["provider","status"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
available |
boolean | Yes | |
calendar |
string or null | Yes | The linked calendar (Vrbo) that shows this night taken; null when none does. Such a night is not available. enum: ["vrbo",null] |
channel |
object or null (fields) | Yes | required: ["state","detail"] |
closed |
boolean | Yes | |
closed_to_arrival |
boolean | Yes | |
closed_to_departure |
boolean | Yes | |
date |
string | Yes | pattern: "^\d{4}-\d{2}-\d{2}$" |
held_until |
string or null | Yes | When a guest checkout hold on this night lapses; null when no guest is paying for it. A held night is not available. |
max_stay |
integer or null | Yes | |
min_stay_arrival |
integer | Yes | |
price_minor |
integer or null | Yes | |
source |
string or null | Yes | enum: ["host","import",null] |
stay_id |
string or null | Yes |
required: ["date","available","stay_id","closed","price_minor","min_stay_arrival","max_stay","closed_to_arrival","closed_to_departure","source","held_until","calendar","channel"]
object fields
Value: object.
object fields
Value: object.
integer fields
Value: integer.
maximum: 6; minimum: 0
array of string fields
Value: array of string.
maxItems: 50; uniqueItems: true
Array items: string.
See schema fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
available |
boolean | No | const: true |
photo_ids |
See schema | No | minItems: 1 |
See schema fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
available |
enum | No | enum: [false,null] |
photo_ids |
See schema | No | maxItems: 0 |
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
available |
boolean or null | Yes | The host’s answer; null is unanswered. No review or approval is implied. |
feature |
string | Yes | enum: ["disabled_parking_spot","path_to_entrance_lit_at_night","home_step_free_access","home_wide_doorway","pool_hoist","ceiling_hoist"] |
photo_ids |
array of string (fields) | Yes | Evidence image IDs in the home’s Product photo order. Empty for false or unknown answers. maxItems: 50; uniqueItems: true |
additionalProperties: false; required: ["feature","available","photo_ids"]
string fields
Value: string.
enum: ["ac","dryer","essentials","heating","hot_water","kitchen","tv","washer","wireless_internet","bathtub","bidet","body_soap","cleaning_products","conditioner","hair_dryer","alfresco_shower","shampoo","shower_gel","bed_linens","wardrobe_or_closet","clothes_drying_rack","extra_pillows_and_blankets","hangers","iron","mosquito_net","room_darkening_shades","safe","arcade_machine","batting_cage","books","bowling_alley","climbing_wall","ethernet_connection","exercise_equipment","game_console","laser_tag","life_size_games","mini_golf","home_theater","piano","ping_pong_table","pool_table","record_player","skate_ramp","sound_system","theme_room","baby_bath","baby_monitor","childrens_bike","playroom","stair_gates","babysitter_recommendations","board_games","changing_table","childrens_books_and_toys","childrens_dinnerware","crib","fireplace_guards","high_chair","playground","outlet_covers","pack_n_play_travel_crib","table_corner_guards","window_guards","ceiling_fan","fireplace","portable_fans","carbon_monoxide_detector","fire_extinguisher","first_aid_kit","smoke_detector","laptop_friendly_workspace","pocket_wifi","baking_sheet","barbeque_utensils","bread_maker","blender","coffee","coffee_maker","cooking_basics","dining_table","dishes_and_silverware","dishwasher","freezer","hot_water_kettle","kitchenette","microwave","mini_fridge","oven","refrigerator","rice_maker","stove","toaster","trash_compacter","wine_glasses","beach_access","lake_access","laundromat_nearby","private_entrance","resort_access","ski_in_ski_out","waterfront","garden_or_backyard","bbq_area","beach_essentials","bicycle","boat_slip","fire_pit","hammock","kayak","alfresco_dining","outdoor_seating","outdoor_kitchen","patio_or_belcony","sun_loungers","free_parking","street_parking","paid_parking_on_premises","paid_parking","free_parking_off_premises","elevator","ev_charger","hockey_rink","gym","jacuzzi","pool","private_living_room","sauna","single_level_home","ebike_charger","solar_power","recycling","composting","doorman","gated_community","breakfast","cleaning_before_checkout","long_term_stays_allowed","luggage_dropoff_allowed","bay_view","beach_view","canal_view","city_view","courtyard_view","desert_view","garden_view","golf_view","harbor_view","lake_view","marina_view","mountain_view","ocean_view","park_view","pool_view","resort_view","river_view","sea_view","valley_view","vineyard_view","landmark_view"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
count |
integer | Yes | maximum: 50; minimum: 1 |
type |
string | Yes | enum: ["single","double","queen","king","small_double","bunk_bed","sofa_bed","couch","floor_mattress","air_mattress","crib","toddler_bed","hammock","water_bed"] |
additionalProperties: false; required: ["type","count"]
array of object fields
Value: array of object.
maxItems: 2
Array items: object.
array of string fields
Value: array of string.
uniqueItems: true
Array items: string.
array or null fields
Value: array or null.
maxItems: 14
Array items: object.
array of object fields
Value: array of object.
Array items: object.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
email |
string or null | Yes | |
name |
string or null | Yes | |
phone |
string or null | Yes |
required: ["name","email","phone"]
object or null fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
check_in_date |
string or null | Yes | |
check_out_date |
string or null | Yes | |
ends_at |
string | Yes | |
id |
string | Yes | |
kind |
string | Yes | enum: ["booking","reservation","stay"] |
party_size |
integer | Yes | |
starts_at |
string | Yes | |
status |
string | Yes | |
timezone |
string | Yes |
required: ["id","kind","status","starts_at","ends_at","timezone","party_size","check_in_date","check_out_date"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
guest_name |
string or null | Yes | |
operational_status |
string or null | Yes | |
participant_label |
string | Yes | |
preview |
string or null | Yes | |
reply_channel |
string | Yes | enum: ["email","airbnb"] |
request_id |
string | Yes | |
state |
string | Yes | |
type |
string | Yes | |
updated_at |
string | Yes |
required: ["request_id","guest_name","participant_label","reply_channel","type","state","operational_status","preview","updated_at"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
created_at |
string | Yes | |
date |
string or null | Yes | |
email |
string or null | No | |
guests |
string or null | Yes | |
id |
string | Yes | Inbox request ID. |
location_id |
string or null | Yes | |
location_title |
string or null | No | |
name |
string or null | No | |
operational_reservation_id |
string | Yes | Use this ID to manage the reservation. |
phone |
string or null | No | |
request_id |
string | Yes | |
requests |
string or null | No | |
status |
string | Yes | enum: ["confirmed","cancelled"] |
time |
string or null | Yes | |
updated_at |
string | Yes |
required: ["id","request_id","operational_reservation_id","updated_at","status","created_at","guests","date","time","location_id"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
email |
string | Yes | |
id |
string | Yes | |
image |
string or null | Yes | |
memberId |
string | Yes | |
name |
string | Yes | |
role |
string | Yes |
required: ["id","memberId","name","image","email","role"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
canLeave |
boolean | Yes | |
canManage |
boolean | Yes | |
createdAt |
string | Yes | |
createdByUserId |
string or null | Yes | |
id |
string | Yes | |
isGroup |
boolean | Yes | |
lastMessage |
object or null (fields) | Yes | required: ["id","senderId","body","attachmentCount","createdAt"] |
lastMessageAt |
string | Yes | |
location |
object or null (fields) | Yes | required: ["id","title","slug","timezone"] |
locationId |
string or null | Yes | |
name |
string or null | Yes | |
participants |
array of object (fields) | Yes | |
stay |
object or null (fields) | Yes | required: ["id","productId","homeName","checkInDate","checkOutDate","status"] |
stayId |
string or null | Yes | |
unread |
boolean | Yes | |
unreadCount |
integer | Yes |
required: ["id","createdAt","lastMessageAt","stayId","locationId","name","isGroup","createdByUserId","canManage","canLeave","participants","unread","unreadCount","stay","location","lastMessage"]
array of object fields
Value: array of object.
Array items: object.
array of object fields
Value: array of object.
Array items: object.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
count |
integer | Yes | maximum: 9007199254740991; minimum: 0 |
eventName |
string | Yes | |
status |
string | Yes |
additionalProperties: false; required: ["eventName","status","count"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
confirmed |
integer | Yes | maximum: 9007199254740991; minimum: 0 |
intent |
integer | Yes | maximum: 9007199254740991; minimum: 0 |
locationId |
string or null | Yes | |
paid |
integer | Yes | maximum: 9007199254740991; minimum: 0 |
paidCollected |
array of object (fields) | Yes | |
submitted |
integer | Yes | maximum: 9007199254740991; minimum: 0 |
viewed |
integer | Yes | maximum: 9007199254740991; minimum: 0 |
visits |
integer | Yes | maximum: 9007199254740991; minimum: 0 |
additionalProperties: false; required: ["locationId","visits","viewed","intent","submitted","confirmed","paid","paidCollected"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
channel |
string | Yes | enum: ["Google Ads","Instagram","Facebook","Organic search","Direct","Referral","Other","Not recorded"] |
confirmed |
integer | Yes | maximum: 9007199254740991; minimum: 0 |
intent |
integer | Yes | maximum: 9007199254740991; minimum: 0 |
paid |
integer | Yes | maximum: 9007199254740991; minimum: 0 |
paidCollected |
array of object (fields) | Yes | |
submitted |
integer | Yes | maximum: 9007199254740991; minimum: 0 |
viewed |
integer | Yes | maximum: 9007199254740991; minimum: 0 |
visits |
integer | Yes | maximum: 9007199254740991; minimum: 0 |
additionalProperties: false; required: ["channel","visits","viewed","intent","submitted","confirmed","paid","paidCollected"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
collectedMinor |
number | Yes | |
currency |
string | Yes |
additionalProperties: false; required: ["currency","collectedMinor"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
campaign |
string or null | Yes | |
content |
string or null | Yes | |
firstPaidSignups |
integer | Yes | maximum: 9007199254740991; minimum: 0 |
medium |
string or null | Yes | |
onboardedSignups |
integer | Yes | maximum: 9007199254740991; minimum: 0 |
revenue |
array of object (fields) | Yes | |
signups |
integer | Yes | maximum: 9007199254740991; minimum: 0 |
source |
string or null | Yes |
additionalProperties: false; required: ["source","medium","campaign","content","signups","onboardedSignups","firstPaidSignups","revenue"]
#/$defs/content_heading or #/$defs/content_markdown or #/$defs/content_image or #/$defs/content_gallery or #/$defs/content_video or #/$defs/content_faq or #/$defs/content_how_to or #/$defs/content_divider or #/$defs/content_ai_assistance or #/$defs/content_cta or #/$defs/content_callout fields
Value: #/$defs/content_heading or #/$defs/content_markdown or #/$defs/content_image or #/$defs/content_gallery or #/$defs/content_video or #/$defs/content_faq or #/$defs/content_how_to or #/$defs/content_divider or #/$defs/content_ai_assistance or #/$defs/content_cta or #/$defs/content_callout.
anyOf: shape 1, shape 2, shape 3, shape 4, shape 5, shape 6, shape 7, shape 8, shape 9, shape 10, shape 11.
array of #/$defs/content_block_media fields
Value: array of #/$defs/content_block_media.
Array items: #/$defs/content_block_media.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
data |
object (fields) | Yes | additionalProperties: false; required: ["text"] |
id |
string | No | |
level |
number or null | No | |
media |
array of #/$defs/content_block_media (fields) | No | Required on image blocks: one item, the picture. A block read back keeps its media by sending it as read. |
parent_block_id |
string or null | No | |
source_block_id |
string or null | No | |
type |
string | Yes | const: "heading" |
updated_at |
string or null | No | As read. Ignored on a whole-document write. |
additionalProperties: false; required: ["type","data"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
data |
object (fields) | Yes | additionalProperties: false; required: ["markdown","editor_mode"] |
id |
string | No | |
level |
number or null | No | |
media |
array of #/$defs/content_block_media (fields) | No | Required on image blocks: one item, the picture. A block read back keeps its media by sending it as read. |
parent_block_id |
string or null | No | |
source_block_id |
string or null | No | |
type |
string | Yes | const: "markdown" |
updated_at |
string or null | No | As read. Ignored on a whole-document write. |
additionalProperties: false; required: ["type","data"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
data |
object (fields) | Yes | additionalProperties: false; required: [] |
id |
string | No | |
level |
number or null | No | |
media |
array of #/$defs/content_block_media (fields) | No | Required on image blocks: one item, the picture. A block read back keeps its media by sending it as read. |
parent_block_id |
string or null | No | |
source_block_id |
string or null | No | |
type |
string | Yes | const: "image" |
updated_at |
string or null | No | As read. Ignored on a whole-document write. |
additionalProperties: false; required: ["type","data"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
data |
object (fields) | Yes | additionalProperties: false; required: [] |
id |
string | No | |
level |
number or null | No | |
media |
array of #/$defs/content_block_media (fields) | No | Required on image blocks: one item, the picture. A block read back keeps its media by sending it as read. |
parent_block_id |
string or null | No | |
source_block_id |
string or null | No | |
type |
string | Yes | const: "gallery" |
updated_at |
string or null | No | As read. Ignored on a whole-document write. |
additionalProperties: false; required: ["type","data"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
data |
object (fields) | Yes | additionalProperties: false; required: ["url","title"] |
id |
string | No | |
level |
number or null | No | |
media |
array of #/$defs/content_block_media (fields) | No | Required on image blocks: one item, the picture. A block read back keeps its media by sending it as read. |
parent_block_id |
string or null | No | |
source_block_id |
string or null | No | |
type |
string | Yes | const: "video" |
updated_at |
string or null | No | As read. Ignored on a whole-document write. |
additionalProperties: false; required: ["type","data"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
data |
object (fields) | Yes | additionalProperties: false; required: ["source"] |
id |
string | No | |
level |
number or null | No | |
media |
array of #/$defs/content_block_media (fields) | No | Required on image blocks: one item, the picture. A block read back keeps its media by sending it as read. |
parent_block_id |
string or null | No | |
source_block_id |
string or null | No | |
type |
string | Yes | const: "faq" |
updated_at |
string or null | No | As read. Ignored on a whole-document write. |
additionalProperties: false; required: ["type","data"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
data |
object (fields) | Yes | additionalProperties: false; required: ["steps"] |
id |
string | No | |
level |
number or null | No | |
media |
array of #/$defs/content_block_media (fields) | No | Required on image blocks: one item, the picture. A block read back keeps its media by sending it as read. |
parent_block_id |
string or null | No | |
source_block_id |
string or null | No | |
type |
string | Yes | const: "how_to" |
updated_at |
string or null | No | As read. Ignored on a whole-document write. |
additionalProperties: false; required: ["type","data"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
data |
object (fields) | Yes | additionalProperties: false; required: [] |
id |
string | No | |
level |
number or null | No | |
media |
array of #/$defs/content_block_media (fields) | No | Required on image blocks: one item, the picture. A block read back keeps its media by sending it as read. |
parent_block_id |
string or null | No | |
source_block_id |
string or null | No | |
type |
string | Yes | const: "divider" |
updated_at |
string or null | No | As read. Ignored on a whole-document write. |
additionalProperties: false; required: ["type","data"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
data |
object (fields) | Yes | additionalProperties: false; required: [] |
id |
string | No | |
level |
number or null | No | |
media |
array of #/$defs/content_block_media (fields) | No | Required on image blocks: one item, the picture. A block read back keeps its media by sending it as read. |
parent_block_id |
string or null | No | |
source_block_id |
string or null | No | |
type |
string | Yes | const: "ai_assistance" |
updated_at |
string or null | No | As read. Ignored on a whole-document write. |
additionalProperties: false; required: ["type","data"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
data |
object (fields) | Yes | additionalProperties: false; required: [] |
id |
string | No | |
level |
number or null | No | |
media |
array of #/$defs/content_block_media (fields) | No | Required on image blocks: one item, the picture. A block read back keeps its media by sending it as read. |
parent_block_id |
string or null | No | |
source_block_id |
string or null | No | |
type |
string | Yes | const: "cta" |
updated_at |
string or null | No | As read. Ignored on a whole-document write. |
additionalProperties: false; required: ["type","data"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
data |
object (fields) | Yes | additionalProperties: false; required: [] |
id |
string | No | |
level |
number or null | No | |
media |
array of #/$defs/content_block_media (fields) | No | Required on image blocks: one item, the picture. A block read back keeps its media by sending it as read. |
parent_block_id |
string or null | No | |
source_block_id |
string or null | No | |
type |
string | Yes | const: "callout" |
updated_at |
string or null | No | As read. Ignored on a whole-document write. |
additionalProperties: false; required: ["type","data"]
string or array of string or boolean fields
Value: string or array of string or boolean.
anyOf: shape 1, shape 2, shape 3.
array of object fields
Value: array of object.
Array items: object.
string or array of string or boolean fields
Value: string or array of string or boolean.
anyOf: shape 1, shape 2, shape 3.
object or null fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
name |
string or null | Yes |
additionalProperties: false; required: ["name"]
array of object fields
Value: array of object.
minItems: 1
Array items: object.
array of object fields
Value: array of object.
Array items: object.
array of object fields
Value: array of object.
Array items: object.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
note |
string | No | |
rows |
array of array of number or string or null (fields) | No |
array of object fields
Value: array of object.
Array items: object.
array of object fields
Value: array of object.
Array items: object.
array of object fields
Value: array of object.
Array items: object.
array of object fields
Value: array of object.
Array items: object.
array of object fields
Value: array of object.
Array items: object.
array of object fields
Value: array of object.
Array items: object.
array of object fields
Value: array of object.
Array items: object.
array of object fields
Value: array of object.
Array items: object.
array of string fields
Value: array of string.
minItems: 1; uniqueItems: true
Array items: string.
array of string fields
Value: array of string.
uniqueItems: true
Array items: string.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
label |
string or null | No | |
url |
string or null | No |
additionalProperties: false; required: []
array of object fields
Value: array of object.
Array items: object.
string fields
Value: string.
anyOf: shape 1, shape 2, shape 3, shape 4, shape 5, shape 6, shape 7, shape 8.
array of #/$defs/content_block_media fields
Value: array of #/$defs/content_block_media.
Array items: #/$defs/content_block_media.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
data |
object (fields) | Yes | additionalProperties: false; required: ["text"] |
id |
string | Yes | |
level |
number or null | Yes | |
media |
array of #/$defs/content_block_media (fields) | Yes | |
parent_block_id |
string or null | Yes | |
position |
integer | No | |
source_block_id |
string or null | No | |
type |
string | Yes | const: "heading" |
updated_at |
string | Yes | The block's own concurrency token, for replace_content_block and delete_content_block. |
additionalProperties: false; required: ["id","parent_block_id","type","level","data","media","updated_at"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
data |
object (fields) | Yes | additionalProperties: false; required: ["markdown","editor_mode"] |
id |
string | Yes | |
level |
number or null | Yes | |
media |
array of #/$defs/content_block_media (fields) | Yes | |
parent_block_id |
string or null | Yes | |
position |
integer | No | |
source_block_id |
string or null | No | |
type |
string | Yes | const: "markdown" |
updated_at |
string | Yes | The block's own concurrency token, for replace_content_block and delete_content_block. |
additionalProperties: false; required: ["id","parent_block_id","type","level","data","media","updated_at"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
data |
object (fields) | Yes | additionalProperties: false; required: [] |
id |
string | Yes | |
level |
number or null | Yes | |
media |
array of #/$defs/content_block_media (fields) | Yes | |
parent_block_id |
string or null | Yes | |
position |
integer | No | |
source_block_id |
string or null | No | |
type |
string | Yes | const: "image" |
updated_at |
string | Yes | The block's own concurrency token, for replace_content_block and delete_content_block. |
additionalProperties: false; required: ["id","parent_block_id","type","level","data","media","updated_at"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
data |
object (fields) | Yes | additionalProperties: false; required: [] |
id |
string | Yes | |
level |
number or null | Yes | |
media |
array of #/$defs/content_block_media (fields) | Yes | |
parent_block_id |
string or null | Yes | |
position |
integer | No | |
source_block_id |
string or null | No | |
type |
string | Yes | const: "gallery" |
updated_at |
string | Yes | The block's own concurrency token, for replace_content_block and delete_content_block. |
additionalProperties: false; required: ["id","parent_block_id","type","level","data","media","updated_at"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
data |
object (fields) | Yes | additionalProperties: false; required: ["url","title"] |
id |
string | Yes | |
level |
number or null | Yes | |
media |
array of #/$defs/content_block_media (fields) | Yes | |
parent_block_id |
string or null | Yes | |
position |
integer | No | |
source_block_id |
string or null | No | |
type |
string | Yes | const: "video" |
updated_at |
string | Yes | The block's own concurrency token, for replace_content_block and delete_content_block. |
additionalProperties: false; required: ["id","parent_block_id","type","level","data","media","updated_at"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
data |
object (fields) | Yes | additionalProperties: false; required: ["source"] |
id |
string | Yes | |
level |
number or null | Yes | |
media |
array of #/$defs/content_block_media (fields) | Yes | |
parent_block_id |
string or null | Yes | |
position |
integer | No | |
source_block_id |
string or null | No | |
type |
string | Yes | const: "faq" |
updated_at |
string | Yes | The block's own concurrency token, for replace_content_block and delete_content_block. |
additionalProperties: false; required: ["id","parent_block_id","type","level","data","media","updated_at"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
data |
object (fields) | Yes | additionalProperties: false; required: ["steps"] |
id |
string | Yes | |
level |
number or null | Yes | |
media |
array of #/$defs/content_block_media (fields) | Yes | |
parent_block_id |
string or null | Yes | |
position |
integer | No | |
source_block_id |
string or null | No | |
type |
string | Yes | const: "how_to" |
updated_at |
string | Yes | The block's own concurrency token, for replace_content_block and delete_content_block. |
additionalProperties: false; required: ["id","parent_block_id","type","level","data","media","updated_at"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
data |
object (fields) | Yes | additionalProperties: false; required: [] |
id |
string | Yes | |
level |
number or null | Yes | |
media |
array of #/$defs/content_block_media (fields) | Yes | |
parent_block_id |
string or null | Yes | |
position |
integer | No | |
source_block_id |
string or null | No | |
type |
string | Yes | const: "divider" |
updated_at |
string | Yes | The block's own concurrency token, for replace_content_block and delete_content_block. |
additionalProperties: false; required: ["id","parent_block_id","type","level","data","media","updated_at"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
data |
object (fields) | Yes | additionalProperties: false; required: [] |
id |
string | Yes | |
level |
number or null | Yes | |
media |
array of #/$defs/content_block_media (fields) | Yes | |
parent_block_id |
string or null | Yes | |
position |
integer | No | |
source_block_id |
string or null | No | |
type |
string | Yes | const: "cta" |
updated_at |
string | Yes | The block's own concurrency token, for replace_content_block and delete_content_block. |
additionalProperties: false; required: ["id","parent_block_id","type","level","data","media","updated_at"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
data |
object (fields) | Yes | additionalProperties: false; required: [] |
id |
string | Yes | |
level |
number or null | Yes | |
media |
array of #/$defs/content_block_media (fields) | Yes | |
parent_block_id |
string or null | Yes | |
position |
integer | No | |
source_block_id |
string or null | No | |
type |
string | Yes | const: "contact_cta" |
updated_at |
string | Yes | The block's own concurrency token, for replace_content_block and delete_content_block. |
additionalProperties: false; required: ["id","parent_block_id","type","level","data","media","updated_at"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
data |
object (fields) | Yes | additionalProperties: false; required: [] |
id |
string | Yes | |
level |
number or null | Yes | |
media |
array of #/$defs/content_block_media (fields) | Yes | |
parent_block_id |
string or null | Yes | |
position |
integer | No | |
source_block_id |
string or null | No | |
type |
string | Yes | const: "booking_cta" |
updated_at |
string | Yes | The block's own concurrency token, for replace_content_block and delete_content_block. |
additionalProperties: false; required: ["id","parent_block_id","type","level","data","media","updated_at"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
data |
object (fields) | Yes | additionalProperties: false; required: [] |
id |
string | Yes | |
level |
number or null | Yes | |
media |
array of #/$defs/content_block_media (fields) | Yes | |
parent_block_id |
string or null | Yes | |
position |
integer | No | |
source_block_id |
string or null | No | |
type |
string | Yes | const: "callout" |
updated_at |
string | Yes | The block's own concurrency token, for replace_content_block and delete_content_block. |
additionalProperties: false; required: ["id","parent_block_id","type","level","data","media","updated_at"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
data |
object (fields) | Yes | additionalProperties: false; required: ["title"] |
id |
string | Yes | |
level |
number or null | Yes | |
media |
array of #/$defs/content_block_media (fields) | Yes | |
parent_block_id |
string or null | Yes | |
position |
integer | No | |
source_block_id |
string or null | No | |
type |
string | Yes | const: "hero" |
updated_at |
string | Yes | The block's own concurrency token, for replace_content_block and delete_content_block. |
additionalProperties: false; required: ["id","parent_block_id","type","level","data","media","updated_at"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
data |
object (fields) | Yes | additionalProperties: false; required: [] |
id |
string | Yes | |
level |
number or null | Yes | |
media |
array of #/$defs/content_block_media (fields) | Yes | |
parent_block_id |
string or null | Yes | |
position |
integer | No | |
source_block_id |
string or null | No | |
type |
string | Yes | const: "button_group" |
updated_at |
string | Yes | The block's own concurrency token, for replace_content_block and delete_content_block. |
additionalProperties: false; required: ["id","parent_block_id","type","level","data","media","updated_at"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
data |
object (fields) | Yes | additionalProperties: false; required: [] |
id |
string | Yes | |
level |
number or null | Yes | |
media |
array of #/$defs/content_block_media (fields) | Yes | |
parent_block_id |
string or null | Yes | |
position |
integer | No | |
source_block_id |
string or null | No | |
type |
string | Yes | const: "feature_grid" |
updated_at |
string | Yes | The block's own concurrency token, for replace_content_block and delete_content_block. |
additionalProperties: false; required: ["id","parent_block_id","type","level","data","media","updated_at"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
data |
object (fields) | Yes | additionalProperties: false; required: [] |
id |
string | Yes | |
level |
number or null | Yes | |
media |
array of #/$defs/content_block_media (fields) | Yes | |
parent_block_id |
string or null | Yes | |
position |
integer | No | |
source_block_id |
string or null | No | |
type |
string | Yes | const: "comparison" |
updated_at |
string | Yes | The block's own concurrency token, for replace_content_block and delete_content_block. |
additionalProperties: false; required: ["id","parent_block_id","type","level","data","media","updated_at"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
data |
object (fields) | Yes | additionalProperties: false; required: [] |
id |
string | Yes | |
level |
number or null | Yes | |
media |
array of #/$defs/content_block_media (fields) | Yes | |
parent_block_id |
string or null | Yes | |
position |
integer | No | |
source_block_id |
string or null | No | |
type |
string | Yes | const: "stat_grid" |
updated_at |
string | Yes | The block's own concurrency token, for replace_content_block and delete_content_block. |
additionalProperties: false; required: ["id","parent_block_id","type","level","data","media","updated_at"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
data |
object (fields) | Yes | additionalProperties: false; required: [] |
id |
string | Yes | |
level |
number or null | Yes | |
media |
array of #/$defs/content_block_media (fields) | Yes | |
parent_block_id |
string or null | Yes | |
position |
integer | No | |
source_block_id |
string or null | No | |
type |
string | Yes | const: "workflow_grid" |
updated_at |
string | Yes | The block's own concurrency token, for replace_content_block and delete_content_block. |
additionalProperties: false; required: ["id","parent_block_id","type","level","data","media","updated_at"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
data |
object (fields) | Yes | additionalProperties: false; required: [] |
id |
string | Yes | |
level |
number or null | Yes | |
media |
array of #/$defs/content_block_media (fields) | Yes | |
parent_block_id |
string or null | Yes | |
position |
integer | No | |
source_block_id |
string or null | No | |
type |
string | Yes | const: "showcase" |
updated_at |
string | Yes | The block's own concurrency token, for replace_content_block and delete_content_block. |
additionalProperties: false; required: ["id","parent_block_id","type","level","data","media","updated_at"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
data |
object (fields) | Yes | additionalProperties: false; required: [] |
id |
string | Yes | |
level |
number or null | Yes | |
media |
array of #/$defs/content_block_media (fields) | Yes | |
parent_block_id |
string or null | Yes | |
position |
integer | No | |
source_block_id |
string or null | No | |
type |
string | Yes | const: "language_reach" |
updated_at |
string | Yes | The block's own concurrency token, for replace_content_block and delete_content_block. |
additionalProperties: false; required: ["id","parent_block_id","type","level","data","media","updated_at"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
data |
object (fields) | Yes | additionalProperties: false; required: [] |
id |
string | Yes | |
level |
number or null | Yes | |
media |
array of #/$defs/content_block_media (fields) | Yes | |
parent_block_id |
string or null | Yes | |
position |
integer | No | |
source_block_id |
string or null | No | |
type |
string | Yes | const: "steps" |
updated_at |
string | Yes | The block's own concurrency token, for replace_content_block and delete_content_block. |
additionalProperties: false; required: ["id","parent_block_id","type","level","data","media","updated_at"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
data |
object (fields) | Yes | additionalProperties: false; required: [] |
id |
string | Yes | |
level |
number or null | Yes | |
media |
array of #/$defs/content_block_media (fields) | Yes | |
parent_block_id |
string or null | Yes | |
position |
integer | No | |
source_block_id |
string or null | No | |
type |
string | Yes | const: "video_feature" |
updated_at |
string | Yes | The block's own concurrency token, for replace_content_block and delete_content_block. |
additionalProperties: false; required: ["id","parent_block_id","type","level","data","media","updated_at"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
data |
object (fields) | Yes | additionalProperties: false; required: [] |
id |
string | Yes | |
level |
number or null | Yes | |
media |
array of #/$defs/content_block_media (fields) | Yes | |
parent_block_id |
string or null | Yes | |
position |
integer | No | |
source_block_id |
string or null | No | |
type |
string | Yes | const: "media_text" |
updated_at |
string | Yes | The block's own concurrency token, for replace_content_block and delete_content_block. |
additionalProperties: false; required: ["id","parent_block_id","type","level","data","media","updated_at"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
data |
object (fields) | Yes | additionalProperties: false; required: [] |
id |
string | Yes | |
level |
number or null | Yes | |
media |
array of #/$defs/content_block_media (fields) | Yes | |
parent_block_id |
string or null | Yes | |
position |
integer | No | |
source_block_id |
string or null | No | |
type |
string | Yes | const: "contact_form" |
updated_at |
string | Yes | The block's own concurrency token, for replace_content_block and delete_content_block. |
additionalProperties: false; required: ["id","parent_block_id","type","level","data","media","updated_at"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
data |
object (fields) | Yes | additionalProperties: false; required: [] |
id |
string | Yes | |
level |
number or null | Yes | |
media |
array of #/$defs/content_block_media (fields) | Yes | |
parent_block_id |
string or null | Yes | |
position |
integer | No | |
source_block_id |
string or null | No | |
type |
string | Yes | const: "team_grid" |
updated_at |
string | Yes | The block's own concurrency token, for replace_content_block and delete_content_block. |
additionalProperties: false; required: ["id","parent_block_id","type","level","data","media","updated_at"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
data |
object (fields) | Yes | additionalProperties: false; required: [] |
id |
string | Yes | |
level |
number or null | Yes | |
media |
array of #/$defs/content_block_media (fields) | Yes | |
parent_block_id |
string or null | Yes | |
position |
integer | No | |
source_block_id |
string or null | No | |
type |
string | Yes | const: "testimonial_grid" |
updated_at |
string | Yes | The block's own concurrency token, for replace_content_block and delete_content_block. |
additionalProperties: false; required: ["id","parent_block_id","type","level","data","media","updated_at"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
data |
object (fields) | Yes | additionalProperties: false; required: [] |
id |
string | Yes | |
level |
number or null | Yes | |
media |
array of #/$defs/content_block_media (fields) | Yes | |
parent_block_id |
string or null | Yes | |
position |
integer | No | |
source_block_id |
string or null | No | |
type |
string | Yes | const: "donation_choices" |
updated_at |
string | Yes | The block's own concurrency token, for replace_content_block and delete_content_block. |
additionalProperties: false; required: ["id","parent_block_id","type","level","data","media","updated_at"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
data |
object (fields) | Yes | additionalProperties: false; required: ["page_ids"] |
id |
string | Yes | |
level |
number or null | Yes | |
media |
array of #/$defs/content_block_media (fields) | Yes | |
parent_block_id |
string or null | Yes | |
position |
integer | No | |
source_block_id |
string or null | No | |
type |
string | Yes | const: "page_grid" |
updated_at |
string | Yes | The block's own concurrency token, for replace_content_block and delete_content_block. |
additionalProperties: false; required: ["id","parent_block_id","type","level","data","media","updated_at"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
data |
object (fields) | Yes | additionalProperties: false; required: [] |
id |
string | Yes | |
level |
number or null | Yes | |
media |
array of #/$defs/content_block_media (fields) | Yes | |
parent_block_id |
string or null | Yes | |
position |
integer | No | |
source_block_id |
string or null | No | |
type |
string | Yes | const: "product_grid" |
updated_at |
string | Yes | The block's own concurrency token, for replace_content_block and delete_content_block. |
additionalProperties: false; required: ["id","parent_block_id","type","level","data","media","updated_at"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
data |
object (fields) | Yes | additionalProperties: false; required: [] |
id |
string | Yes | |
level |
number or null | Yes | |
media |
array of #/$defs/content_block_media (fields) | Yes | |
parent_block_id |
string or null | Yes | |
position |
integer | No | |
source_block_id |
string or null | No | |
type |
string | Yes | const: "location_grid" |
updated_at |
string | Yes | The block's own concurrency token, for replace_content_block and delete_content_block. |
additionalProperties: false; required: ["id","parent_block_id","type","level","data","media","updated_at"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
data |
object (fields) | Yes | additionalProperties: false; required: [] |
id |
string | Yes | |
level |
number or null | Yes | |
media |
array of #/$defs/content_block_media (fields) | Yes | |
parent_block_id |
string or null | Yes | |
position |
integer | No | |
source_block_id |
string or null | No | |
type |
string | Yes | const: "social_posts" |
updated_at |
string | Yes | The block's own concurrency token, for replace_content_block and delete_content_block. |
additionalProperties: false; required: ["id","parent_block_id","type","level","data","media","updated_at"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
data |
object (fields) | Yes | additionalProperties: false; required: [] |
id |
string | Yes | |
level |
number or null | Yes | |
media |
array of #/$defs/content_block_media (fields) | Yes | |
parent_block_id |
string or null | Yes | |
position |
integer | No | |
source_block_id |
string or null | No | |
type |
string | Yes | const: "ai_assistance" |
updated_at |
string | Yes | The block's own concurrency token, for replace_content_block and delete_content_block. |
additionalProperties: false; required: ["id","parent_block_id","type","level","data","media","updated_at"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
data |
object (fields) | Yes | additionalProperties: false; required: ["text"] |
id |
string | No | |
level |
integer or null | No | maximum: 6; minimum: 1 |
media |
array of #/$defs/content_block_media (fields) | No | |
parent_block_id |
string or null | No | |
source_block_id |
string or null | No | |
type |
string | Yes | const: "heading" |
updated_at |
string or null | No | As read. Ignored on a whole-document write. |
additionalProperties: false; required: ["type","data"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
data |
object (fields) | Yes | additionalProperties: false; required: ["markdown","editor_mode"] |
id |
string | No | |
level |
integer or null | No | maximum: 6; minimum: 1 |
media |
array of #/$defs/content_block_media (fields) | No | |
parent_block_id |
string or null | No | |
source_block_id |
string or null | No | |
type |
string | Yes | const: "markdown" |
updated_at |
string or null | No | As read. Ignored on a whole-document write. |
additionalProperties: false; required: ["type","data"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
data |
object (fields) | Yes | additionalProperties: false; required: [] |
id |
string | No | |
level |
integer or null | No | maximum: 6; minimum: 1 |
media |
array of #/$defs/content_block_media (fields) | No | |
parent_block_id |
string or null | No | |
source_block_id |
string or null | No | |
type |
string | Yes | const: "image" |
updated_at |
string or null | No | As read. Ignored on a whole-document write. |
additionalProperties: false; required: ["type","data"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
data |
object (fields) | Yes | additionalProperties: false; required: [] |
id |
string | No | |
level |
integer or null | No | maximum: 6; minimum: 1 |
media |
array of #/$defs/content_block_media (fields) | No | |
parent_block_id |
string or null | No | |
source_block_id |
string or null | No | |
type |
string | Yes | const: "gallery" |
updated_at |
string or null | No | As read. Ignored on a whole-document write. |
additionalProperties: false; required: ["type","data"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
data |
object (fields) | Yes | additionalProperties: false; required: ["url","title"] |
id |
string | No | |
level |
integer or null | No | maximum: 6; minimum: 1 |
media |
array of #/$defs/content_block_media (fields) | No | |
parent_block_id |
string or null | No | |
source_block_id |
string or null | No | |
type |
string | Yes | const: "video" |
updated_at |
string or null | No | As read. Ignored on a whole-document write. |
additionalProperties: false; required: ["type","data"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
data |
object (fields) | Yes | additionalProperties: false; required: ["source"] |
id |
string | No | |
level |
integer or null | No | maximum: 6; minimum: 1 |
media |
array of #/$defs/content_block_media (fields) | No | |
parent_block_id |
string or null | No | |
source_block_id |
string or null | No | |
type |
string | Yes | const: "faq" |
updated_at |
string or null | No | As read. Ignored on a whole-document write. |
additionalProperties: false; required: ["type","data"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
data |
object (fields) | Yes | additionalProperties: false; required: ["steps"] |
id |
string | No | |
level |
integer or null | No | maximum: 6; minimum: 1 |
media |
array of #/$defs/content_block_media (fields) | No | |
parent_block_id |
string or null | No | |
source_block_id |
string or null | No | |
type |
string | Yes | const: "how_to" |
updated_at |
string or null | No | As read. Ignored on a whole-document write. |
additionalProperties: false; required: ["type","data"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
data |
object (fields) | Yes | additionalProperties: false; required: [] |
id |
string | No | |
level |
integer or null | No | maximum: 6; minimum: 1 |
media |
array of #/$defs/content_block_media (fields) | No | |
parent_block_id |
string or null | No | |
source_block_id |
string or null | No | |
type |
string | Yes | const: "divider" |
updated_at |
string or null | No | As read. Ignored on a whole-document write. |
additionalProperties: false; required: ["type","data"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
data |
object (fields) | Yes | additionalProperties: false; required: [] |
id |
string | No | |
level |
integer or null | No | maximum: 6; minimum: 1 |
media |
array of #/$defs/content_block_media (fields) | No | |
parent_block_id |
string or null | No | |
source_block_id |
string or null | No | |
type |
string | Yes | const: "cta" |
updated_at |
string or null | No | As read. Ignored on a whole-document write. |
additionalProperties: false; required: ["type","data"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
data |
object (fields) | Yes | additionalProperties: false; required: [] |
id |
string | No | |
level |
integer or null | No | maximum: 6; minimum: 1 |
media |
array of #/$defs/content_block_media (fields) | No | |
parent_block_id |
string or null | No | |
source_block_id |
string or null | No | |
type |
string | Yes | const: "contact_cta" |
updated_at |
string or null | No | As read. Ignored on a whole-document write. |
additionalProperties: false; required: ["type","data"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
data |
object (fields) | Yes | additionalProperties: false; required: [] |
id |
string | No | |
level |
integer or null | No | maximum: 6; minimum: 1 |
media |
array of #/$defs/content_block_media (fields) | No | |
parent_block_id |
string or null | No | |
source_block_id |
string or null | No | |
type |
string | Yes | const: "booking_cta" |
updated_at |
string or null | No | As read. Ignored on a whole-document write. |
additionalProperties: false; required: ["type","data"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
data |
object (fields) | Yes | additionalProperties: false; required: [] |
id |
string | No | |
level |
integer or null | No | maximum: 6; minimum: 1 |
media |
array of #/$defs/content_block_media (fields) | No | |
parent_block_id |
string or null | No | |
source_block_id |
string or null | No | |
type |
string | Yes | const: "callout" |
updated_at |
string or null | No | As read. Ignored on a whole-document write. |
additionalProperties: false; required: ["type","data"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
data |
object (fields) | Yes | additionalProperties: false; required: ["title"] |
id |
string | No | |
level |
integer or null | No | maximum: 6; minimum: 1 |
media |
array of #/$defs/content_block_media (fields) | No | |
parent_block_id |
string or null | No | |
source_block_id |
string or null | No | |
type |
string | Yes | const: "hero" |
updated_at |
string or null | No | As read. Ignored on a whole-document write. |
additionalProperties: false; required: ["type","data"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
data |
object (fields) | Yes | additionalProperties: false; required: [] |
id |
string | No | |
level |
integer or null | No | maximum: 6; minimum: 1 |
media |
array of #/$defs/content_block_media (fields) | No | |
parent_block_id |
string or null | No | |
source_block_id |
string or null | No | |
type |
string | Yes | const: "button_group" |
updated_at |
string or null | No | As read. Ignored on a whole-document write. |
additionalProperties: false; required: ["type","data"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
data |
object (fields) | Yes | additionalProperties: false; required: [] |
id |
string | No | |
level |
integer or null | No | maximum: 6; minimum: 1 |
media |
array of #/$defs/content_block_media (fields) | No | |
parent_block_id |
string or null | No | |
source_block_id |
string or null | No | |
type |
string | Yes | const: "feature_grid" |
updated_at |
string or null | No | As read. Ignored on a whole-document write. |
additionalProperties: false; required: ["type","data"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
data |
object (fields) | Yes | additionalProperties: false; required: [] |
id |
string | No | |
level |
integer or null | No | maximum: 6; minimum: 1 |
media |
array of #/$defs/content_block_media (fields) | No | |
parent_block_id |
string or null | No | |
source_block_id |
string or null | No | |
type |
string | Yes | const: "comparison" |
updated_at |
string or null | No | As read. Ignored on a whole-document write. |
additionalProperties: false; required: ["type","data"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
data |
object (fields) | Yes | additionalProperties: false; required: [] |
id |
string | No | |
level |
integer or null | No | maximum: 6; minimum: 1 |
media |
array of #/$defs/content_block_media (fields) | No | |
parent_block_id |
string or null | No | |
source_block_id |
string or null | No | |
type |
string | Yes | const: "stat_grid" |
updated_at |
string or null | No | As read. Ignored on a whole-document write. |
additionalProperties: false; required: ["type","data"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
data |
object (fields) | Yes | additionalProperties: false; required: [] |
id |
string | No | |
level |
integer or null | No | maximum: 6; minimum: 1 |
media |
array of #/$defs/content_block_media (fields) | No | |
parent_block_id |
string or null | No | |
source_block_id |
string or null | No | |
type |
string | Yes | const: "workflow_grid" |
updated_at |
string or null | No | As read. Ignored on a whole-document write. |
additionalProperties: false; required: ["type","data"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
data |
object (fields) | Yes | additionalProperties: false; required: [] |
id |
string | No | |
level |
integer or null | No | maximum: 6; minimum: 1 |
media |
array of #/$defs/content_block_media (fields) | No | |
parent_block_id |
string or null | No | |
source_block_id |
string or null | No | |
type |
string | Yes | const: "showcase" |
updated_at |
string or null | No | As read. Ignored on a whole-document write. |
additionalProperties: false; required: ["type","data"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
data |
object (fields) | Yes | additionalProperties: false; required: [] |
id |
string | No | |
level |
integer or null | No | maximum: 6; minimum: 1 |
media |
array of #/$defs/content_block_media (fields) | No | |
parent_block_id |
string or null | No | |
source_block_id |
string or null | No | |
type |
string | Yes | const: "language_reach" |
updated_at |
string or null | No | As read. Ignored on a whole-document write. |
additionalProperties: false; required: ["type","data"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
data |
object (fields) | Yes | additionalProperties: false; required: [] |
id |
string | No | |
level |
integer or null | No | maximum: 6; minimum: 1 |
media |
array of #/$defs/content_block_media (fields) | No | |
parent_block_id |
string or null | No | |
source_block_id |
string or null | No | |
type |
string | Yes | const: "steps" |
updated_at |
string or null | No | As read. Ignored on a whole-document write. |
additionalProperties: false; required: ["type","data"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
data |
object (fields) | Yes | additionalProperties: false; required: [] |
id |
string | No | |
level |
integer or null | No | maximum: 6; minimum: 1 |
media |
array of #/$defs/content_block_media (fields) | No | |
parent_block_id |
string or null | No | |
source_block_id |
string or null | No | |
type |
string | Yes | const: "video_feature" |
updated_at |
string or null | No | As read. Ignored on a whole-document write. |
additionalProperties: false; required: ["type","data"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
data |
object (fields) | Yes | additionalProperties: false; required: [] |
id |
string | No | |
level |
integer or null | No | maximum: 6; minimum: 1 |
media |
array of #/$defs/content_block_media (fields) | No | |
parent_block_id |
string or null | No | |
source_block_id |
string or null | No | |
type |
string | Yes | const: "media_text" |
updated_at |
string or null | No | As read. Ignored on a whole-document write. |
additionalProperties: false; required: ["type","data"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
data |
object (fields) | Yes | additionalProperties: false; required: [] |
id |
string | No | |
level |
integer or null | No | maximum: 6; minimum: 1 |
media |
array of #/$defs/content_block_media (fields) | No | |
parent_block_id |
string or null | No | |
source_block_id |
string or null | No | |
type |
string | Yes | const: "contact_form" |
updated_at |
string or null | No | As read. Ignored on a whole-document write. |
additionalProperties: false; required: ["type","data"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
data |
object (fields) | Yes | additionalProperties: false; required: [] |
id |
string | No | |
level |
integer or null | No | maximum: 6; minimum: 1 |
media |
array of #/$defs/content_block_media (fields) | No | |
parent_block_id |
string or null | No | |
source_block_id |
string or null | No | |
type |
string | Yes | const: "team_grid" |
updated_at |
string or null | No | As read. Ignored on a whole-document write. |
additionalProperties: false; required: ["type","data"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
data |
object (fields) | Yes | additionalProperties: false; required: [] |
id |
string | No | |
level |
integer or null | No | maximum: 6; minimum: 1 |
media |
array of #/$defs/content_block_media (fields) | No | |
parent_block_id |
string or null | No | |
source_block_id |
string or null | No | |
type |
string | Yes | const: "testimonial_grid" |
updated_at |
string or null | No | As read. Ignored on a whole-document write. |
additionalProperties: false; required: ["type","data"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
data |
object (fields) | Yes | additionalProperties: false; required: [] |
id |
string | No | |
level |
integer or null | No | maximum: 6; minimum: 1 |
media |
array of #/$defs/content_block_media (fields) | No | |
parent_block_id |
string or null | No | |
source_block_id |
string or null | No | |
type |
string | Yes | const: "donation_choices" |
updated_at |
string or null | No | As read. Ignored on a whole-document write. |
additionalProperties: false; required: ["type","data"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
data |
object (fields) | Yes | additionalProperties: false; required: ["page_ids"] |
id |
string | No | |
level |
integer or null | No | maximum: 6; minimum: 1 |
media |
array of #/$defs/content_block_media (fields) | No | |
parent_block_id |
string or null | No | |
source_block_id |
string or null | No | |
type |
string | Yes | const: "page_grid" |
updated_at |
string or null | No | As read. Ignored on a whole-document write. |
additionalProperties: false; required: ["type","data"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
data |
object (fields) | Yes | additionalProperties: false; required: [] |
id |
string | No | |
level |
integer or null | No | maximum: 6; minimum: 1 |
media |
array of #/$defs/content_block_media (fields) | No | |
parent_block_id |
string or null | No | |
source_block_id |
string or null | No | |
type |
string | Yes | const: "product_grid" |
updated_at |
string or null | No | As read. Ignored on a whole-document write. |
additionalProperties: false; required: ["type","data"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
data |
object (fields) | Yes | additionalProperties: false; required: [] |
id |
string | No | |
level |
integer or null | No | maximum: 6; minimum: 1 |
media |
array of #/$defs/content_block_media (fields) | No | |
parent_block_id |
string or null | No | |
source_block_id |
string or null | No | |
type |
string | Yes | const: "location_grid" |
updated_at |
string or null | No | As read. Ignored on a whole-document write. |
additionalProperties: false; required: ["type","data"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
data |
object (fields) | Yes | additionalProperties: false; required: [] |
id |
string | No | |
level |
integer or null | No | maximum: 6; minimum: 1 |
media |
array of #/$defs/content_block_media (fields) | No | |
parent_block_id |
string or null | No | |
source_block_id |
string or null | No | |
type |
string | Yes | const: "social_posts" |
updated_at |
string or null | No | As read. Ignored on a whole-document write. |
additionalProperties: false; required: ["type","data"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
data |
object (fields) | Yes | additionalProperties: false; required: [] |
id |
string | No | |
level |
integer or null | No | maximum: 6; minimum: 1 |
media |
array of #/$defs/content_block_media (fields) | No | |
parent_block_id |
string or null | No | |
source_block_id |
string or null | No | |
type |
string | Yes | const: "ai_assistance" |
updated_at |
string or null | No | As read. Ignored on a whole-document write. |
additionalProperties: false; required: ["type","data"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
choices |
array of object (fields) | Yes | maxItems: 20 |
help_text |
string or null | Yes | maxLength: 500 |
id |
string | Yes | Stable question ID; submissions answer by this ID. maxLength: 64; pattern: "^[a-z0-9][a-z0-9_-]{0,63}$" |
label |
string | Yes | maxLength: 200; minLength: 1 |
required |
boolean | Yes | |
type |
string | Yes | enum: ["short_text","long_text","single_choice","multiple_choice","yes_no"] |
additionalProperties: false; required: ["id","label","type","required","help_text","choices"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
id |
string | Yes | |
text |
string | Yes |
required: ["id","text"]
array of object fields
Value: array of object.
maxItems: 20
Array items: object.
array of string fields
Value: array of string.
maxItems: 100; minItems: 1; uniqueItems: true
Array items: string.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
details |
string or null | Yes | |
task |
string | Yes | minLength: 1 |
additionalProperties: false; required: ["task","details"]
object or null fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
values |
object (fields) | Yes | additionalProperties: false |
additionalProperties: false; required: ["values"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
description |
string or null | Yes | |
name |
string | Yes |
additionalProperties: false; required: ["name","description"]
object or null fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
route_path |
string or null | Yes | |
values |
object (fields) | Yes | additionalProperties: false |
additionalProperties: false; required: ["values","route_path"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
description |
string | Yes | |
details |
object (fields) | Yes | additionalProperties: false |
marketing_features |
array of string (fields) | Yes | |
name |
string | Yes | |
unit_label |
string or null | Yes |
additionalProperties: false; required: ["name","description","marketing_features","unit_label","details"]
See schema fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
resource_type |
string | No | const: "organization" |
values |
object (fields) | No | additionalProperties: false |
See schema fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
resource_type |
string | No | const: "business_location" |
values |
object (fields) | No | additionalProperties: false |
See schema fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
resource_type |
string | No | const: "product" |
values |
object (fields) | No | additionalProperties: false |
See schema fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
resource_type |
string | No | const: "collection" |
values |
object (fields) | No | additionalProperties: false |
See schema fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
resource_type |
string | No | const: "article_category" |
values |
object (fields) | No | additionalProperties: false |
See schema fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
resource_type |
string | No | const: "media_asset" |
values |
object (fields) | No | additionalProperties: false |
string fields
Value: string.
pattern: "^[\s\S]\S[\s\S]$"
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
label |
string | Yes | pattern: "^[\s\S]\S[\s\S]$" |
additionalProperties: false; required: ["label"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
additional_notes_html |
string | No |
additionalProperties: false
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
address |
object (fields) | No | additionalProperties: false |
alt_text |
string | No | |
brand_description |
string | No | |
compliance |
object (fields) | No | additionalProperties: false |
consultation |
object (fields) | No | additionalProperties: false |
description |
string | No | |
details |
object (fields) | No | additionalProperties: false |
inquiry_questions |
object | No | Translated question wording keyed by question ID: { label?, help_text?, choices?: { |
marketing_features |
array of string (fields) | No | |
name |
string | No | |
questions |
object | No | Translated question wording keyed by question ID: { label?, help_text?, choices?: { |
reservation |
object (fields) | No | additionalProperties: false |
reservation_questions |
object | No | Translated question wording keyed by question ID: { label?, help_text?, choices?: { |
seo_description |
string | No | |
seo_title |
string | No | |
short_description |
string | No | |
title |
string | No | |
unit_label |
string | No |
additionalProperties: false
See schema fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
values |
object (fields) | No | additionalProperties: false |
See schema fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
values |
object (fields) | No | additionalProperties: false |
See schema fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
values |
object (fields) | No | additionalProperties: false |
See schema fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
values |
object (fields) | No | additionalProperties: false |
See schema fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
values |
object (fields) | No | additionalProperties: false |
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
alt_text |
string or null | No | |
asset_id |
string | Yes | |
kind |
string | Yes | enum: ["image","video"] |
public_url |
string | Yes | |
sort_order |
number | Yes | |
thumbnail_url |
string or null | No |
required: ["asset_id","kind","public_url","sort_order"]
string fields
Value: string.
minLength: 1; pattern: "^[\s\S]\S[\s\S]$"
array of object fields
Value: array of object.
Array items: object.
object fields
Value: object.
string fields
Value: string.
anyOf: shape 1, shape 2, shape 3, shape 4, shape 5, shape 6, shape 7, shape 8.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
asset_id |
string | Yes | |
kind |
string | Yes | |
public_url |
string or null | Yes | |
slot |
string | Yes | |
thumbnail_url |
string or null | Yes |
required: ["asset_id","slot","public_url","thumbnail_url","kind"]
object or null fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
account_id |
string | No | |
connected_at |
string | No | |
connected_through |
object or null (fields) | No | |
last_error |
string or null | No | |
measurement_id |
string or null | No | |
status |
string or null | No | |
target_id |
string or null | No | |
target_name |
string or null | No | |
verified |
boolean or null | No |
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
email |
string | Yes | |
id |
string | Yes | |
image |
string or null | No | |
name |
string | Yes |
required: ["id","name","email"]
array of object fields
Value: array of object.
Array items: object.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
amount |
integer | Yes | |
currency |
string | Yes |
required: ["currency","amount"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
label |
string | Yes | |
url |
string | Yes |
additionalProperties: false; required: ["label","url"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
alt_text |
string or null | No | |
asset_id |
string | Yes | |
duration |
number or null | No | |
height |
number or null | No | |
kind |
string | Yes | enum: ["image","video"] |
mime_type |
string or null | No | |
public_url |
string | Yes | |
slot |
string | Yes | enum: ["cover","gallery"] |
sort_order |
number | Yes | |
thumbnail_url |
string or null | No | |
updated_at |
string | No | |
width |
number or null | No |
required: ["asset_id","public_url","kind","slot","sort_order"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
channel |
string | Yes | enum: ["facebook","instagram","discord"] |
code |
string or null | Yes | |
id |
string | Yes | The publication_id reconcile_post_publication takes. |
local_content_changed |
boolean | Yes | The website copy changed after this was sent. The external post was not edited. |
message |
string or null | Yes | |
provider_post_id |
string or null | Yes | |
public_url |
string or null | Yes | The provider's own permalink, when it returned one. A Discord message link opens only for members of that channel. |
published_at |
string or null | Yes | |
state |
string | Yes | enum: ["preparing","publishing","published","failed","unknown","removed"] |
target_id |
string | Yes |
additionalProperties: false; required: ["id","channel","target_id","state","provider_post_id","public_url","code","message","published_at","local_content_changed"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
kind |
string | Yes | enum: ["image","video"] |
provider_media_id |
string or null | Yes | |
public_url |
string or null | Yes | |
thumbnail_url |
string or null | Yes |
additionalProperties: false; required: ["provider_media_id","kind","public_url","thumbnail_url"]
array of object fields
Value: array of object.
Array items: object.
array of string fields
Value: array of string.
Array items: string.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
channel |
enum | Yes | enum: ["organization"] |
additionalProperties: false; required: ["channel"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
channel |
enum | Yes | enum: ["facebook","instagram","discord"] |
connection_revision |
string | Yes | The connection_revision get_social_connections returned with it. |
target_id |
string | Yes | The Page, professional account or Discord channel id from get_social_connections. |
additionalProperties: false; required: ["channel","target_id","connection_revision"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
capacity |
integer or null | No | minimum: 1 |
ends_at |
string | Yes | format: "date-time" |
starts_at |
string | Yes | format: "date-time" |
additionalProperties: false; required: ["starts_at","ends_at"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
start_time |
string | Yes | Local HH:mm start time; visit duration is configured separately. pattern: "^([01][0-9]|2[0-3]):[0-5][0-9]$" |
weekday |
integer | Yes | maximum: 6; minimum: 0 |
additionalProperties: false; required: ["weekday","start_time"]
string fields
Value: string.
maxLength: 1000; minLength: 1; pattern: "^(?=[\s\S]\S)[^\r\n]$"
array of object fields
Value: array of object.
maxItems: 100; minItems: 1
Array items: object.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
available |
boolean or null | Yes | |
code |
string | Yes | enum: ["ac","dryer","essentials","heating","hot_water","kitchen","tv","washer","wireless_internet","bathtub","bidet","body_soap","cleaning_products","conditioner","hair_dryer","alfresco_shower","shampoo","shower_gel","bed_linens","wardrobe_or_closet","clothes_drying_rack","extra_pillows_and_blankets","hangers","iron","mosquito_net","room_darkening_shades","safe","arcade_machine","batting_cage","books","bowling_alley","climbing_wall","ethernet_connection","exercise_equipment","game_console","laser_tag","life_size_games","mini_golf","home_theater","piano","ping_pong_table","pool_table","record_player","skate_ramp","sound_system","theme_room","baby_bath","baby_monitor","childrens_bike","playroom","stair_gates","babysitter_recommendations","board_games","changing_table","childrens_books_and_toys","childrens_dinnerware","crib","fireplace_guards","high_chair","playground","outlet_covers","pack_n_play_travel_crib","table_corner_guards","window_guards","ceiling_fan","fireplace","portable_fans","carbon_monoxide_detector","fire_extinguisher","first_aid_kit","smoke_detector","laptop_friendly_workspace","pocket_wifi","baking_sheet","barbeque_utensils","bread_maker","blender","coffee","coffee_maker","cooking_basics","dining_table","dishes_and_silverware","dishwasher","freezer","hot_water_kettle","kitchenette","microwave","mini_fridge","oven","refrigerator","rice_maker","stove","toaster","trash_compacter","wine_glasses","beach_access","lake_access","laundromat_nearby","private_entrance","resort_access","ski_in_ski_out","waterfront","garden_or_backyard","bbq_area","beach_essentials","bicycle","boat_slip","fire_pit","hammock","kayak","alfresco_dining","outdoor_seating","outdoor_kitchen","patio_or_belcony","sun_loungers","free_parking","street_parking","paid_parking_on_premises","paid_parking","free_parking_off_premises","elevator","ev_charger","hockey_rink","gym","jacuzzi","pool","private_living_room","sauna","single_level_home","ebike_charger","solar_power","recycling","composting","doorman","gated_community","breakfast","cleaning_before_checkout","long_term_stays_allowed","luggage_dropoff_allowed","bay_view","beach_view","canal_view","city_view","courtyard_view","desert_view","garden_view","golf_view","harbor_view","lake_view","marina_view","mountain_view","ocean_view","park_view","pool_view","resort_view","river_view","sea_view","valley_view","vineyard_view","landmark_view"] |
additionalProperties: false; required: ["code","available"]
array of integer fields
Value: array of integer.
maxItems: 7; minItems: 7
Array items: integer.
array of object fields
Value: array of object.
maxItems: 20
Array items: object.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
collection_id |
string | Yes | |
sort_order |
integer | Yes |
required: ["collection_id","sort_order"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
active |
boolean | Yes | |
location_id |
string | Yes | |
published |
boolean | Yes |
required: ["location_id","active","published"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
id |
string | Yes | |
name |
string | Yes | |
sort_order |
integer | Yes | |
values |
array of object (fields) | Yes |
required: ["id","name","sort_order","values"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
organization_id |
string | Yes | |
published |
boolean | Yes |
required: ["organization_id","published"]
array of string fields
Value: array of string.
uniqueItems: true
Array items: string.
array of object fields
Value: array of object.
Array items: object.
array of object fields
Value: array of object.
Array items: object.
array of object fields
Value: array of object.
maxItems: 20
Array items: object.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
active |
boolean | Yes | |
id |
string | Yes | |
name |
string | Yes | |
option_values |
object | Yes | additionalProperties: {"type":"string"} |
prices |
array of object (fields) | Yes | |
product_id |
string | Yes | |
sku |
string or null | Yes | |
sort_order |
integer | Yes |
additionalProperties: false; required: ["id","product_id","name","sku","active","sort_order","option_values","prices"]
array of object fields
Value: array of object.
Array items: object.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
local_date |
string | Yes | |
local_start_time |
string | Yes | |
reason |
string | Yes | enum: ["ambiguous_local_time","nonexistent_local_time","location_closed"] |
rule_id |
string | Yes |
additionalProperties: false; required: ["rule_id","local_date","local_start_time","reason"]
array of object fields
Value: array of object.
maxItems: 100; minItems: 1
Array items: object.
array of object fields
Value: array of object.
Array items: object.
string fields
Value: string.
maxLength: 10000; minLength: 1; pattern: "^[\s\S]\S[\s\S]$"
string fields
Value: string.
maxLength: 300; minLength: 1; pattern: "^[\s\S]\S[\s\S]$"
string fields
Value: string.
maxLength: 300; minLength: 1; pattern: "^[\s\S]\S[\s\S]$"
string fields
Value: string.
maxLength: 300; minLength: 1; pattern: "^[\s\S]\S[\s\S]$"
string fields
Value: string.
maxLength: 300; minLength: 1; pattern: "^[\s\S]\S[\s\S]$"
string fields
Value: string.
maxLength: 10000; minLength: 1; pattern: "^[\s\S]\S[\s\S]$"
string fields
Value: string.
maxLength: 10000; minLength: 1; pattern: "^[\s\S]\S[\s\S]$"
string fields
Value: string.
maxLength: 10000; minLength: 1; pattern: "^[\s\S]\S[\s\S]$"
string fields
Value: string.
maxLength: 10000; minLength: 1; pattern: "^[\s\S]\S[\s\S]$"
string fields
Value: string.
maxLength: 300; minLength: 1; pattern: "^[\s\S]\S[\s\S]$"
string fields
Value: string.
maxLength: 10000; minLength: 1; pattern: "^[\s\S]\S[\s\S]$"
string fields
Value: string.
maxLength: 300; minLength: 1; pattern: "^[\s\S]\S[\s\S]$"
string fields
Value: string.
maxLength: 10000; minLength: 1; pattern: "^[\s\S]\S[\s\S]$"
string fields
Value: string.
maxLength: 300; minLength: 1; pattern: "^[\s\S]\S[\s\S]$"
string fields
Value: string.
maxLength: 300; minLength: 1; pattern: "^[\s\S]\S[\s\S]$"
string fields
Value: string.
maxLength: 10000; minLength: 1; pattern: "^[\s\S]\S[\s\S]$"
string fields
Value: string.
maxLength: 300; minLength: 1; pattern: "^[\s\S]\S[\s\S]$"
string fields
Value: string.
maxLength: 10000; minLength: 1; pattern: "^[\s\S]\S[\s\S]$"
string fields
Value: string.
maxLength: 1000; minLength: 1; pattern: "^(?=[\s\S]\S)[^\r\n]$"
string fields
Value: string.
enum: ["00:00","01:00","02:00","03:00","04:00","05:00","06:00","07:00","08:00","09:00","10:00","11:00","12:00","13:00","14:00","15:00","16:00","17:00","18:00","19:00","20:00","21:00","22:00","23:00"]; maxLength: 1000; minLength: 1; pattern: "^(?=[\s\S]\S)[^\r\n]$"
string fields
Value: string.
enum: ["00:00","01:00","02:00","03:00","04:00","05:00","06:00","07:00","08:00","09:00","10:00","11:00","12:00","13:00","14:00","15:00","16:00","17:00","18:00","19:00","20:00","21:00","22:00","23:00"]; maxLength: 1000; minLength: 1; pattern: "^(?=[\s\S]\S)[^\r\n]$"
string fields
Value: string.
maxLength: 300; minLength: 1; pattern: "^[\s\S]\S[\s\S]$"
string fields
Value: string.
maxLength: 300; minLength: 1; pattern: "^[\s\S]\S[\s\S]$"
string fields
Value: string.
maxLength: 300; minLength: 1; pattern: "^[\s\S]\S[\s\S]$"
string fields
Value: string.
maxLength: 300; minLength: 1; pattern: "^[\s\S]\S[\s\S]$"
string fields
Value: string.
maxLength: 300; minLength: 1; pattern: "^[\s\S]\S[\s\S]$"
string fields
Value: string.
maxLength: 1000; minLength: 1; pattern: "^(?=[\s\S]\S)[^\r\n]$"
string fields
Value: string.
maxLength: 300; minLength: 1; pattern: "^[\s\S]\S[\s\S]$"
string fields
Value: string.
maxLength: 300; minLength: 1; pattern: "^[\s\S]\S[\s\S]$"
string fields
Value: string.
maxLength: 300; minLength: 1; pattern: "^[\s\S]\S[\s\S]$"
string fields
Value: string.
maxLength: 10000; minLength: 1; pattern: "^[\s\S]\S[\s\S]$"
array of object fields
Value: array of object.
maxItems: 20
Array items: object.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
booking_count |
integer | Yes | minimum: 1 |
ends_at |
string | Yes | |
session_id |
string | Yes | |
starts_at |
string | Yes |
required: ["session_id","starts_at","ends_at","booking_count"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
end |
string | Yes | |
start |
string | Yes | |
weekday |
integer | Yes | maximum: 6; minimum: 0 |
required: ["weekday","start","end"]
array of object fields
Value: array of object.
Array items: object.
array of object fields
Value: array of object.
Array items: object.
object or null fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
amount_minor |
integer | Yes | |
captured_minor |
integer | Yes | |
created_at |
string | Yes | minLength: 1 |
currency |
string | Yes | minLength: 1 |
payment_id |
string | Yes | minLength: 1 |
receipt_url |
string or null | Yes | |
refunded_minor |
integer | Yes | |
state |
string | Yes | enum: ["pending","captured","failed","recovery","refunded"] |
required: ["payment_id","state","currency","amount_minor","captured_minor","refunded_minor","receipt_url","created_at"]
array of object fields
Value: array of object.
Array items: object.
object or null fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
detail |
string or null | Yes | |
state |
string | Yes | enum: ["pending","pushed","needs_review"] |
required: ["state","detail"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
adults |
integer | Yes | |
arrival_time |
string or null | Yes | pattern: "^([01]\d|2[0-3]):[0-5]\d$" |
channel |
string | Yes | enum: ["airbnb","vrbo","booking_com","direct"] |
check_in_date |
string | Yes | pattern: "^\d{4}-\d{2}-\d{2}$" |
check_out_date |
string | Yes | pattern: "^\d{4}-\d{2}-\d{2}$" |
children |
integer | Yes | |
guest_name |
string or null | Yes | |
guest_surname |
string or null | Yes | |
id |
string | Yes | minLength: 1 |
infants |
integer | Yes | |
overbooked |
boolean | Yes | |
owner |
string | Yes | enum: ["app","channel"] |
product_id |
string | Yes | minLength: 1 |
status |
string | Yes | enum: ["pending","confirmed","cancelled"] |
additionalProperties: false; required: ["id","product_id","channel","owner","status","overbooked","check_in_date","check_out_date","arrival_time","adults","children","infants","guest_name","guest_surname"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
adults |
integer | Yes | |
arrival_time |
string or null | Yes | pattern: "^([01]\d|2[0-3]):[0-5]\d$" |
channel |
string | Yes | enum: ["airbnb","vrbo","booking_com","direct"] |
check_in_date |
string | Yes | pattern: "^\d{4}-\d{2}-\d{2}$" |
check_out_date |
string | Yes | pattern: "^\d{4}-\d{2}-\d{2}$" |
children |
integer | Yes | |
guest_name |
string or null | Yes | |
guest_surname |
string or null | Yes | |
id |
string | Yes | minLength: 1 |
infants |
integer | Yes | |
location_id |
string | Yes | minLength: 1 |
overbooked |
boolean | Yes | |
owner |
string | Yes | enum: ["app","channel"] |
product_id |
string | Yes | minLength: 1 |
request_id |
string or null | Yes | The guest conversation about this stay, for get_guest_conversation and reply_to_guest. Null until a named guest with email or phone opens one; an existing conversation is retained. |
status |
string | Yes | enum: ["pending","confirmed","cancelled"] |
timezone |
string | Yes | minLength: 1 |
version |
integer | Yes |
additionalProperties: false; required: ["id","product_id","channel","owner","status","overbooked","check_in_date","check_out_date","arrival_time","adults","children","infants","guest_name","guest_surname","location_id","timezone","request_id","version"]
array of string fields
Value: array of string.
maxItems: 50; uniqueItems: true
Array items: string.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
available |
boolean or null | Yes | The host’s answer; null is unanswered. No review or approval is implied. |
feature |
string | Yes | enum: ["step_free_access","wide_doorway"] |
photo_ids |
array of string (fields) | Yes | Evidence image IDs in the home’s Product photo order. Empty for false or unknown answers. maxItems: 50; uniqueItems: true |
additionalProperties: false; required: ["feature","available","photo_ids"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
actor |
string or null | Yes | |
attachments |
array of object (fields) | Yes | |
body |
string or null | Yes | |
booking_change |
object or null (fields) | Yes | Canonical proposal details and current response state. A pending proposal does not change the operational record. required: ["status","before","after","locationTitle","originalLocationTitle"] |
channel |
string or null | Yes | |
deliveries |
array of object (fields) | Yes | |
event |
string or null | Yes | |
id |
string | Yes | |
kind |
string | Yes | |
occurred_at |
string | Yes | |
payload |
object or null | No | |
provider_timestamp |
string or null | Yes |
required: ["id","kind","actor","channel","body","event","occurred_at","provider_timestamp","booking_change","deliveries","attachments"]
object or null fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
attachmentCount |
integer | Yes | |
body |
string | Yes | |
createdAt |
string | Yes | |
id |
string | Yes | |
senderId |
string or null | Yes |
required: ["id","senderId","body","attachmentCount","createdAt"]
object or null fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
id |
string | Yes | |
slug |
string | Yes | |
timezone |
string | Yes | |
title |
string | Yes |
required: ["id","title","slug","timezone"]
array of object fields
Value: array of object.
Array items: object.
object or null fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
checkInDate |
string | Yes | |
checkOutDate |
string | Yes | |
homeName |
string | Yes | |
id |
string | Yes | |
productId |
string | Yes | |
status |
string | Yes | enum: ["pending","confirmed","cancelled"] |
required: ["id","productId","homeName","checkInDate","checkOutDate","status"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
height |
number or null | Yes | |
id |
string | Yes | |
url |
string | Yes | |
width |
number or null | Yes |
required: ["id","url","width","height"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
channel |
string | Yes | enum: ["email","whatsapp","push"] |
error |
string or null | Yes | |
id |
string | Yes | |
status |
string | Yes | |
updatedAt |
string | Yes |
required: ["id","channel","status","error","updatedAt"]
boolean fields
Value: boolean.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
id |
string | Yes | |
label |
string | Yes |
additionalProperties: false; required: ["id","label"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
name |
string | Yes | |
text |
string or null | No |
additionalProperties: false; required: ["name"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
label |
string | Yes | |
url |
string or null | No |
additionalProperties: false; required: ["label"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
body |
string or null | No | Markdown. |
description |
string or null | No | |
icon |
string or null | No | |
label |
string or null | No | |
title |
string | Yes | |
url |
string or null | No | |
value |
string or null | No |
additionalProperties: false; required: ["title"]
array of array of number or string or null fields
Value: array of array of number or string or null.
Array items: array of number or string or null.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
description |
string or null | No | |
title |
string | Yes |
additionalProperties: false; required: ["title"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
title |
string | Yes | |
value |
string | Yes |
additionalProperties: false; required: ["value","title"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
description |
string or null | No | |
icon |
string or null | No | |
prompt |
string or null | No | |
title |
string | Yes |
additionalProperties: false; required: ["title"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
title |
string | Yes |
additionalProperties: false; required: ["title"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
locale |
string | Yes | enum: ["en","ja","th","vi"] |
title |
string | Yes |
additionalProperties: false; required: ["title","locale"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
title |
string | Yes | |
url |
string or null | No |
additionalProperties: false; required: ["title"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
bio |
string or null | No | |
first_name |
string | Yes | |
last_name |
string or null | No | |
title |
string or null | No |
additionalProperties: false; required: ["first_name"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
amount |
string or null | No | |
description |
string or null | No | |
title |
string | Yes |
additionalProperties: false; required: ["title"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
copy_label |
string or null | No | |
description |
string or null | No | |
prompt |
string or null | No | |
title |
string | Yes |
additionalProperties: false; required: ["title"]
string fields
Value: string.
enum: ["media","gallery","featured","decoration","parallax_sky","parallax_sky_xxs","parallax_sky_xs","parallax_sky_sm","parallax_sky_md","parallax_sky_lg","parallax_clouds","parallax_clouds_xxs","parallax_clouds_xs","parallax_clouds_sm","parallax_clouds_md","parallax_clouds_lg","parallax_mountains","parallax_mountains_xxs","parallax_mountains_xs","parallax_mountains_sm","parallax_mountains_md","parallax_mountains_lg","parallax_far_trees","parallax_far_trees_xxs","parallax_far_trees_xs","parallax_far_trees_sm","parallax_far_trees_md","parallax_far_trees_lg","parallax_building_trees","parallax_building_trees_xxs","parallax_building_trees_xs","parallax_building_trees_sm","parallax_building_trees_md","parallax_building_trees_lg","parallax_foreground","parallax_foreground_xxs","parallax_foreground_xs","parallax_foreground_sm","parallax_foreground_md","parallax_foreground_lg"]
string fields
Value: string.
examples: ["items.0.image"]; pattern: "^items\.\d+\.image$"
string fields
Value: string.
examples: ["items.0.left"]; pattern: "^items\.\d+\.left$"
string fields
Value: string.
examples: ["items.0.center"]; pattern: "^items\.\d+\.center$"
string fields
Value: string.
examples: ["items.0.right"]; pattern: "^items\.\d+\.right$"
string fields
Value: string.
examples: ["images.0"]; pattern: "^images\.\d+$"
string fields
Value: string.
examples: ["features.0.icon"]; pattern: "^features\.\d+\.icon$"
string fields
Value: string.
examples: ["people.0.image"]; pattern: "^people\.\d+\.image$"
array of object fields
Value: array of object.
maxItems: 20
Array items: object.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
id |
string | No | Existing choice ID to keep. Omit for a new choice; one is assigned from its label. maxLength: 64; pattern: "^[a-z0-9][a-z0-9_-]{0,63}$" |
label |
string | Yes | maxLength: 120; minLength: 1 |
additionalProperties: false; required: ["label"]
string fields
Value: string.
minLength: 1
object fields
Value: object.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
ends_on |
string or null (fields) | Yes | |
kind |
string | Yes | const: "closure" |
note |
string or null | Yes | maxLength: 1000 |
starts_on |
string | Yes | Gregorian calendar date, YYYY-MM-DD. No timezone conversion. format: "date"; pattern: "^\d{4}-\d{2}-\d{2}$" |
additionalProperties: false; required: ["kind","starts_on","ends_on","note"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
date |
string | Yes | Gregorian calendar date, YYYY-MM-DD. No timezone conversion. format: "date"; pattern: "^\d{4}-\d{2}-\d{2}$" |
kind |
string | Yes | const: "hours" |
note |
string or null | Yes | maxLength: 1000 |
periods |
array of object (fields) | Yes |
additionalProperties: false; required: ["kind","date","periods","note"]
string fields
Value: string.
enum: ["media","featured","decoration","parallax_sky","parallax_sky_xxs","parallax_sky_xs","parallax_sky_sm","parallax_sky_md","parallax_sky_lg","parallax_clouds","parallax_clouds_xxs","parallax_clouds_xs","parallax_clouds_sm","parallax_clouds_md","parallax_clouds_lg","parallax_mountains","parallax_mountains_xxs","parallax_mountains_xs","parallax_mountains_sm","parallax_mountains_md","parallax_mountains_lg","parallax_far_trees","parallax_far_trees_xxs","parallax_far_trees_xs","parallax_far_trees_sm","parallax_far_trees_md","parallax_far_trees_lg","parallax_building_trees","parallax_building_trees_xxs","parallax_building_trees_xs","parallax_building_trees_sm","parallax_building_trees_md","parallax_building_trees_lg","parallax_foreground","parallax_foreground_xxs","parallax_foreground_xs","parallax_foreground_sm","parallax_foreground_md","parallax_foreground_lg"]
object or null fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
email |
string or null | No | |
name |
string or null | No |
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
createdAt |
string | Yes | format: "date-time" |
id |
string | Yes | |
teamId |
string | Yes | |
userId |
string | Yes |
required: ["id","teamId","userId","createdAt"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
code |
string | Yes | |
message |
string | Yes |
required: ["code","message"]
string fields
Value: string.
enum: ["list","read","publish","delete"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
id |
string | No | |
sort_order |
integer | No | |
value |
string | Yes |
additionalProperties: false; required: ["value"]
integer fields
Value: integer.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
active |
boolean | No | |
compare_at_unit_amount |
integer or null | No | minimum: 0 |
currency |
string | No | ISO 4217 currency code. pattern: "^[A-Z]{3}$" |
id |
string | No | The id of a price this variant already has. Restating it keeps the price row, which payments and checkout holds reference; a price without an id is a new offer. |
location_id |
string or null | No | Scope this offer to one location, or null for every location the product is offered at. |
recurring_interval |
string or null | No | enum: ["day","week","month","year",null] |
recurring_interval_count |
integer or null | No | minimum: 1 |
tax_behavior |
string | No | enum: ["unspecified","inclusive","exclusive"] |
type |
string | No | enum: ["one_time","recurring"] |
unit_amount |
integer | Yes | maximum: 9007199254740991; minimum: 0 |
valid_from_at |
string or null | No | format: "date-time" |
valid_until_at |
string or null | No | format: "date-time" |
additionalProperties: false; required: ["unit_amount"]
array of object fields
Value: array of object.
Array items: object.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
available |
boolean | Yes | |
code |
string | Yes | enum: ["ac","dryer","essentials","heating","hot_water","kitchen","tv","washer","wireless_internet","bathtub","bidet","body_soap","cleaning_products","conditioner","hair_dryer","alfresco_shower","shampoo","shower_gel","bed_linens","wardrobe_or_closet","clothes_drying_rack","extra_pillows_and_blankets","hangers","iron","mosquito_net","room_darkening_shades","safe","arcade_machine","batting_cage","books","bowling_alley","climbing_wall","ethernet_connection","exercise_equipment","game_console","laser_tag","life_size_games","mini_golf","home_theater","piano","ping_pong_table","pool_table","record_player","skate_ramp","sound_system","theme_room","baby_bath","baby_monitor","childrens_bike","playroom","stair_gates","babysitter_recommendations","board_games","changing_table","childrens_books_and_toys","childrens_dinnerware","crib","fireplace_guards","high_chair","playground","outlet_covers","pack_n_play_travel_crib","table_corner_guards","window_guards","ceiling_fan","fireplace","portable_fans","carbon_monoxide_detector","fire_extinguisher","first_aid_kit","smoke_detector","laptop_friendly_workspace","pocket_wifi","baking_sheet","barbeque_utensils","bread_maker","blender","coffee","coffee_maker","cooking_basics","dining_table","dishes_and_silverware","dishwasher","freezer","hot_water_kettle","kitchenette","microwave","mini_fridge","oven","refrigerator","rice_maker","stove","toaster","trash_compacter","wine_glasses","beach_access","lake_access","laundromat_nearby","private_entrance","resort_access","ski_in_ski_out","waterfront","garden_or_backyard","bbq_area","beach_essentials","bicycle","boat_slip","fire_pit","hammock","kayak","alfresco_dining","outdoor_seating","outdoor_kitchen","patio_or_belcony","sun_loungers","free_parking","street_parking","paid_parking_on_premises","paid_parking","free_parking_off_premises","elevator","ev_charger","hockey_rink","gym","jacuzzi","pool","private_living_room","sauna","single_level_home","ebike_charger","solar_power","recycling","composting","doorman","gated_community","breakfast","cleaning_before_checkout","long_term_stays_allowed","luggage_dropoff_allowed","bay_view","beach_view","canal_view","city_view","courtyard_view","desert_view","garden_view","golf_view","harbor_view","lake_view","marina_view","mountain_view","ocean_view","park_view","pool_view","resort_view","river_view","sea_view","valley_view","vineyard_view","landmark_view"] |
additionalProperties: false; required: ["code","available"]
array of object fields
Value: array of object.
Array items: object.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
currency |
string | Yes | ISO 4217 currency code. pattern: "^[A-Z]{3}$" |
location_id |
string or null | Yes | |
recurring_interval |
string | No | enum: ["day","week","month","year"] |
recurring_interval_count |
integer | No | minimum: 1 |
type |
string | Yes | enum: ["one_time","recurring"] |
unit_amount |
integer | Yes | minimum: 0 |
variant_id |
string | Yes |
required: ["variant_id","location_id","currency","unit_amount","type"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
active |
boolean | No | Enable or disable this product. Increasing the number of live homes requires the dashboard. |
description |
string | No | |
details |
object (fields) | No | Named customer-facing facts for the product kind. This is a complete replacement map; preserve fields to retain. pricing_note contains explicitly stated price wording and requires empty numeric prices. additionalProperties: false |
kind |
string | No | const: "dish" |
marketing_features |
array of string (fields) | No | Generic selling bullets. Inclusions, preparation instructions and policies are separate details. maxItems: 15 |
metadata |
object | No | Opaque string annotations for integrations. No pricing, scheduling, stock or filtering behavior may read these. additionalProperties: {"type":"string"} |
name |
string | Yes | |
options |
array of object (fields) | No | maxItems: 3 |
order_url |
string or null | No | External ordering or booking destination, such as Uber Eats, an experience checkout, or Clio Grow. When set, public actions use this URL instead of native booking. Null restores the configured native flow. |
product_id |
string | No | |
tax_code |
string or null | No | |
unit_label |
string or null | No | A unit noun such as "person" or "night". Never pricing prose. |
variants |
array of object (fields) | No | Partial existing variants by id or new variants. Omitted variants and prices remain; use update_product for intentional removal. maxItems: 250; minItems: 1 |
additionalProperties: false; required: ["name"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
active |
boolean | Yes | The merchant sale switch. Not visibility and not stock: a disabled product is not sold out. |
collections |
array of object (fields) | Yes | |
description |
string | Yes | |
details |
object (fields) | Yes | additionalProperties: false |
id |
string | Yes | |
kind |
string | Yes | const: "dish" |
locations |
array of object (fields) | Yes | |
marketing_features |
array of string (fields) | Yes | |
metadata |
object | Yes | additionalProperties: {"type":"string"} |
name |
string | Yes | |
options |
array of object (fields) | Yes | |
order_url |
string or null | Yes | |
publications |
array of object (fields) | Yes | |
slug |
string | Yes | |
tax_code |
string or null | Yes | |
unit_label |
string or null | Yes | |
updated_at |
string | Yes | |
variants |
array of object (fields) | Yes |
additionalProperties: false; required: ["id","kind","name","slug","description","active","order_url","unit_label","marketing_features","metadata","tax_code","options","variants","details","publications","locations","collections","updated_at"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
active |
boolean | No | |
compare_at_unit_amount |
integer or null | No | minimum: 0 |
currency |
string | No | ISO 4217 currency code. pattern: "^[A-Z]{3}$" |
id |
string | No | The id of a price this variant already has. Restating it keeps the price row, which payments and checkout holds reference; a price without an id is a new offer. |
location_id |
string or null | No | Scope this offer to one location, or null for every location the product is offered at. |
recurring_interval |
string or null | No | enum: ["day","week","month","year",null] |
recurring_interval_count |
integer or null | No | minimum: 1 |
tax_behavior |
string | No | enum: ["unspecified","inclusive","exclusive"] |
type |
string | No | enum: ["one_time","recurring"] |
unit_amount |
integer | No | maximum: 9007199254740991; minimum: 0 |
valid_from_at |
string or null | No | format: "date-time" |
valid_until_at |
string or null | No | format: "date-time" |
additionalProperties: false; required: []
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
category |
string | Yes | |
rating |
number | Yes |
required: ["category","rating"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
amount_minor |
integer | Yes | |
created_at |
string | Yes | minLength: 1 |
created_by |
string | Yes | minLength: 1 |
currency |
string | Yes | minLength: 1 |
id |
string | Yes | minLength: 1 |
method |
string | Yes | enum: ["cash","bank_transfer","card_external","other"] |
note |
string or null | Yes | |
paid_on |
string | Yes | pattern: "^\d{4}-\d{2}-\d{2}$" |
reference |
string or null | Yes | |
stay_id |
string | Yes | minLength: 1 |
required: ["id","stay_id","amount_minor","currency","method","paid_on","reference","note","created_at","created_by"]
array of object fields
Value: array of object.
Array items: object.
object or null fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
after |
object (fields) | Yes | required: ["whenLabel","partySize","assignedMemberId","assignedMemberName"] |
before |
object (fields) | Yes | required: ["whenLabel","partySize","assignedMemberId","assignedMemberName"] |
locationTitle |
string | Yes | |
message |
string | No | |
originalLocationTitle |
string | Yes | |
status |
string | Yes | enum: ["pending","accepted","declined","withdrawn","stale","expired"] |
required: ["status","before","after","locationTitle","originalLocationTitle"]
array of object fields
Value: array of object.
Array items: object.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
id |
string | Yes | |
image |
string or null | Yes | |
memberId |
string | Yes | |
name |
string | Yes |
required: ["id","memberId","name","image"]
array of number or string or null fields
Value: array of number or string or null.
Array items: number or string or null.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
id |
string | Yes | Stable choice ID. maxLength: 64; pattern: "^[a-z0-9][a-z0-9_-]{0,63}$" |
label |
string | Yes | maxLength: 120; minLength: 1 |
additionalProperties: false; required: ["id","label"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
close |
object (fields) | Yes | additionalProperties: false; required: ["day","hour","minute"] |
open |
object (fields) | Yes | additionalProperties: false; required: ["day","hour","minute"] |
additionalProperties: false; required: ["open","close"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
open |
object (fields) | Yes | additionalProperties: false; required: ["day","hour","minute"] |
additionalProperties: false; required: ["open"]
string or null fields
Value: string or null.
array of object fields
Value: array of object.
Array items: object.
integer fields
Value: integer.
const: -1
integer fields
Value: integer.
maximum: 1125; minimum: 1
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
id |
string | Yes | |
sort_order |
integer | Yes | |
value |
string | Yes |
required: ["id","value","sort_order"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
active |
boolean | Yes | |
compare_at_unit_amount |
integer or null | No | |
currency |
string | Yes | |
id |
string | Yes | |
location_id |
string or null | Yes | The location this offer applies at, or null for a location-neutral offer. Null is a declared scope, not a missing value. |
recurring_interval |
string or null | No | enum: ["day","week","month","year",null] |
recurring_interval_count |
integer or null | No | |
tax_behavior |
string | Yes | enum: ["unspecified","inclusive","exclusive"] |
type |
string | Yes | enum: ["one_time","recurring"] |
unit_amount |
integer | Yes | Integer amount in the currency smallest unit. |
valid_from_at |
string or null | No | |
valid_until_at |
string or null | No |
additionalProperties: false; required: ["id","location_id","active","currency","unit_amount","type","tax_behavior"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
allergens |
array of string (fields) | No | Allergens the merchant states this dish contains. maxItems: 100; uniqueItems: true |
dietary_notes |
array of string (fields) | No | Merchant-stated dietary facts displayed with a dish. maxItems: 100; uniqueItems: true |
featured |
boolean | No | Highlight this item on the menu and homepage. |
ingredients |
array of string (fields) | No | Ingredients shown in the dish details. maxItems: 100; uniqueItems: true |
noodle |
array of string (fields) | No | Authored noodle information shown as dish facts; these do not establish purchasable variants. maxItems: 100; uniqueItems: true |
pricing_note |
string | No | An explicitly stated price such as Market price; use only when no numeric price is set. maxLength: 1000; minLength: 1; pattern: "^(?=[\s\S]\S)[^\r\n]$" |
sizes |
array of string (fields) | No | Authored serving information; priced choices belong in variants. maxItems: 100; uniqueItems: true |
soup |
array of string (fields) | No | Authored soup information shown with the dish. maxItems: 100; uniqueItems: true |
tagline |
string | No | A short sentence shown below the product title. maxLength: 1000; minLength: 1; pattern: "^(?=[\s\S]\S)[^\r\n]$" |
toppings |
array of string (fields) | No | Authored topping information; priced choices belong in variants. maxItems: 100; uniqueItems: true |
additionalProperties: false
array of object fields
Value: array of object.
maxItems: 250; minItems: 1
Array items: object.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
allergens |
array of string (fields) | No | Allergens the merchant states this dish contains. maxItems: 100; uniqueItems: true |
dietary_notes |
array of string (fields) | No | Merchant-stated dietary facts displayed with a dish. maxItems: 100; uniqueItems: true |
featured |
boolean | No | Highlight this item on the menu and homepage. |
ingredients |
array of string (fields) | No | Ingredients shown in the dish details. maxItems: 100; uniqueItems: true |
noodle |
array of string (fields) | No | Authored noodle information shown as dish facts; these do not establish purchasable variants. maxItems: 100; uniqueItems: true |
pricing_note |
string | No | An explicitly stated price such as Market price; use only when no numeric price is set. maxLength: 1000; minLength: 1; pattern: "^(?=[\s\S]\S)[^\r\n]$" |
sizes |
array of string (fields) | No | Authored serving information; priced choices belong in variants. maxItems: 100; uniqueItems: true |
soup |
array of string (fields) | No | Authored soup information shown with the dish. maxItems: 100; uniqueItems: true |
tagline |
string | No | A short sentence shown below the product title. maxLength: 1000; minLength: 1; pattern: "^(?=[\s\S]\S)[^\r\n]$" |
toppings |
array of string (fields) | No | Authored topping information; priced choices belong in variants. maxItems: 100; uniqueItems: true |
additionalProperties: false
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
alt |
string or null | Yes | |
height |
integer or null | Yes | |
id |
string | Yes | |
url |
string | Yes | |
width |
integer or null | Yes |
required: ["id","url","alt","width","height"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
assignedMemberId |
string or null | Yes | |
assignedMemberName |
string or null | Yes | |
partySize |
integer | Yes | |
whenLabel |
string | Yes |
required: ["whenLabel","partySize","assignedMemberId","assignedMemberName"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
channel |
string | Yes | |
id |
string | Yes | |
purpose |
string | Yes | |
status |
string | Yes |
required: ["id","channel","purpose","status"]
number or string or null fields
Value: number or string or null.
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
day |
integer | Yes | maximum: 6; minimum: 0 |
hour |
integer | Yes | maximum: 23; minimum: 0 |
minute |
integer | Yes | maximum: 59; minimum: 0 |
additionalProperties: false; required: ["day","hour","minute"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
day |
number | Yes | const: 0 |
hour |
number | Yes | const: 0 |
minute |
number | Yes | const: 0 |
additionalProperties: false; required: ["day","hour","minute"]
string fields
Value: string.
format: "date"; pattern: "^\d{4}-\d{2}-\d{2}$"
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
close_day_offset |
enum | Yes | enum: [0,1] |
close_time |
string | Yes | Local wall-clock time, HH:mm (24-hour), in the explicitly selected location timezone. pattern: "^(?:[01]\d|2[0-3]):[0-5]\d$" |
open_time |
string | Yes | Local wall-clock time, HH:mm (24-hour), in the explicitly selected location timezone. pattern: "^(?:[01]\d|2[0-3]):[0-5]\d$" |
additionalProperties: false; required: ["open_time","close_time","close_day_offset"]
object fields
| Field | Type | Required | Description and constraints |
|---|---|---|---|
active |
boolean | No | |
id |
string | No | |
name |
string | No | |
option_values |
object | No | Option id to option value id. Every option must be answered exactly once, and no two variants may answer identically. additionalProperties: {"type":"string"} |
prices |
array of object (fields) | No | Partial existing prices by id or new offers. Omitted prices remain. A new offer requires unit_amount. maxItems: 20 |
sku |
string or null | No | |
sort_order |
integer | No |
additionalProperties: false; required: []
array of object fields
Value: array of object.
maxItems: 20
Array items: object.