Variation

Partially update a variation

Update several fields of a variation

Warning: The Automation API doesn’t yet support personalizations migrated to the new model with rules. For a variation of a migrated personalization, this endpoint returns 200 and saves the code, but Kameleoon doesn’t regenerate the public script until you save the personalization in the Kameleoon app. Until Kameleoon releases API support, manage migrated personalizations in the Kameleoon app.

PATCH

variations

{variationId}

Partially update a variation

curl --request PATCH \
  --url https://api.kameleoon.com/variations/{variationId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "cssCode": "<string>",
  "experimentId": 123,
  "isJsCodeAfterDomReady": true,
  "jsCode": "<string>",
  "name": "<string>",
  "shadowDom": true
}
'

import requests

url = "https://api.kameleoon.com/variations/{variationId}"

payload = {
    "cssCode": "<string>",
    "experimentId": 123,
    "isJsCodeAfterDomReady": True,
    "jsCode": "<string>",
    "name": "<string>",
    "shadowDom": True
}
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({
    cssCode: '<string>',
    experimentId: 123,
    isJsCodeAfterDomReady: true,
    jsCode: '<string>',
    name: '<string>',
    shadowDom: true
  })
};

fetch('https://api.kameleoon.com/variations/{variationId}', 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/variations/{variationId}",
  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([
    'cssCode' => '<string>',
    'experimentId' => 123,
    'isJsCodeAfterDomReady' => true,
    'jsCode' => '<string>',
    'name' => '<string>',
    'shadowDom' => true
  ]),
  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/variations/{variationId}"

	payload := strings.NewReader("{\n  \"cssCode\": \"<string>\",\n  \"experimentId\": 123,\n  \"isJsCodeAfterDomReady\": true,\n  \"jsCode\": \"<string>\",\n  \"name\": \"<string>\",\n  \"shadowDom\": true\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/variations/{variationId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"cssCode\": \"<string>\",\n  \"experimentId\": 123,\n  \"isJsCodeAfterDomReady\": true,\n  \"jsCode\": \"<string>\",\n  \"name\": \"<string>\",\n  \"shadowDom\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.kameleoon.com/variations/{variationId}")

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  \"cssCode\": \"<string>\",\n  \"experimentId\": 123,\n  \"isJsCodeAfterDomReady\": true,\n  \"jsCode\": \"<string>\",\n  \"name\": \"<string>\",\n  \"shadowDom\": true\n}"

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

{
  "name": "<string>",
  "siteId": 123,
  "color": 123,
  "creationMode": "AI",
  "cssCode": "<string>",
  "customJson": "<string>",
  "experimentId": 123,
  "expositionFrequencyDelaySecondsBetweenTwoExpositions": 123,
  "expositionFrequencySameVisit": 123,
  "expositionFrequencySameVisitor": 123,
  "expositionFrequencySameVisitorDelaySeconds": 123,
  "forceNoFlicker": true,
  "id": 123,
  "isJsCodeAfterDomReady": true,
  "jsCode": "<string>",
  "personalizationId": 123,
  "prompt": {
    "textInput": "<string>",
    "attachments": [
      {
        "mediaType": "IMAGE",
        "name": "US-39613 Image attachment",
        "type": "TEMPORARY"
      }
    ],
    "promptSource": "<string>"
  },
  "redirection": {
    "includeQueryParameters": true,
    "parameters": "param1=foo&param2=bar",
    "type": "GLOBAL_REDIRECTION",
    "url": "www.kameleoon.com"
  },
  "redirectionStrings": "<string>",
  "shadowDom": true,
  "widgetTemplateInput": "<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

variationId

integer<int64>

required

Body

application/json

cssCode

string

Code editor CSS style

experimentId

integer<int64>

Experiment ID for this variation

isJsCodeAfterDomReady

boolean

Set to true (which is also the default value) if the code applies after the DOM is ready.

jsCode

string

Code editor JavaScript code

name

string

Name of the given variation

prompt

object

Object used to define an autorun message in the variation. Triggers the creation of a message of type autorun if valid

Show child attributes

shadowDom

boolean

ShadowDOM option

Response

JSON representation of the variation

name

string

required

Name of the variation

siteId

integer<int64>

required

Site ID of the project the variation belongs to

color

integer<int32>

Variation color displayed in the editor

creationMode

enum<string>

Creation mode of the variation: CODE_BASE, GRAPHICAL, AI or UNDEFINED

Available options:

AI,

CODE_BASE,

GRAPHICAL,

UNDEFINED,

WIDGET

cssCode

string

Code editor CSS code for variation

customJson

string

Custom JSON for this variation

experimentId

integer<int64>

read-only

ID of the experiment this variation belongs to

expositionFrequencyDelaySecondsBetweenTwoExpositions

integer<int64>

Delay in seconds between two exposures

expositionFrequencySameVisit

integer<int32>

Frequency of exposure during the same visit

expositionFrequencySameVisitor

integer<int32>

Frequency of the exposure for the same visitor

expositionFrequencySameVisitorDelaySeconds

integer<int64>

Delay in seconds between exposure for the same visitor

forceNoFlicker

boolean

integer<int64>

Unique ID of the variation

isJsCodeAfterDomReady

boolean

Set to true (which is also the default value) if the code applies once the DOM is ready.

jsCode

string

Code editor javascript code for variation

personalizationId

integer<int64>

read-only

ID of the personalization this variation belongs to

prompt

object

Object used to define an autorun message in the variation. Triggers the creation of a message of type autorun if valid

Show child attributes

redirection

object

Redirection parameters of a variation

Show child attributes

redirectionStrings

string

deprecated

Redirect URL used for redirecting variation. Deprecated property: use property 'redirection' instead

shadowDom

boolean

ShadowDOM option

Widget template input data in JSON format.

⌘I

Partially update a variation

curl --request PATCH \
  --url https://api.kameleoon.com/variations/{variationId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "cssCode": "<string>",
  "experimentId": 123,
  "isJsCodeAfterDomReady": true,
  "jsCode": "<string>",
  "name": "<string>",
  "shadowDom": true
}
'

import requests

url = "https://api.kameleoon.com/variations/{variationId}"

payload = {
    "cssCode": "<string>",
    "experimentId": 123,
    "isJsCodeAfterDomReady": True,
    "jsCode": "<string>",
    "name": "<string>",
    "shadowDom": True
}
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({
    cssCode: '<string>',
    experimentId: 123,
    isJsCodeAfterDomReady: true,
    jsCode: '<string>',
    name: '<string>',
    shadowDom: true
  })
};

