POST /zones/{zone_id}/waiting_rooms/{waiting_room_id}/rules

Only available for the Waiting Room Advanced subscription. Creates a rule for a waiting room.

Servers

Path parameters

Name Type Required Description
waiting_room_id String Yes
zone_id String Yes

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
action String Yes

The action to take when the expression matches.

Possible values:

  • "bypass_waiting_room"
description String No

The description of the rule.

expression String Yes

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

enabled Boolean No

When set to true, the rule is enabled.

Default value: true

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.