Partially update template - Kameleoon Documentation

PATCH

templates

{templateId}

Partially update template

curl --request PATCH \
  --url https://api.kameleoon.com/templates/{templateId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "config": "<string>",
  "description": "<string>",
  "isCustomTemplate": true,
  "name": "<string>",
  "siteId": 123,
  "tags": [
    "<string>"
  ],
  "templateCssCode": "<string>",
  "templateHtmlCode": "<string>",
  "templateJavaScriptCode": "<string>",
  "themeId": 123,
  "uiCssCode": "<string>",
  "uiHtmlCode": "<string>",
  "url": "<string>",
  "useCustomData": true,
  "widgetEditorTemplate": "<string>"
}
'

import requests

url = "https://api.kameleoon.com/templates/{templateId}"

payload = {
    "config": "<string>",
    "description": "<string>",
    "isCustomTemplate": True,
    "name": "<string>",
    "siteId": 123,
    "tags": ["<string>"],
    "templateCssCode": "<string>",
    "templateHtmlCode": "<string>",
    "templateJavaScriptCode": "<string>",
    "themeId": 123,
    "uiCssCode": "<string>",
    "uiHtmlCode": "<string>",
    "url": "<string>",
    "useCustomData": True,
    "widgetEditorTemplate": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    config: '<string>',
    description: '<string>',
    isCustomTemplate: true,
    name: '<string>',
    siteId: 123,
    tags: ['<string>'],
    templateCssCode: '<string>',
    templateHtmlCode: '<string>',
    templateJavaScriptCode: '<string>',
    themeId: 123,
    uiCssCode: '<string>',
    uiHtmlCode: '<string>',
    url: '<string>',
    useCustomData: true,
    widgetEditorTemplate: '<string>'
  })
};

