Skip to main content
POST
Create a record configuration

Authorizations

Authorization
string
header
required

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

Body

application/json
id
string
required

Unique identifier. Must be unique across all configurations. Allowed characters: alphanumeric, underscore, hyphen.

Pattern: ^[a-zA-Z0-9_-]+$
name
string
required

Human-readable name for this configuration.

description
string

Optional longer description.

label
string

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

Created record configuration

status_code
integer

HTTP status code echoed in the response body.

body
object

Response payload.