Skip to main content
POST
Archive studio form definition

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.

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.

form_definition_id
string
required

Opaque public form_definition_id. Private Convex IDs are rejected.

Body

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

Response

Authoritative Studio result

fields
object[]
required
Maximum array length: 200
id
string
required

Stable public form-definition ID.

Minimum string length: 1
name
string
required
Minimum string length: 1
studio_id
string
required
Minimum string length: 1
created_at
string
description
string
edit_version
integer<int64>
environment
string
form_presentation
object

Typed public form layout. It intentionally excludes heroStorageId, Convex IDs, athlete data, guardian data, and submitted answers.

form_spec
object

Versioned form definition with persistent option IDs. On writes, mutually exclusive with fields and form_presentation. Legacy revisions may omit this until their choices have IDs.

status
string
updated_at
string