Model: CustomFieldUpdateRequestBody

1 min

Model Parameters

CustomFieldUpdateRequestBody
- descriptionstring
  Example
  Custom field to tag experiments owned by the analytics team
  Description
  Optional detailed description explaining the purpose and context of this CustomField. Helps team members understand what this CustomField is measuring.
- namestring
  Example
  Analytics Team
  Description
  Human-readable name for the CustomField displayed in the UI.
- validationobject
  Description
  Validation rules for label fields. Only applicable when updating a label custom field. field_options is append-only: existing values cannot be removed, renamed, or reordered; new values must be added at the end. allow_multi_select is immutable once set.
  - allow_multi_selectboolean
    Description
    Whether multiple values can be selected for label fields.
  - field_optionsstring[]
    Example
    [ "US", "EU", "APAC" ]
    Description
    Allowed values for label fields (existing values plus any appended values).

Partial update payload. Supports name, description, and appending new label acceptable values via validation.field_options. Existing label values cannot be removed, renamed, or reordered; new values must be added at the end (append-only). allow_multi_select is immutable.