Skip to main content
POST
Create an experience

Authorizations

x-api-key
string
header
required

Which app is calling, and its usage plan: a platform's secret key, from servers only, or an app's publishable key (pk_live_...), safe in app code. It identifies the app and grants nothing on its own.

Authorization
string
header
required

A platform's short-lived issuer token, for the same client as the key.

Headers

Idempotency-Key
string

Chosen by you. Recommended. Unique per request, honoured for 24 hours.

Required string length: 1 - 255

Body

application/json
name
string
required

The item's name, as the hub card and on-air graphics show it.

Required string length: 1 - 200
starts_at
string<date-time>

When it starts. Items inherit it as their default starts_at.

ends_at
string<date-time>

Optional. When it ends; moderation items expire after it.

metadata
object

Free-form tags: up to 50 keys of up to 40 characters, values up to 500. One reserved key, event_id: the event the item is about. Every other key is yours, and never interpreted.

locale
string

BCP 47 language tag, such as en-GB. One language per experience. The hub's locale if you leave it out.

hub_id
string

In a creator network, the hub that shows the experience. Required for networks, fixed once set.

Pattern: ^hub_[0-9A-HJKMNP-TV-Z]{26}$

Response

The new experience.

id
string
required
Pattern: ^exp_[0-9A-HJKMNP-TV-Z]{26}$
Example:

"exp_01JBX7Q2T8M4K9R6V3N5P0WZCD"

name
string
required
status
enum<string>
required

Worked out from its items: live if any item is, else hidden, else closed.

Available options:
scheduled,
live,
hidden,
closed,
deleted
qr_image_url
string<uri> | null
required

The experience's QR code.

starts_at
string<date-time> | null
required
ends_at
string<date-time> | null
required
metadata
object
required

Free-form tags: up to 50 keys of up to 40 characters, values up to 500. One reserved key, event_id: the event the item is about. Every other key is yours, and never interpreted.

locale
string
required
items
object[]
required

Every item, types mixed, in display order, results included.

created_at
string<date-time>
required

RFC 3339, in UTC.

updated_at
string<date-time>
required

RFC 3339, in UTC.

hub_id
string

A hub in a creator network: one creator's fan site, registered under the network's client ID. Present only in creator networks; a client without a network has no hub ID.

Pattern: ^hub_[0-9A-HJKMNP-TV-Z]{26}$