Model: SettingsFieldCreateRequest

1 min

Model Parameters

SettingsFieldCreateRequest
- objectBaseSettingsFieldCreatePayload
  - namestringrequired
    Example
    Sample Checkbox
    Description
    Name of the field
    Min Length
    1
  - helper_textstring
    Example
    This field is used to check options
    Description
    Used to help understand the functionality of the field.
    Max Length
    120
  - is_activebooleanrequired
    Example
    true
    Description
    Indicates active status of field. Inactive fields cannot be accessed in tasks, campaigns or workflows.
  - typestringrequired
    Example
    checkbox
    Description
    Type of the field
- objectLabelTypeSettingsFieldCreatePayload
  - namestringrequired
    Example
    Sample Checkbox
    Description
    Name of the field
    Min Length
    1
  - helper_textstring
    Example
    This field is used to check options
    Description
    Used to help understand the functionality of the field.
    Max Length
    120
  - is_activebooleanrequired
    Example
    true
    Description
    Indicates active status of field. Inactive fields cannot be accessed in tasks, campaigns or workflows.
  - typestringrequired
    Example
    checkbox
    Description
    Type of the field
  - is_multi_selectbooleanrequired
    Description
    Allow users to select multiple values
  - choicesobject[]required
    Description
    Choices of the field
    - namestringrequired
      Example
      Choice 1
      Description
      Name of the choice
      Min Length
      1
    - colorstringrequired
      Example
      #FFC700
      Description
      Code of choice color. Colors are limited to the following:
      
      Electric Blue (#4ECFD5)
      
      Golden Rod (#FFC700)
      
      Salmon Pink (#FF98A7)
      
      Blue Violet (#702BD5)
      
      Spring Green (#5FEEAD)
      
      Lavender Blue (#D6C4F2)
      
      Sky (#5F9FF6)
      
      Persian blue (#CB5DEB)
      
      Cool Gray (#9694B3)
- objectDropdownTypeSettingsFieldCreatePayload
  - namestringrequired
    Example
    Sample Checkbox
    Description
    Name of the field
    Min Length
    1
  - helper_textstring
    Example
    This field is used to check options
    Description
    Used to help understand the functionality of the field.
    Max Length
    120
  - is_activebooleanrequired
    Example
    true
    Description
    Indicates active status of field. Inactive fields cannot be accessed in tasks, campaigns or workflows.
  - typestringrequired
    Example
    checkbox
    Description
    Type of the field
  - is_multi_selectbooleanrequired
    Description
    Allow users to select multiple values
  - choicesobject[]required
    Description
    Choices of the field
    - namestringrequired
      Example
      Choice 1
      Description
      Name of the choice
      Min Length
      1
- objectCheckboxAndRadioTypeSettingsFieldCreatePayload
  - namestringrequired
    Example
    Sample Checkbox
    Description
    Name of the field
    Min Length
    1
  - helper_textstring
    Example
    This field is used to check options
    Description
    Used to help understand the functionality of the field.
    Max Length
    120
  - is_activebooleanrequired
    Example
    true
    Description
    Indicates active status of field. Inactive fields cannot be accessed in tasks, campaigns or workflows.
  - typestringrequired
    Example
    checkbox
    Description
    Type of the field
  - choicesobject[]required
    Description
    Choices of the field
    - namestringrequired
      Example
      Choice 1
      Description
      Name of the choice
      Min Length
      1
- objectGenericNumberTypeSettingsFieldCreatePayload
  - namestringrequired
    Example
    Sample Checkbox
    Description
    Name of the field
    Min Length
    1
  - helper_textstring
    Example
    This field is used to check options
    Description
    Used to help understand the functionality of the field.
    Max Length
    120
  - is_activebooleanrequired
    Example
    true
    Description
    Indicates active status of field. Inactive fields cannot be accessed in tasks, campaigns or workflows.
  - typestringrequired
    Example
    checkbox
    Description
    Type of the field
  - 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
- objectCurrencyNumberTypeSettingsFieldCreatePayload
  - namestringrequired
    Example
    Sample Checkbox
    Description
    Name of the field
    Min Length
    1
  - helper_textstringrequired
    Example
    This field is used to check options
    Description
    Used to help understand the functionality of the field.
    Max Length
    120
  - is_activebooleanrequired
    Example
    true
  - typestringrequired
    Example
    checkbox
    Description
    Type of the field
  - 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