Skip to main content
Version: Latest (4.0.6)

Store Field Setup

POST 
/fieldsetup-srv/fields

Creates a new field setup or updates an existing one (matched by fieldKey). Create returns 201; update returns 200.

Validation rules​

Required fields​

  • fieldKey: Unique identifier (cannot be changed after creation)
  • dataType: Valid datatype (TEXT, EMAIL, SELECT, and others)
  • fieldType: CUSTOM or SYSTEM (only CUSTOM can be created through this API)
  • localeTexts: At least one localized text entry
  • fieldDefinition: Validation rules for the datatype

Restrictions​

  • Cannot create fields with fieldType: SYSTEM
  • Cannot change fieldType on update
  • Cannot change dataType for SYSTEM fields
  • Creating or converting to dataType: CONSENT is rejected (CONSENT_FIELD_SETUP_DEPRECATED). Use Consent Management APIs.
  • order must be >= 0
  • parent_group_id cannot equal fieldKey

TEXT field validation​

  • Use either regex or minLength/maxLength, not both
  • Regex must be valid Go regex syntax
  • When only min/max length is provided, the service derives an internal regex

Remote field settings​

  • remoteFieldSettings is only supported when dataType is GROUPING

Field definition validation​

  • Date fields: minDate must be before maxDate
  • SELECT / RADIO / MULTISELECT: attributesKeys required
  • NUMBER: minLength / maxLength act as numeric range bounds

Request​

Responses​

OK