Model: LabelTypeSettingsFieldResponse

1 min

Model Parameters

LabelTypeSettingsFieldResponse
- objectBaseSettingsFieldsResponse
  - idstringrequired
    Example
    6ceee2f4fa3411ecb37802420ac8001b
    Description
    Identifier of the field
  - namestringrequired
    Example
    Sample Checkbox
    Description
    Name of the field
  - helper_textstringrequired
    Example
    This field is used to check options
    Description
    Used to help understand functionality of field
  - 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
  - linksobjectrequired
    Description
    Meta links
    - sourcestringrequired
      Example
      https://api.cmp.optimizely.com/v3/fields?ids=8p7f910551i00722y0418830aee6612
      Description
      URL of the list of fields filtered only with the field
- object
  - is_multi_selectbooleanrequired
    Description
    Allow users to select multiple values
  - choicesLabelTypeSettingsFieldChoiceResponse[]required
    Description
    Choices of the field
    - SettingsFieldChoiceResponse
      - idstringrequired
        Example
        6ceee2f4fa3411ecb37802420ac8001b
        Description
        Identifier of the choice
      - namestringrequired
        Example
        Choice 1
        Description
        Name of the choice
      - is_activebooleanrequired
        Example
        true
        Description
        Indicates active status of the choice. Inactive choices stay on the field. In the app, users cannot select them.
    - object
      - colorstringrequired
        Example
        #4ECFD5
        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)