Skip to main content
PATCH
Update an editable event form revision

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-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

Stable public studio ID beginning with stu_. The API never selects a studio implicitly; a local CLI profile name is not a studio ID.

Required string length: 5 - 256
Pattern: ^stu_[A-Za-z0-9_-]+$
event_id
string
required
Required string length: 1 - 256
form_revision_id
string
required
Required string length: 1 - 256

Body

application/json
expected_edit_version
integer
required
Required range: x >= 1
fields
object[]
required
Maximum array length: 200
form_presentation
object

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

Response

Updated draft revision

edit_version
integer
required
Required range: x >= 1
event_id
string
required
Minimum string length: 1
fields
object[]
required
Maximum array length: 200
id
string
required

Stable public form-revision ID.

Minimum string length: 1
status
string
required
Minimum string length: 1
studio_id
string
required
Minimum string length: 1
base_revision_id
string
created_at
string<date-time>
form_definition_id
string

Present when this event revision derives from a reusable definition.

Minimum string length: 1
form_presentation
object

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

published_at
string<date-time>
updated_at
string<date-time>