Fields

Dynamic schema extension system that adds per-space fields to any supported module (Contact, Business Case, Todo, Invoice, and more).

Three-level hierarchy:

*
1. Field Group (/field-group) — a named container that groups related fields. Groups are attached to spaces or directly to specific records via the spaces or entities properties.
*
2. Field (/field) — a single field definition within a group. Defines the inputType (text, email, date, datetime, money, url, select, multiselect, ...), validation rules, and display options. The inputType of a field can be changed later, except for a protected field, where the change is ignored. The change is rejected with error 4025 when other fields depend on the field: it is the relation of a Rollup field and the new type is not a related entity type, it is the target of a Rollup field and the new type is Rollup, Calculation or does not support the aggregation of that Rollup, or it is referenced by a Related value field.
*
3. Field Value — the per-record value stored when creating or updating an entity. Pass values inside customFieldsValues on any supported entity request, referencing fields by customFieldInputId or customFieldInputName.
*

Use GET /field/of/{module}/{spaceId} to discover all fields available for a specific module and space.

For select/multiselect fields, submit the option value (not the display label). Use GET /field/{id} to retrieve valid option values.