Model: SettingsFieldUpdateRequest

1 min

Model Parameters

SettingsFieldUpdateRequest
- objectBaseSettingsFieldUpdatePayload
  - typestringrequired
    Description
    Type of the field. This field is required but not updateable. Type of a field will always stay the same. Update request body must contain atleast one other updateable field.
  - namestring
    Example
    Sample Field
    Description
    Name of the field
    Min Length
    1
  - helper_textstring
    Example
    This is a helper text
    Description
    Used to help understand the functionality of the field.
    Max Length
    120
  - is_activeboolean
    Example
    true
    Description
    Indicates active status of field. Inactive fields cannot be accessed in tasks, campaigns or workflows.
- objectLabelAndDropdownTypeSettingsFieldUpdatePayload
  - typestringrequired
    Description
    Type of the field. This field is required but not updateable. Type of a field will always stay the same. Update request body must contain atleast one other updateable field.
  - namestring
    Example
    Sample Field
    Description
    Name of the field
    Min Length
    1
  - helper_textstring
    Example
    This is a helper text
    Description
    Used to help understand the functionality of the field.
    Max Length
    120
  - is_activeboolean
    Example
    true
    Description
    Indicates active status of field. Inactive fields cannot be accessed in tasks, campaigns or workflows.
  - is_multi_selectboolean
    Description
    Allow users to select multiple values
- objectGenericNumberTypeSettingsFieldUpdatePayload
  - typestringrequired
    Description
    Type of the field. This field is required but not updateable. Type of a field will always stay the same. Update request body must contain atleast one other updateable field.
  - namestring
    Example
    Sample Field
    Description
    Name of the field
    Min Length
    1
  - helper_textstring
    Example
    This is a helper text
    Description
    Used to help understand the functionality of the field.
    Max Length
    120
  - is_activeboolean
    Example
    true
    Description
    Indicates active status of field. Inactive fields cannot be accessed in tasks, campaigns or workflows.
  - has_thousand_separatorboolean
    Example
    true
    Description
    Whether the numerical field has a thousand separator
    Default
    false
  - decimal_placesinteger
    Example
    2
    Description
    Decimal place of the numerical field. This must be greather than 0. If this field is empty, 2 is set as the default.
    Default
    2
- objectCurrencyNumberTypeSettingsFieldUpdatePayload
  - typestringrequired
    Description
    Type of the field. This field is required but not updateable. Type of a field will always stay the same. Update request body must contain atleast one other updateable field.
  - namestringrequired
    Example
    Sample Field
    Description
    Name of the field
    Min Length
    1
  - helper_textstringrequired
    Example
    This is a helper text
    Description
    Used to help understand the functionality of the field.
    Max Length
    120
  - is_activebooleanrequired
    Example
    true
  - has_thousand_separatorbooleanrequired
    Example
    true
    Description
    Whether the numerical field has a thousand separator
    Default
    false
  - decimal_placesintegerrequired
    Example
    2
    Default
    2
  - currency_codestring
    Example
    USD
    Description
    Currency code of the numerical field. This must be a valid currency code. If this field is empty, USD is set as the default.
    Default
    USD