API Reference

Waiting Rooms

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Settings

Get zone-level Waiting Room settings

client.waitingRooms.settings.get(SettingGetParams { zone_id } params, RequestOptionsoptions?): SettingGetResponse { search_engine_crawler_bypass }

GET/zones/{zone_id}/waiting_rooms/settings

Update zone-level Waiting Room settings

client.waitingRooms.settings.update(SettingUpdateParams { zone_id, search_engine_crawler_bypass } params, RequestOptionsoptions?): SettingUpdateResponse { search_engine_crawler_bypass }

PUT/zones/{zone_id}/waiting_rooms/settings

Patch zone-level Waiting Room settings

client.waitingRooms.settings.edit(SettingEditParams { zone_id, search_engine_crawler_bypass } params, RequestOptionsoptions?): SettingEditResponse { search_engine_crawler_bypass }

PATCH/zones/{zone_id}/waiting_rooms/settings

ModelsExpand Collapse

Setting { search_engine_crawler_bypass }

search_engine_crawler_bypass: boolean

Whether to allow verified search engine crawlers to bypass all waiting rooms on this zone. Verified search engine crawlers will not be tracked or counted by the waiting room system, and will not appear in waiting room analytics.

SettingGetResponse { search_engine_crawler_bypass }

search_engine_crawler_bypass: boolean

Whether to allow verified search engine crawlers to bypass all waiting rooms on this zone. Verified search engine crawlers will not be tracked or counted by the waiting room system, and will not appear in waiting room analytics.

SettingUpdateResponse { search_engine_crawler_bypass }

search_engine_crawler_bypass: boolean

Whether to allow verified search engine crawlers to bypass all waiting rooms on this zone. Verified search engine crawlers will not be tracked or counted by the waiting room system, and will not appear in waiting room analytics.

SettingEditResponse { search_engine_crawler_bypass }

search_engine_crawler_bypass: boolean

Whether to allow verified search engine crawlers to bypass all waiting rooms on this zone. Verified search engine crawlers will not be tracked or counted by the waiting room system, and will not appear in waiting room analytics.