fetch('https://api.kameleoon.com/templates/{templateId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.kameleoon.com/templates/{templateId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'config' => '<string>',
    'description' => '<string>',
    'isCustomTemplate' => true,
    'name' => '<string>',
    'siteId' => 123,
    'tags' => [
        '<string>'
    ],
    'templateCssCode' => '<string>',
    'templateHtmlCode' => '<string>',
    'templateJavaScriptCode' => '<string>',
    'themeId' => 123,
    'uiCssCode' => '<string>',
    'uiHtmlCode' => '<string>',
    'url' => '<string>',
    'useCustomData' => true,
    'widgetEditorTemplate' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.kameleoon.com/templates/{templateId}"

	payload := strings.NewReader("{\n  \"config\": \"<string>\",\n  \"description\": \"<string>\",\n  \"isCustomTemplate\": true,\n  \"name\": \"<string>\",\n  \"siteId\": 123,\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"templateCssCode\": \"<string>\",\n  \"templateHtmlCode\": \"<string>\",\n  \"templateJavaScriptCode\": \"<string>\",\n  \"themeId\": 123,\n  \"uiCssCode\": \"<string>\",\n  \"uiHtmlCode\": \"<string>\",\n  \"url\": \"<string>\",\n  \"useCustomData\": true,\n  \"widgetEditorTemplate\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.kameleoon.com/templates/{templateId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"config\": \"<string>\",\n  \"description\": \"<string>\",\n  \"isCustomTemplate\": true,\n  \"name\": \"<string>\",\n  \"siteId\": 123,\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"templateCssCode\": \"<string>\",\n  \"templateHtmlCode\": \"<string>\",\n  \"templateJavaScriptCode\": \"<string>\",\n  \"themeId\": 123,\n  \"uiCssCode\": \"<string>\",\n  \"uiHtmlCode\": \"<string>\",\n  \"url\": \"<string>\",\n  \"useCustomData\": true,\n  \"widgetEditorTemplate\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.kameleoon.com/templates/{templateId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"config\": \"<string>\",\n  \"description\": \"<string>\",\n  \"isCustomTemplate\": true,\n  \"name\": \"<string>\",\n  \"siteId\": 123,\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"templateCssCode\": \"<string>\",\n  \"templateHtmlCode\": \"<string>\",\n  \"templateJavaScriptCode\": \"<string>\",\n  \"themeId\": 123,\n  \"uiCssCode\": \"<string>\",\n  \"uiHtmlCode\": \"<string>\",\n  \"url\": \"<string>\",\n  \"useCustomData\": true,\n  \"widgetEditorTemplate\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "siteId": 123,
  "config": "<string>",
  "cssCode": "<string>",
  "dateActivated": "2023-11-07T05:31:56Z",
  "dateCreated": "2023-11-07T05:31:56Z",
  "dateModified": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "htmlCode": "<string>",
  "id": 123,
  "isCustomTemplate": true,
  "name": "<string>",
  "status": "DRAFT",
  "tags": [
    "<string>"
  ],
  "templateCssCode": "<string>",
  "templateHtmlCode": "<string>",
  "templateJavaScriptCode": "<string>",
  "themeId": 123,
  "type": "TEMPLATE",
  "url": "<string>",
  "useCustomData": true,
  "widgetEditorTemplate": "<string>"
}

{
  "code": "<string>",
  "impersonator": "<string>",
  "message": "<string>",
  "name": "<string>",
  "status": "SUCCESS",
  "sub": "<string>",
  "time": 123,
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "impersonator": "<string>",
  "message": "<string>",
  "name": "<string>",
  "status": "SUCCESS",
  "sub": "<string>",
  "time": 123,
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "impersonator": "<string>",
  "message": "<string>",
  "name": "<string>",
  "status": "SUCCESS",
  "sub": "<string>",
  "time": 123,
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "impersonator": "<string>",
  "message": "<string>",
  "name": "<string>",
  "status": "SUCCESS",
  "sub": "<string>",
  "time": 123,
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "impersonator": "<string>",
  "message": "<string>",
  "name": "<string>",
  "status": "SUCCESS",
  "sub": "<string>",
  "time": 123,
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "impersonator": "<string>",
  "message": "<string>",
  "name": "<string>",
  "status": "SUCCESS",
  "sub": "<string>",
  "time": 123,
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "impersonator": "<string>",
  "message": "<string>",
  "name": "<string>",
  "status": "SUCCESS",
  "sub": "<string>",
  "time": 123,
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "impersonator": "<string>",
  "message": "<string>",
  "name": "<string>",
  "status": "SUCCESS",
  "sub": "<string>",
  "time": 123,
  "timestamp": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

templateId

integer<int64>

required

The ID of the template object

Body

application/json

config

string

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

description

string

Description of the template

isCustomTemplate

boolean

Indicates if a custom template is in use

name

string

Name of the template

siteId

integer<int64>

Site ID of the project this widget belongs to

status

enum<string>

Template status

Available options:

DRAFT,

ACTIVE,

PAUSED

surveyDataConfig

object

Configuration settings for survey data collection.

Show child attributes

Response

siteId

integer<int64>

required

Web ID of the studio template.

config

string

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

cssCode

string

CSS that belongs to this template.

dateActivated

string<date-time>

read-only

Date of widget activation.

dateCreated

string<date-time>

read-only

Date of widget creation

dateModified

string<date-time>

read-only

Date of widget modification

description

string

Description of the template.

htmlCode

string

UI text that belongs to this template.

integer<int64>

read-only

Unique ID of the template

isCustomTemplate

boolean

Indicates if this is a custom template.

name

string

Name of the template.

status

enum<string>

Template status.

Available options:

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.

themeId

integer<int64>

ID of the theme linked to the widget.

type

enum<string>

Type of template.

Available options:

TEMPLATE,

EDITOR,

PBX

url

string

URL associated with this template.

useCustomData

boolean

Indicates if custom data is in use.

Widget editor code that belongs to this template.

⌘I

Partially update template

curl --request PATCH \
  --url https://api.kameleoon.com/templates/{templateId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "config": "<string>",
  "description": "<string>",
  "isCustomTemplate": true,
  "name": "<string>",
  "siteId": 123,
  "tags": [
    "<string>"
  ],
  "templateCssCode": "<string>",
  "templateHtmlCode": "<string>",
  "templateJavaScriptCode": "<string>",
  "themeId": 123,
  "uiCssCode": "<string>",
  "uiHtmlCode": "<string>",
  "url": "<string>",
  "useCustomData": true,
  "widgetEditorTemplate": "<string>"
}
'

import requests

url = "https://api.kameleoon.com/templates/{templateId}"

payload = {
    "config": "<string>",
    "description": "<string>",
    "isCustomTemplate": True,
    "name": "<string>",
    "siteId": 123,
    "tags": ["<string>"],
    "templateCssCode": "<string>",
    "templateHtmlCode": "<string>",
    "templateJavaScriptCode": "<string>",
    "themeId": 123,
    "uiCssCode": "<string>",
    "uiHtmlCode": "<string>",
    "url": "<string>",
    "useCustomData": True,
    "widgetEditorTemplate": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    config: '<string>',
    description: '<string>',
    isCustomTemplate: true,
    name: '<string>',
    siteId: 123,
    tags: ['<string>'],
    templateCssCode: '<string>',
    templateHtmlCode: '<string>',
    templateJavaScriptCode: '<string>',
    themeId: 123,
    uiCssCode: '<string>',
    uiHtmlCode: '<string>',
    url: '<string>',
    useCustomData: true,
    widgetEditorTemplate: '<string>'
  })
};

