Skip to main content

Changing Custom Field Definitions

When changing custom field definitions, you need to follow the following general rules and type-specific rules:

General Rules​

  • You cannot change a Custom Field Definition type after creation (e.g., changing a string field to a number field).
  • The Definition Key must be unique (within the app).

Type Rules​

Each field type has special rules:

  • Drop-down:

    • If an option is removed from a drop-down list, you must provide a valid replacement value via valueReplacements.

    • Any existing value that contains the deleted value will be changed to the replacement value.

    • If the replacement value is already selected, a duplicate value will not be created.

    • When changing a multi-select field to a single-select field, any value with more than one option selected will be cleared.

    • The previous, incompatible value is preserved and can be retrieved via the API in the lastIncompatibleValue field.

  • Number

    • Any existing value outside the new min/max range will be set to null.

    • The previous, incompatible value is preserved and can be retrieved via the API in the lastIncompatibleValue field.

  • String

    • If an existing value is longer than the new maximum length, the value will be truncated.

    • The previous, incompatible value is preserved and can be retrieved via the API in the lastIncompatibleValue field.

    • Regex patterns can be changed, but be warned that existing data can become uncompliant with the new pattern.