Extension Fields (User-Defined Fields)

Extension fields are optional (mandatory, if configured on your tenant) custom fields that can be included in PUT/POST requests using the extensionFields element.

Formatting Requirements

  • All extension field values must be JSON strings, regardless of the underlying data type. For example: dates, numbers, GUIDs, and booleans must be formatted as strings.
  • Field names must match the exact spelling from your tenant's ExtensionMetadata / DataDictionaryField configuration. Matching is case-insensitive.
  • Unknown field names or disabled component types will produce validation errors.

Enabled component types

These component types are enabled:

  • UserSelector

  • HTMLDisplay

  • ScoreableTextBox

  • MaskedTextBox

  • SetupDataCheckboxList

  • SetupMultiSelect

  • SetupDataRadioButtonList

  • SetupDataDropdownList

  • Money

  • DatePicker

  • FourLevelSelector

  • TextArea

  • MagicDropDown

  • DynamicSelect

  • GroupSelector

  • TextBox

Format examples

  • Text fields: "MyTextBox": "Single line text"
  • Dates: "MyDate": "2026-04-17" or "04/17/2026"
  • Money: "MyMoney": "12345.67"
  • Money with currency: "MyMoneyCurrency": "12345.67@USD" (format: amount@currencyCode)
  • Boolean (Checkbox): "MyCheckbox": "true" or "false"
  • Boolean (Yes/No): "MyYesNo": "Yes" or "No"
  • Multi-select: "MySetupMultiSelect": "CODE_A@CODE_B@CODE_C" (@ separator)
  • Checkbox list: "MySetupCheckboxList": "CODE_A@CODE_B" or "CODE_A|CODE_B" (@ or | separator)
  • GUIDs: "MyUserSelector": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"