Skip to content
Start here

Rules

List Waiting Room Rules
client.WaitingRooms.Rules.Get(ctx, waitingRoomID, query) (*SinglePage[WaitingRoomRule], error)
GET/zones/{zone_id}/waiting_rooms/{waiting_room_id}/rules
Create Waiting Room Rule
client.WaitingRooms.Rules.New(ctx, waitingRoomID, params) (*SinglePage[WaitingRoomRule], error)
POST/zones/{zone_id}/waiting_rooms/{waiting_room_id}/rules
Replace Waiting Room Rules
client.WaitingRooms.Rules.Update(ctx, waitingRoomID, params) (*SinglePage[WaitingRoomRule], error)
PUT/zones/{zone_id}/waiting_rooms/{waiting_room_id}/rules
Patch Waiting Room Rule
client.WaitingRooms.Rules.Edit(ctx, waitingRoomID, ruleID, params) (*SinglePage[WaitingRoomRule], error)
PATCH/zones/{zone_id}/waiting_rooms/{waiting_room_id}/rules/{rule_id}
Delete Waiting Room Rule
client.WaitingRooms.Rules.Delete(ctx, waitingRoomID, ruleID, body) (*SinglePage[WaitingRoomRule], error)
DELETE/zones/{zone_id}/waiting_rooms/{waiting_room_id}/rules/{rule_id}
ModelsExpand Collapse
type WaitingRoomRule struct{…}
ID stringoptional

The ID of the rule.

Action WaitingRoomRuleActionoptional

The action to take when the expression matches.

Description stringoptional

The description of the rule.

Enabled booloptional

When set to true, the rule is enabled.

Expression stringoptional

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

LastUpdated Timeoptional
formatdate-time
Version stringoptional

The version of the rule.