Skip to main content
POST
Archive studio event

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-BatchRelay-Delegated-Authorization
string

Original delegated Clerk OAuth bearer. Go independently verifies signature/current revocation, exact resource audience, allowed OAuth client and action scope. Caller must match attributed API key creator. Never send an unverified subject header.

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

Path Parameters

studio_id
string
required

Opaque public studio_id. Private Convex IDs are rejected.

event_id
string
required

Opaque public event_id. Private Convex IDs are rejected.

Body

application/json
expected_edit_version
integer<int64>
required
Required range: x >= 1

Response

Authoritative Studio result

city
string
required
edit_version
integer<int64>
required
id
string
required
lifecycle_status
string
required
name
string
required
slug
string
required
status
string
required
studio_id
string
required
studio_name
string
required
teams
object[]
required
active_form_revision_id
string
draft_form_revision_id
string
ends_at
string
ends_on
string
event_type
string
semantic_year_override
string
starts_at
string
starts_on
string
template_external_id
string