Skip to main content
POST
Create Live Update

Authorizations

Authorization
string
header
required

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

Body

application/json
title
string
required

Title of the live update

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

"Temporary System Maintenance"

message
string
required

Detailed message for the live update

Required string length: 10 - 2000
Example:

"We are currently performing system maintenance. Expected completion time is 2 PM."

type
enum<string>
required

Type of live update

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

"announcement"

starts_at
string<date-time>
required

When the live update becomes active (ISO 8601 format)

Example:

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

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"

expires_at
string<date-time> | null

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

Example:

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

phone_number_ids
integer[] | null

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

Maximum array length: 50
Example:

Response

Live update created successfully

data
object
message
string
Example:

"Live update created successfully."