CustomFieldInput

Fields accepted when creating a custom field. Unknown or read-only fields are rejected.

entity
Type: string | null
required

The table the field is on, e.g. gigs or venues. Fixed once created.
field_type
Type: string | nullenum
required

Fixed once created; to change a field’s type, retire it and add a new one.
values
- rich_text
- number
- currency
- date
- time
- checkbox
- select
- multi_select
label
Type: string | null
required
description
Type: string | null
key
Type: string | null

The column name: lowercase, starting with x_. Fixed once created.
options
Type: array of string | null

The allowed values of a select or multi_select field.
order
Type: number | null
relation
Type: string | null

The table a relation field points at. Fixed once created.
required
Type: boolean

New records must supply a value. Checked by the API, not the database.
status
Type: "active" or "retired" or nullenum

A retired field is hidden from the API and the app; its column and data stay.