Skip to main content
PATCH
Update Live Update

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
integer
required

The ID of the live update

Body

application/json
title
string

Title of the live update

Required string length: 3 - 255
Pattern: ^[a-zA-Z0-9\s\-_.!?()\x27&@#]+$
Example:

"Updated System Maintenance"

message
string

Detailed message for the live update

Required string length: 10 - 2000
Example:

"System maintenance has been extended. New expected completion time is 4 PM."

Optional URL for Flash Sale updates. Active Flash Sale links are available as text links.

Maximum string length: 500
Example:

"https://example.com/weekend-sale"

type
enum<string>

Type of live update

Available options:
announcement,
wait_time,
flash_sale,
closure,
schedule_change
Example:

"announcement"

starts_at
string<date-time>

When the live update becomes active (ISO 8601 format)

Example:

"2025-07-25T14:00:00Z"

expires_at
string<date-time> | null

When the live update expires (null for no expiration, must be after starts_at)

Example:

"2025-07-25T18:00:00Z"

is_cancelled
boolean

Whether to cancel (true) or restore (false) the live update

Example:

false

phone_number_ids
integer[] | null

Array of phone number IDs to apply this update to (empty array means all locations, null means no change)

Maximum array length: 50
Example:

Response

Live update updated successfully

data
object
message
enum<string>
Available options:
Live update updated successfully.,
Live update cancelled successfully.,
Live update restored successfully.
Example:

"Live update updated successfully."