Skip to main content
PATCH
Update Schema

Authorizations

Authorization
string
header
required

Client secret for management API access. Format: vela_cs_...

Path Parameters

appId
string
required

App UUID or slug

schemaId
string
required

Schema identifier

Body

application/json
description
string

Human-readable description

fields
object[]

Replaces existing fields entirely

metadataFields
object[]

Replaces existing metadata fields entirely

Response

Updated schema

id
string

Schema identifier

appId
string<uuid>

Associated app

eventName
string

Event name (unique per app)

description
string

Human-readable description

fields
object[]

Event data field definitions

metadataFields
object[]

Metadata field definitions

createdAt
string<date-time>
updatedAt
string<date-time>