Create workspace field

post

https://ingest.spektr.com/v1/fields

Create a new workspace field definition. Field names must be unique within the workspace.

Flat fields (e.g. input, select, checkbox, file) store a single scalar value per customer record (string, number, boolean, date, etc.). They do not use the subFields property.

Object fields (type: "object") store structured, nested data as a JSON array of objects. They must include a non-empty subFields array defining the schema for each entry. Sub-fields can themselves be of type object, enabling recursive nesting.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

The workspace field definition to create

type

string

enum

required

Field input type

category

array of strings

required

Categories the field belongs to

category*

Allowed:

groups

array of strings

Groups the field belongs to

groups

attributes

object

required

Field display attributes (name, label, placeholder, etc.)

validation

array of objects

Validation rules to apply to the field

validation

config

object

required

Field configuration including the Spektr data field mapping

locked

boolean

required

Whether the field is locked from editing

subFields

array of objects

Sub-field definitions — required when type is "object", must be omitted for all other types. Defines the schema for each entry in the object array. Sub-fields can themselves be of type "object" for recursive nesting.

subFields

Responses

401

Unauthorized — missing or invalid API key

201Workspace field created successfully

400Payload validation failed (e.g. duplicate field name, invalid sub-field configuration)