Patch event - Cloudflare

Patches a configured event for a waiting room.

Request

Path Params

event_id

string

required

waiting_room_id

string

required

zone_identifier

string

required

Body Params application/json

custom_page_html

string | null

optional

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.

Example:

{{#waitTimeKnown}} {{waitTime}} mins {{/waitTimeKnown}} {{^waitTimeKnown}} Event is prequeueing / Queue all enabled {{/waitTimeKnown}}

description

string

optional

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

Default:

Example:

Production event - DO NOT MODIFY

disable_session_renewal

boolean | null

optional

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

required

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

Example:

2021-09-28T17:00:00.000Z

event_start_time

string

required

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.

Example:

2021-09-28T15:30:00.000Z

name

string

required

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

Example:

production_webinar_event

new_users_per_minute

integer | null

optional

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.

>= 200<= 2147483647

prequeue_start_time

string | null

optional

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.

Example:

2021-09-28T15:00:00.000Z

queueing_method

string | null

optional

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

Example:

random

session_duration

integer | null

optional

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

>= 1<= 30

shuffle_at_event_start

boolean

optional

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:

false

suspended

boolean

optional

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:

false

total_active_users

integer | null

optional

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.

>= 200<= 2147483647

Example

{
    "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",
    "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": false,
    "suspended": false,
    "total_active_users": 200
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Patch event response

application/json

Body

allOf {2}

optional

object (api-response-single)

optional

errors

array [object {2}]

messages

required

Example:

[]

messages

array [object {2}]

messages

required

Example:

[]

result

required

success

enum<boolean>

required

Whether the API call was successful

Allowed value:

true

Example:

true

object

optional

result

object (event_result)

optional

Example

{
    "errors": [],
    "messages": [],
    "result": {
        "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",
        "id": "25756b2dfe6e378a06b033b670413757",
        "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": false,
        "suspended": false,
        "total_active_users": 200
    },
    "success": true
}

🟢200Patch event response failure