Model: TemplateResponse

1 min

Model Parameters

TemplateResponse
- objectBaseTemplateResponse
  - idstringrequired
    Example
    9119a313057e401189407116fcd3aa24
    Description
    Unique identifier of the template
  - is_activebooleanrequired
    Example
    true
    Description
    Active status of the template
  - titlestringrequired
    Example
    Sample Template Title
    Description
    Title of the template
  - descriptionstringrequired
    Example
    Sample Desciption
    Description
    Description of the template
  - applicable_tostring[]required
    Description
    List of resources the template is applicable to
- object
  - form_fieldsTemplateInstructionFormField[]required
    Description
    List of form fields
    - BaseTemplateFormField
      - identifierstringrequired
        Example
        attachment
        Description
        Identifier of the field
      - labelstringrequired
        Example
        Attach a file...
        Description
        Label of the field
      - helper_textstringrequired
        Example
        Sample helper text
        Description
        Helper text of the field
      - is_requiredbooleanrequired
        Description
        Required status of the field
      - is_readonlybooleanrequired
        Description
        Specify if the field can be used to create any resource
      - is_protectedboolean
        Description
        True when this form field is read-only and only organization admins can modify it. Absent or false for editable fields.
      - sort_orderintegerrequired
        Description
        Sort order of the field
      - typestring<brief | checkbox | currency_number | date | dropdown | file | instruction | label | percentage_number | radio_button | richtext | section | simple_number | text | text_area>required
        Example
        label
        Description
        Type of the field
        Allowed
        briefcheckboxcurrency_numberdatedropdownfileinstructionlabelpercentage_numberradio_buttonrichtextsectionsimple_numbertexttext_area
    - object
      - type_specific_metaobjectrequired
        Description
        Type-specific meta-information
        descriptionstringrequired
        Example
        just a message to inform something
        Description
        Description of the field
      - logic_rulesTemplateLogicRulerequired
  - linksobjectrequired
    Description
    Meta links
    - selfstringrequired
      Example
      https://api.cmp.optimizely.com/v3/templates/9119a313057e401189407116fcd3aa24
      Description
      URL of the template