Update an experiment.

Partially update an experiment by ID. Only provided fields are updated. Providing allocations replaces the entire allocations set.

PATCH https://{tenantDomain}/api/v2/experimentation/experiments/{id}

Update an experiment.

cURL

curl --request PATCH \
  --url https://{tenantDomain}/api/v2/experimentation/experiments/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "allocations": [
    {
      "variation_id": "<string>",
      "is_control": true,
      "weight": 50,
      "segment_id": "<string>",
      "priority": 2,
      "is_fallback": true
    }
  ]
}
'

import requests

url = "https://{tenantDomain}/api/v2/experimentation/experiments/{id}"

payload = {
    "name": "<string>",
    "description": "<string>",
    "allocations": [
        {
            "variation_id": "<string>",
            "is_control": True,
            "weight": 50,
            "segment_id": "<string>",
            "priority": 2,
            "is_fallback": 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({
    name: '<string>',
    description: '<string>',
    allocations: [
      {
        variation_id: '<string>',
        is_control: true,
        weight: 50,
        segment_id: '<string>',
        priority: 2,
        is_fallback: true
      }
    ]
  })
};

fetch('https://{tenantDomain}/api/v2/experimentation/experiments/{id}', 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://{tenantDomain}/api/v2/experimentation/experiments/{id}",
  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([
    'name' => '<string>',
    'description' => '<string>',
    'allocations' => [
        [
                'variation_id' => '<string>',
                'is_control' => true,
                'weight' => 50,
                'segment_id' => '<string>',
                'priority' => 2,
                'is_fallback' => 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://{tenantDomain}/api/v2/experimentation/experiments/{id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"allocations\": [\n    {\n      \"variation_id\": \"<string>\",\n      \"is_control\": true,\n      \"weight\": 50,\n      \"segment_id\": \"<string>\",\n      \"priority\": 2,\n      \"is_fallback\": true\n    }\n  ]\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://{tenantDomain}/api/v2/experimentation/experiments/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"allocations\": [\n    {\n      \"variation_id\": \"<string>\",\n      \"is_control\": true,\n      \"weight\": 50,\n      \"segment_id\": \"<string>\",\n      \"priority\": 2,\n      \"is_fallback\": true\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}/api/v2/experimentation/experiments/{id}")

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  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"allocations\": [\n    {\n      \"variation_id\": \"<string>\",\n      \"is_control\": true,\n      \"weight\": 50,\n      \"segment_id\": \"<string>\",\n      \"priority\": 2,\n      \"is_fallback\": true\n    }\n  ]\n}"

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

200

{
  "id": "<string>",
  "name": "<string>",
  "feature_flag_id": "<string>",
  "authentication_flow": "<string>",
  "assignment_config": {
    "subject": "device"
  },
  "is_valid": true,
  "allocations": [
    {
      "variation_id": "<string>",
      "segment_id": "<string>",
      "weight": 123,
      "priority": 123,
      "is_control": true,
      "is_fallback": true
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "started_at": "2023-11-07T05:31:56Z",
  "ended_at": "2023-11-07T05:31:56Z"
}

Autorisations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · requis

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

Paramètres de chemin

id · string · requis

The ID of the experiment to update.

Corps

application/jsonapplication/x-www-form-urlencoded

Partial update of an experiment. Only provided fields are updated. Providing allocations replaces the entire allocations set.

name · string

A human-readable name for the experiment

Required string length: 3 - 255

Pattern: ^(?!.*\x00)\S(.*\S)?$

description · string | null

A description of the experiment

Required string length: 3 - 1024

Pattern: ^(?!.*\x00)\S(.*\S)?$

assignment_config · object

Configuration for how users are assigned to variations

Show child attributes

allocations · object[]

Replaces all traffic allocations. Cannot be modified while the experiment is active.

Minimum array length: 1

Show child attributes

Réponse

200

application/json

Experiment successfully updated.

id · string · requis

Pattern: ^exp_[A-HJ-NP-Za-km-z1-9]+$

name · string · requis

feature_flag_id · string · requis

authentication_flow · string · requis

allocation_strategy · enum<string> · requis

Options disponibles: percentage, segment

assignment_config · object · requis

Show child attributes

status · enum<string> · requis

Filter by status. Exact match.

Options disponibles: draft, active, paused, completed, archived

is_valid · boolean · requis

allocations · object[] · requis

Show child attributes

created_at · string<date-time> · requis

updated_at · string<date-time> · requis

description · string

started_at · string<date-time>

ended_at · string<date-time>