fetch('https://api.kameleoon.com/variations/{variationId}', 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/variations/{variationId}",
  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([
    'cssCode' => '<string>',
    'experimentId' => 123,
    'isJsCodeAfterDomReady' => true,
    'jsCode' => '<string>',
    'name' => '<string>',
    'shadowDom' => true
  ]),
  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/variations/{variationId}"

	payload := strings.NewReader("{\n  \"cssCode\": \"<string>\",\n  \"experimentId\": 123,\n  \"isJsCodeAfterDomReady\": true,\n  \"jsCode\": \"<string>\",\n  \"name\": \"<string>\",\n  \"shadowDom\": true\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/variations/{variationId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"cssCode\": \"<string>\",\n  \"experimentId\": 123,\n  \"isJsCodeAfterDomReady\": true,\n  \"jsCode\": \"<string>\",\n  \"name\": \"<string>\",\n  \"shadowDom\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.kameleoon.com/variations/{variationId}")

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  \"cssCode\": \"<string>\",\n  \"experimentId\": 123,\n  \"isJsCodeAfterDomReady\": true,\n  \"jsCode\": \"<string>\",\n  \"name\": \"<string>\",\n  \"shadowDom\": true\n}"

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

{
  "name": "<string>",
  "siteId": 123,
  "color": 123,
  "creationMode": "AI",
  "cssCode": "<string>",
  "customJson": "<string>",
  "experimentId": 123,
  "expositionFrequencyDelaySecondsBetweenTwoExpositions": 123,
  "expositionFrequencySameVisit": 123,
  "expositionFrequencySameVisitor": 123,
  "expositionFrequencySameVisitorDelaySeconds": 123,
  "forceNoFlicker": true,
  "id": 123,
  "isJsCodeAfterDomReady": true,
  "jsCode": "<string>",
  "personalizationId": 123,
  "prompt": {
    "textInput": "<string>",
    "attachments": [
      {
        "mediaType": "IMAGE",
        "name": "US-39613 Image attachment",
        "type": "TEMPORARY"
      }
    ],
    "promptSource": "<string>"
  },
  "redirection": {
    "includeQueryParameters": true,
    "parameters": "param1=foo&param2=bar",
    "type": "GLOBAL_REDIRECTION",
    "url": "www.kameleoon.com"
  },
  "redirectionStrings": "<string>",
  "shadowDom": true,
  "widgetTemplateInput": "<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