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

waiting_rooms.settings.get(SettingGetParams**kwargs) -> SettingGetResponse

GET/zones/{zone_id}/waiting_rooms/settings

Update zone-level Waiting Room settings

waiting_rooms.settings.update(SettingUpdateParams**kwargs) -> SettingUpdateResponse

PUT/zones/{zone_id}/waiting_rooms/settings

Patch zone-level Waiting Room settings

waiting_rooms.settings.edit(SettingEditParams**kwargs) -> SettingEditResponse

PATCH/zones/{zone_id}/waiting_rooms/settings

ModelsExpand Collapse

class Setting: …

search_engine_crawler_bypass: bool

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.

class SettingGetResponse: …

search_engine_crawler_bypass: bool

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.

class SettingUpdateResponse: …

search_engine_crawler_bypass: bool

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.

class SettingEditResponse: …

search_engine_crawler_bypass: bool

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.