Skip to main content
POST
Create an unpublished event for the header-selected studio

Authorizations

Authorization
string
header
required

Batch Relay scoped API key or an anonymous Test Mode session. Scope names document required capabilities. Anonymous sessions are sandbox-only and do not authorize studio, event, billing, or Live Mode operations.

Headers

X-Studio-ID
string
required

Required public studio ID. It selects the tenant for this request and is independently authorized against the API credential.

Required string length: 5 - 256
Pattern: ^stu_
Idempotency-Key
string
required
Required string length: 1 - 200
X-BatchRelay-Client-Surface
string

Untrusted optional analytics hint naming the calling client surface. It never affects authorization, routing, pricing, or behavior.

Required string length: 1 - 100
X-BatchRelay-Client-Version
string

Untrusted optional analytics hint naming the calling client version. It never affects authorization, routing, pricing, or behavior.

Required string length: 1 - 100
X-BatchRelay-Invocation-Mode
string

Untrusted optional analytics hint naming the invocation mode. It never affects authorization, routing, pricing, or behavior.

Required string length: 1 - 100

Body

application/json

Creates an unpublished event. A form and template must be configured before it can accept orders.

city
string
required
Required string length: 1 - 240
name
string
required
Required string length: 1 - 240
ends_on
string<date>
starts_on
string<date>

Response

Unpublished studio event

id
string
required

Stable public event ID, never a Convex document ID.

Minimum string length: 1
name
string
required
Minimum string length: 1
status
string
required
Minimum string length: 1
studio_id
string
required
Minimum string length: 1
studio_name
string
required
Minimum string length: 1
active_form_revision_id
string
ends_at
string<date-time>
starts_at
string<date-time>