ConfigFieldDefinitionRequest

Request schema for creating/updating config field definitions

nameName (string)required

Field name in the configuration

labelLabel (string)required

Display label for this field

field_typeField Type (string)

Field type: text, password, url, email, tel, number, select, boolean, json, textarea

Default value: text

requiredRequired (boolean)

Whether this field is required

Default value: false

placeholder object

Placeholder text for the field

anyOf

• string
• null

string

help_text object

Help text to display with the field

anyOf

• string
• null

string

default_value object

Default value for this field

anyOf

• string
• null

string

validation_rules object

JSON validation rules

property name*any

JSON validation rules

optionsobject[]

Options for select fields

orderOrder (integer)

Display order for this field

Default value: 0

depends_on object

Show this field only when another field has a specific value

anyOf

• string
• null

string

depends_on_value object

The value the dependent field must have

anyOf

• string
• null

string

ConfigFieldDefinitionRequest

{
  "name": "string",
  "label": "string",
  "field_type": "text",
  "required": false,
  "placeholder": "string",
  "help_text": "string",
  "default_value": "string",
  "validation_rules": {},
  "options": [
    {}
  ],
  "order": 0,
  "depends_on": "string",
  "depends_on_value": "string"
}