Skip to main content

Partially update template

PATCH 
/templates/:templateId

Update several fields of template

Request​

Path Parameters

    templateId int64required

    The Id of the template object

    Example: 100000

Body

required

    config string

    The widget editor configuration field is connected to the translation locales field in JSON format

    description string

    Description of the template

    isCustomTemplate boolean

    Iindicates if a custom template is being used

    name string

    Name of the template

    siteId int64

    Site Id of the project this widget belongs to

    status string

    Template status

    Possible values: [DRAFT, ACTIVE, PAUSED]

    surveyDataConfig

    object

    Configuration settings for survey data collection.

    fields

    object[]

    required

  • Array [

    • elementId stringrequired
    id stringrequired
    isDeprecated boolean
    name stringrequired
    parentId string
    valueType stringrequired

    Possible values: [BOOLEAN, NUMBER, STRING, STRING_ARRAY, DATE, TIME]

  • ]

    • isCollectData booleanrequired
    methodTypes string[]required

    Possible values: [KAMELEOON, HTTP_REQUEST, CUSTOM_JS_CODE]

    requestSettings

    object

    headers

    object[]

  • Array [

    • customData

    object

    adobeAnalyticsVariableName string

    Variable name of the Adobe Analytics

    advancedProposedValues string

    Enables to set values for targeting conditions in the form of a JS table

    customEvalCode string

    Custom code that will be executed

    description string

    Description of the custom data

    format string

    Custom data value format

    Possible values: [BOOLEAN, NUMBER, STRING]

    gtmVariableName string

    Variable name of the Google Tag Manager

    isConstant boolean

    Indicates if the custom data is a constant

    isFiltrableVentilable boolean

    Indicates if custom data should be filtered and marked as available for breakdown

    isLearnable boolean

    Indicates if this data should be included in Kameleoon machine learning

    isLocalOnly boolean

    Indicates if the custom data is only stored on the user's device.

    method stringrequired

    Method through which a custom data will be transmitted

    Possible values: [ADOBE_ANALYTICS, CLIENT, CUSTOM_CODE, GTM, SDK, TC, TEALIUM]

    name stringrequired

    Name of the custom data

    siteId int64required

    Id of the project this record belongs

    tags string

    Tags that belong to this record

    tcVariableName string

    Name of the tag commander data layer, if it is selected as a transmission method

    tealiumVariableName string

    Name of the Tealium, if it is selected as a transmission method

    type string

    Custom data type. Custom data can be presented as a single value (UNIQUE), or a list of values (LIST), ​​or a countable list of values (COUNT_LIST)

    Possible values: [COUNT_LIST, LIST, UNIQUE]

    id stringrequired
    name stringrequired
    type stringrequired

    Possible values: [CUSTOM_DATA, CUSTOM_TEXT, LOCAL_STORAGE, COOKIES]

    value stringrequired

  • ]

    • name stringrequired
    type stringrequired

    Possible values: [GET, POST]

    url stringrequired

    triggerSettings

    object

    required

    type stringrequired

    Possible values: [CLICK, CLOSE, ANSWER]

    value string
    tags string[]

    Tags that belong to this template

    templateCssCode string

    CSS code that belongs to this template

    templateHtmlCode string

    HTML code that belongs to this template

    templateJavaScriptCode string

    JavaScript code that belongs to this template

    type string

    Type of template

    Possible values: [TEMPLATE, EDITOR]

    uiCssCode string

    UI CSS code that belongs to this template

    uiHtmlCode string

    UI HTML code belongs to this template

    url string

    Url belonging to this template

    useCustomData boolean

    Indicates if custom data is being used

    widgetEditorTemplate string

    Widget editor code that belongs to this template

Responses​

OK

Schema

    config string

    Widget editor configuration field linked to the translation locales field in JSON format.

    cssCode string

    CSS that belongs to this template.

    dateActivated date-time

    Date when the widget was activated.

    dateCreated date-time

    Date when this widget was created

    dateModified date-time

    Date when this widget was modified

    description string

    Description of the template.

    htmlCode string

    UI text that belongs to this template.

    id int64

    Unique Id of the template

    isCustomTemplate boolean

    Indicates if this is a custom template.

    name string

    Name of the template.

    siteId int64required

    Web Id of the studio template.

    status string

    Template status.

    Possible values: [DRAFT, ACTIVE, PAUSED]

    tags string[]

    Tags that belong to this template.

    templateCssCode string

    CSS code that belongs to this template.

    templateHtmlCode string

    HTML code that belongs to this template.

    templateJavaScriptCode string

    JavaScript code that belongs to this template.

    type string

    Type of template.

    Possible values: [TEMPLATE, EDITOR]

    url string

    Url associated with this template.

    useCustomData boolean

    Indicates if custom data is being used.

    widgetEditorTemplate string

    Widget editor code that belongs to this template.

Loading...