Skip to main content
PUT
Update a record configuration

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Record configuration ID

Body

application/json

All fields are optional. Omitted fields are left unchanged. Schema changes do not retroactively affect existing records.

name
string

Updated human-readable name.

description
string

Updated description.

label
string

Updated label.

schema
object

A JSON Schema document describing the record structure. Always a top-level object. UI and display hints (ui, display) are embedded directly in each field definition.

views
object

UI layout definitions for different rendering contexts. forms (multiple named forms) is the current model. form (singular) is the deprecated legacy single form — the server still accepts it, but the frontend migrates it to forms: [{ id: "default", ... }] on read and never writes it back.

index_fields
object[]

Payload fields lifted into the search index: the only ones a query, filter or metric can use. Replaced wholesale on update; an added or changed field, or a journey edit under a derived field, starts a background reindex.

Response

Updated record configuration

status_code
integer

HTTP status code echoed in the response body.

body
object

Response payload.