fetch('https://api.kameleoon.com/templates/{templateId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.kameleoon.com/templates/{templateId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'config' => '<string>',
    'description' => '<string>',
    'isCustomTemplate' => true,
    'name' => '<string>',
    'siteId' => 123,
    'tags' => [
        '<string>'
    ],
    'templateCssCode' => '<string>',
    'templateHtmlCode' => '<string>',
    'templateJavaScriptCode' => '<string>',
    'themeId' => 123,
    'uiCssCode' => '<string>',
    'uiHtmlCode' => '<string>',
    'url' => '<string>',
    'useCustomData' => true,
    'widgetEditorTemplate' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.kameleoon.com/templates/{templateId}"

	payload := strings.NewReader("{\n  \"config\": \"<string>\",\n  \"description\": \"<string>\",\n  \"isCustomTemplate\": true,\n  \"name\": \"<string>\",\n  \"siteId\": 123,\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"templateCssCode\": \"<string>\",\n  \"templateHtmlCode\": \"<string>\",\n  \"templateJavaScriptCode\": \"<string>\",\n  \"themeId\": 123,\n  \"uiCssCode\": \"<string>\",\n  \"uiHtmlCode\": \"<string>\",\n  \"url\": \"<string>\",\n  \"useCustomData\": true,\n  \"widgetEditorTemplate\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.kameleoon.com/templates/{templateId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"config\": \"<string>\",\n  \"description\": \"<string>\",\n  \"isCustomTemplate\": true,\n  \"name\": \"<string>\",\n  \"siteId\": 123,\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"templateCssCode\": \"<string>\",\n  \"templateHtmlCode\": \"<string>\",\n  \"templateJavaScriptCode\": \"<string>\",\n  \"themeId\": 123,\n  \"uiCssCode\": \"<string>\",\n  \"uiHtmlCode\": \"<string>\",\n  \"url\": \"<string>\",\n  \"useCustomData\": true,\n  \"widgetEditorTemplate\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.kameleoon.com/templates/{templateId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"config\": \"<string>\",\n  \"description\": \"<string>\",\n  \"isCustomTemplate\": true,\n  \"name\": \"<string>\",\n  \"siteId\": 123,\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"templateCssCode\": \"<string>\",\n  \"templateHtmlCode\": \"<string>\",\n  \"templateJavaScriptCode\": \"<string>\",\n  \"themeId\": 123,\n  \"uiCssCode\": \"<string>\",\n  \"uiHtmlCode\": \"<string>\",\n  \"url\": \"<string>\",\n  \"useCustomData\": true,\n  \"widgetEditorTemplate\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "siteId": 123,
  "config": "<string>",
  "cssCode": "<string>",
  "dateActivated": "2023-11-07T05:31:56Z",
  "dateCreated": "2023-11-07T05:31:56Z",
  "dateModified": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "htmlCode": "<string>",
  "id": 123,
  "isCustomTemplate": true,
  "name": "<string>",
  "status": "DRAFT",
  "tags": [
    "<string>"
  ],
  "templateCssCode": "<string>",
  "templateHtmlCode": "<string>",
  "templateJavaScriptCode": "<string>",
  "themeId": 123,
  "type": "TEMPLATE",
  "url": "<string>",
  "useCustomData": true,
  "widgetEditorTemplate": "<string>"
}

{
  "code": "<string>",
  "impersonator": "<string>",
  "message": "<string>",
  "name": "<string>",
  "status": "SUCCESS",
  "sub": "<string>",
  "time": 123,
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "impersonator": "<string>",
  "message": "<string>",
  "name": "<string>",
  "status": "SUCCESS",
  "sub": "<string>",
  "time": 123,
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "impersonator": "<string>",
  "message": "<string>",
  "name": "<string>",
  "status": "SUCCESS",
  "sub": "<string>",
  "time": 123,
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "impersonator": "<string>",
  "message": "<string>",
  "name": "<string>",
  "status": "SUCCESS",
  "sub": "<string>",
  "time": 123,
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "impersonator": "<string>",
  "message": "<string>",
  "name": "<string>",
  "status": "SUCCESS",
  "sub": "<string>",
  "time": 123,
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "impersonator": "<string>",
  "message": "<string>",
  "name": "<string>",
  "status": "SUCCESS",
  "sub": "<string>",
  "time": 123,
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "impersonator": "<string>",
  "message": "<string>",
  "name": "<string>",
  "status": "SUCCESS",
  "sub": "<string>",
  "time": 123,
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "impersonator": "<string>",
  "message": "<string>",
  "name": "<string>",
  "status": "SUCCESS",
  "sub": "<string>",
  "time": 123,
  "timestamp": "2023-11-07T05:31:56Z"
}

APIs

Authorizations

Path Parameters

Body

Response