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. *
  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. Once a field has been used, its inputType cannot be changed.
    3. *
  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.
    4. *
*

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.

Fields Operations