Patch event

PATCH/zones/{zone_id}/waiting_rooms/{waiting_room_id}/events/{event_id}

Patches a configured event for a waiting room.

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

Accepted Permissions (at least one required)

Waiting Rooms Write

Path ParametersExpand Collapse

zone_id: string

Identifier.

maxLength32

waiting_room_id: string

event_id: string

Body ParametersJSONExpand Collapse

event_end_time: string

An ISO 8601 timestamp that marks the end of the event.

event_start_time: string

An ISO 8601 timestamp that marks the start of the event. At this time, queued users will be processed with the events configuration. The start time must be at least one minute before event_end_time.

name: string

A unique name to identify the event. Only alphanumeric characters, hyphens and underscores are allowed.

custom_page_html: optional string

If set, the event will override the waiting rooms custom_page_html property while it is active. If null, the event will inherit it.

description: optional string

A note that you can use to add more details about the event.

disable_session_renewal: optional boolean

If set, the event will override the waiting rooms disable_session_renewal property while it is active. If null, the event will inherit it.

new_users_per_minute: optional number

If set, the event will override the waiting rooms new_users_per_minute property while it is active. If null, the event will inherit it. This can only be set if the events total_active_users property is also set.

maximum2147483647

minimum200

prequeue_start_time: optional string

An ISO 8601 timestamp that marks when to begin queueing all users before the event starts. The prequeue must start at least five minutes before event_start_time.

queueing_method: optional string

If set, the event will override the waiting rooms queueing_method property while it is active. If null, the event will inherit it.

session_duration: optional number

If set, the event will override the waiting rooms session_duration property while it is active. If null, the event will inherit it.

maximum30

minimum1

shuffle_at_event_start: optional boolean

If enabled, users in the prequeue will be shuffled randomly at the event_start_time. Requires that prequeue_start_time is not null. This is useful for situations when many users will join the event prequeue at the same time and you want to shuffle them to ensure fairness. Naturally, it makes the most sense to enable this feature when the queueing_method during the event respects ordering such as fifo, or else the shuffling may be unnecessary.

suspended: optional boolean

Suspends or allows an event. If set to true, the event is ignored and traffic will be handled based on the waiting room configuration.

total_active_users: optional number

If set, the event will override the waiting rooms total_active_users property while it is active. If null, the event will inherit it. This can only be set if the events new_users_per_minute property is also set.

maximum2147483647

minimum200

turnstile_action: optional "log" or "infinite_queue"

If set, the event will override the waiting rooms turnstile_action property while it is active. If null, the event will inherit it.

One of the following:

"log"

"infinite_queue"

turnstile_mode: optional "off" or "invisible" or "visible_non_interactive" or "visible_managed"

If set, the event will override the waiting rooms turnstile_mode property while it is active. If null, the event will inherit it.

One of the following:

"off"

"invisible"

"visible_non_interactive"

"visible_managed"

ReturnsExpand Collapse

result: Event { id, created_on, custom_page_html, 15 more }

id: optional string

created_on: optional string

formatdate-time

custom_page_html: optional string

If set, the event will override the waiting rooms custom_page_html property while it is active. If null, the event will inherit it.

description: optional string

A note that you can use to add more details about the event.

disable_session_renewal: optional boolean

If set, the event will override the waiting rooms disable_session_renewal property while it is active. If null, the event will inherit it.

event_end_time: optional string

An ISO 8601 timestamp that marks the end of the event.

event_start_time: optional string

modified_on: optional string

formatdate-time

name: optional string

A unique name to identify the event. Only alphanumeric characters, hyphens and underscores are allowed.

new_users_per_minute: optional number

maximum2147483647

minimum200

prequeue_start_time: optional string

An ISO 8601 timestamp that marks when to begin queueing all users before the event starts. The prequeue must start at least five minutes before event_start_time.

queueing_method: optional string

If set, the event will override the waiting rooms queueing_method property while it is active. If null, the event will inherit it.

session_duration: optional number

If set, the event will override the waiting rooms session_duration property while it is active. If null, the event will inherit it.

maximum30

minimum1

shuffle_at_event_start: optional boolean

suspended: optional boolean

Suspends or allows an event. If set to true, the event is ignored and traffic will be handled based on the waiting room configuration.

total_active_users: optional number

maximum2147483647

minimum200

turnstile_action: optional "log" or "infinite_queue"

If set, the event will override the waiting rooms turnstile_action property while it is active. If null, the event will inherit it.

One of the following:

"log"

"infinite_queue"

turnstile_mode: optional "off" or "invisible" or "visible_non_interactive" or "visible_managed"

If set, the event will override the waiting rooms turnstile_mode property while it is active. If null, the event will inherit it.

One of the following:

"off"

"invisible"

"visible_non_interactive"

"visible_managed"

Patch event

curl https://api.cloudflare.com/client/v4/zones/$ZONE_ID/waiting_rooms/$WAITING_ROOM_ID/events/$EVENT_ID \
    -X PATCH \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $CLOUDFLARE_API_TOKEN" \
    -d '{
          "event_end_time": "2021-09-28T17:00:00.000Z",
          "event_start_time": "2021-09-28T15:30:00.000Z",
          "name": "production_webinar_event",
          "custom_page_html": "{{#waitTimeKnown}} {{waitTime}} mins {{/waitTimeKnown}} {{^waitTimeKnown}} Event is prequeueing / Queue all enabled {{/waitTimeKnown}}",
          "description": "Production event - DO NOT MODIFY",
          "prequeue_start_time": "2021-09-28T15:00:00.000Z",
          "queueing_method": "random"
        }'

200 example

{
  "result": {
    "id": "25756b2dfe6e378a06b033b670413757",
    "created_on": "2014-01-01T05:20:00.12345Z",
    "custom_page_html": "{{#waitTimeKnown}} {{waitTime}} mins {{/waitTimeKnown}} {{^waitTimeKnown}} Event is prequeueing / Queue all enabled {{/waitTimeKnown}}",
    "description": "Production event - DO NOT MODIFY",
    "disable_session_renewal": true,
    "event_end_time": "2021-09-28T17:00:00.000Z",
    "event_start_time": "2021-09-28T15:30:00.000Z",
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "name": "production_webinar_event",
    "new_users_per_minute": 200,
    "prequeue_start_time": "2021-09-28T15:00:00.000Z",
    "queueing_method": "random",
    "session_duration": 1,
    "shuffle_at_event_start": true,
    "suspended": true,
    "total_active_users": 200,
    "turnstile_action": "log",
    "turnstile_mode": "off"
  }
}

Returns Examples

200 example

{
  "result": {
    "id": "25756b2dfe6e378a06b033b670413757",
    "created_on": "2014-01-01T05:20:00.12345Z",
    "custom_page_html": "{{#waitTimeKnown}} {{waitTime}} mins {{/waitTimeKnown}} {{^waitTimeKnown}} Event is prequeueing / Queue all enabled {{/waitTimeKnown}}",
    "description": "Production event - DO NOT MODIFY",
    "disable_session_renewal": true,
    "event_end_time": "2021-09-28T17:00:00.000Z",
    "event_start_time": "2021-09-28T15:30:00.000Z",
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "name": "production_webinar_event",
    "new_users_per_minute": 200,
    "prequeue_start_time": "2021-09-28T15:00:00.000Z",
    "queueing_method": "random",
    "session_duration": 1,
    "shuffle_at_event_start": true,
    "suspended": true,
    "total_active_users": 200,
    "turnstile_action": "log",
    "turnstile_mode": "off"
  }
}