Model: CustomFieldRequestBody

1 min

Model Parameters

CustomFieldRequestBody
- archivedboolean
  Description
  Whether the custom field is archived. New custom fields are created as unarchived by default.
- default_valuestring
  Example
  option1
  Description
  Default value for the custom field if applicable.
- 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.
  Max Length
  1000
- entity_typestring<flag | rule>required
  Example
  flag
  Description
  Type of entity the custom field is associated with
  Allowed
  flagrule
- field_typestring<text | number | boolean | link | label>required
  Example
  text
  Description
  The type of the custom field (e.g., text, number, boolean, link, label)
  Allowed
  textnumberbooleanlinklabel
- keystringrequired
  Example
  analytics_team
  Description
  Unique user-defined identifier for the CustomField within the project. Must contain only alphanumeric characters, underscores, and hyphens.
- namestringrequired
  Example
  Analytics Team
  Description
  Human-readable name for the CustomField displayed in the UI.
- requiredboolean
  Description
  Indicates if the custom field is required for the associated entity.
- validationobject
  Example
```
{
  "max": 100,
  "max_length": 255,
  "min": 1
}
```
  Description
  Validation rules for the custom field if applicable. Allowed keys depend on field_type:
  
  text → max_length, regex
  
  number → min, max, decimal_places, use_thousand_separator
  
  label → field_options, allow_multi_select
  
  link → no validation fields
  
  boolean → no validation fields
  - allow_multi_selectboolean
    Description
    Whether multiple values can be selected for label fields.
  - decimal_placesinteger
    Example
    2
    Description
    Number of allowed decimal places for numeric values.
  - field_optionsstring[]
    Example
    [ "US", "EU", "APAC" ]
    Description
    Allowed values for label fields.
  - maxnumber
    Example
    100
    Description
    Maximum value for number fields.
  - max_lengthinteger
    Example
    255
    Description
    Maximum length for string fields.
  - minnumber
    Example
    1
    Description
    Minimum value for number fields.
  - regexstring
    Example
    ^[A-Za-z0-9_-]+$
    Description
    Regular expression that the input must match.
  - use_thousand_separatorboolean
    Example
    true
    Description
    Whether thousand separators should be permitted/displayed.