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

Patches a configured event for a waiting room.

Servers

https://api.cloudflare.com/client/v4

Path parameters

Name	Type	Required	Description
`event_id`	String	Yes
`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
`custom_page_html`	String	No	If set, the event will override the waiting room's `custom_page_html` property while it is active. If null, the event will inherit it.
`session_duration`	Integer	No	If set, the event will override the waiting room's `session_duration` property while it is active. If null, the event will inherit it.
`description`	String	No	A note that you can use to add more details about the event.
`suspended`	Boolean	No	Suspends or allows an event. If set to `true`, the event is ignored and traffic will be handled based on the waiting room configuration. Default value: false
`disable_session_renewal`	Boolean	No	If set, the event will override the waiting room's `disable_session_renewal` property while it is active. If null, the event will inherit it.
`event_end_time`	String	Yes	An ISO 8601 timestamp that marks the end of the event.
`queueing_method`	String	No	If set, the event will override the waiting room's `queueing_method` property while it is active. If null, the event will inherit it.
`new_users_per_minute`	Integer	No	If set, the event will override the waiting room's `new_users_per_minute` property while it is active. If null, the event will inherit it. This can only be set if the event's `total_active_users` property is also set.
`event_start_time`	String	Yes	An ISO 8601 timestamp that marks the start of the event. At this time, queued users will be processed with the event's configuration. The start time must be at least one minute before `event_end_time`.
`name`	String	Yes	A unique name to identify the event. Only alphanumeric characters, hyphens and underscores are allowed.
`prequeue_start_time`	String	No	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`.
`total_active_users`	Integer	No	If set, the event will override the waiting room's `total_active_users` property while it is active. If null, the event will inherit it. This can only be set if the event's `new_users_per_minute` property is also set.
`turnstile_action`	String	No	If set, the event will override the waiting room's `turnstile_action` property while it is active. If null, the event will inherit it. Possible values: `"log"` `"infinite_queue"`
`turnstile_mode`	String	No	If set, the event will override the waiting room's `turnstile_mode` property while it is active. If null, the event will inherit it. Possible values: `"visible_non_interactive"` `"invisible"` `"off"` `"visible_managed"`
`shuffle_at_event_start`	Boolean	No	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. Default value: false

How to start integrating

Add HTTP Task to your workflow definition.
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.
Click Test request to test run your request to the API and see the API's response.