Skip to content
Start here

Rules

List Waiting Room Rules
GET/zones/{zone_id}/waiting_rooms/{waiting_room_id}/rules
Create Waiting Room Rule
POST/zones/{zone_id}/waiting_rooms/{waiting_room_id}/rules
Replace Waiting Room Rules
PUT/zones/{zone_id}/waiting_rooms/{waiting_room_id}/rules
Patch Waiting Room Rule
PATCH/zones/{zone_id}/waiting_rooms/{waiting_room_id}/rules/{rule_id}
Delete Waiting Room Rule
DELETE/zones/{zone_id}/waiting_rooms/{waiting_room_id}/rules/{rule_id}
ModelsExpand Collapse
WaitingRoomRule { id, action, description, 4 more }
id: optional string

The ID of the rule.

action: optional "bypass_waiting_room"

The action to take when the expression matches.

description: optional string

The description of the rule.

enabled: optional boolean

When set to true, the rule is enabled.

expression: optional string

Criteria defining when there is a match for the current rule.

last_updated: optional string
formatdate-time
version: optional string

The version of the rule.