Partially Update Experiment Overrides

curl --request PATCH \
  --url https://statsigapi.net/console/v1/experiments/{id}/overrides \
  --header 'Content-Type: application/json' \
  --header 'STATSIG-API-KEY: <api-key>' \
  --data '
{
  "overrides": [
    {
      "id": "<string>",
      "groupID": "<string>"
    }
  ],
  "userIDOverrides": [
    {
      "groupID": "<string>",
      "ids": [
        "<string>"
      ],
      "environment": "<string>",
      "unitType": "<string>"
    }
  ]
}
'

import requests

url = "https://statsigapi.net/console/v1/experiments/{id}/overrides"

payload = {
    "overrides": [
        {
            "id": "<string>",
            "groupID": "<string>"
        }
    ],
    "userIDOverrides": [
        {
            "groupID": "<string>",
            "ids": ["<string>"],
            "environment": "<string>",
            "unitType": "<string>"
        }
    ]
}
headers = {
    "STATSIG-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'STATSIG-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    overrides: [{id: '<string>', groupID: '<string>'}],
    userIDOverrides: [
      {
        groupID: '<string>',
        ids: ['<string>'],
        environment: '<string>',
        unitType: '<string>'
      }
    ]
  })
};

fetch('https://statsigapi.net/console/v1/experiments/{id}/overrides', 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://statsigapi.net/console/v1/experiments/{id}/overrides",
  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([
    'overrides' => [
        [
                'id' => '<string>',
                'groupID' => '<string>'
        ]
    ],
    'userIDOverrides' => [
        [
                'groupID' => '<string>',
                'ids' => [
                                '<string>'
                ],
                'environment' => '<string>',
                'unitType' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "STATSIG-API-KEY: <api-key>"
  ],
]);

$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://statsigapi.net/console/v1/experiments/{id}/overrides"

	payload := strings.NewReader("{\n  \"overrides\": [\n    {\n      \"id\": \"<string>\",\n      \"groupID\": \"<string>\"\n    }\n  ],\n  \"userIDOverrides\": [\n    {\n      \"groupID\": \"<string>\",\n      \"ids\": [\n        \"<string>\"\n      ],\n      \"environment\": \"<string>\",\n      \"unitType\": \"<string>\"\n    }\n  ]\n}")

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

	req.Header.Add("STATSIG-API-KEY", "<api-key>")
	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://statsigapi.net/console/v1/experiments/{id}/overrides")
  .header("STATSIG-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"overrides\": [\n    {\n      \"id\": \"<string>\",\n      \"groupID\": \"<string>\"\n    }\n  ],\n  \"userIDOverrides\": [\n    {\n      \"groupID\": \"<string>\",\n      \"ids\": [\n        \"<string>\"\n      ],\n      \"environment\": \"<string>\",\n      \"unitType\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://statsigapi.net/console/v1/experiments/{id}/overrides")

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

request = Net::HTTP::Patch.new(url)
request["STATSIG-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"overrides\": [\n    {\n      \"id\": \"<string>\",\n      \"groupID\": \"<string>\"\n    }\n  ],\n  \"userIDOverrides\": [\n    {\n      \"groupID\": \"<string>\",\n      \"ids\": [\n        \"<string>\"\n      ],\n      \"environment\": \"<string>\",\n      \"unitType\": \"<string>\"\n    }\n  ]\n}"

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

{
  "overrides": [
    {
      "type": "gate",
      "id": "a_gate",
      "groupID": "Test"
    }
  ],
  "userIDOverrides": [
    {
      "groupID": "Control",
      "ids": [
        "newly_added_id"
      ]
    }
  ]
}

{
  "status": 401,
  "message": "This endpoint only accepts an active CONSOLE key, but an invalid key was sent. Key: console-xxxXXXxxxXXXxxx"
}

{
  "status": 404,
  "message": "Not Found. The requested resource could not be found."
}

PATCH

console

experiments

{id}

overrides

Partially Update Experiment Overrides

curl --request PATCH \
  --url https://statsigapi.net/console/v1/experiments/{id}/overrides \
  --header 'Content-Type: application/json' \
  --header 'STATSIG-API-KEY: <api-key>' \
  --data '
{
  "overrides": [
    {
      "id": "<string>",
      "groupID": "<string>"
    }
  ],
  "userIDOverrides": [
    {
      "groupID": "<string>",
      "ids": [
        "<string>"
      ],
      "environment": "<string>",
      "unitType": "<string>"
    }
  ]
}
'

import requests

url = "https://statsigapi.net/console/v1/experiments/{id}/overrides"

payload = {
    "overrides": [
        {
            "id": "<string>",
            "groupID": "<string>"
        }
    ],
    "userIDOverrides": [
        {
            "groupID": "<string>",
            "ids": ["<string>"],
            "environment": "<string>",
            "unitType": "<string>"
        }
    ]
}
headers = {
    "STATSIG-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'STATSIG-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    overrides: [{id: '<string>', groupID: '<string>'}],
    userIDOverrides: [
      {
        groupID: '<string>',
        ids: ['<string>'],
        environment: '<string>',
        unitType: '<string>'
      }
    ]
  })
};

fetch('https://statsigapi.net/console/v1/experiments/{id}/overrides', 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://statsigapi.net/console/v1/experiments/{id}/overrides",
  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([
    'overrides' => [
        [
                'id' => '<string>',
                'groupID' => '<string>'
        ]
    ],
    'userIDOverrides' => [
        [
                'groupID' => '<string>',
                'ids' => [
                                '<string>'
                ],
                'environment' => '<string>',
                'unitType' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "STATSIG-API-KEY: <api-key>"
  ],
]);

$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://statsigapi.net/console/v1/experiments/{id}/overrides"

	payload := strings.NewReader("{\n  \"overrides\": [\n    {\n      \"id\": \"<string>\",\n      \"groupID\": \"<string>\"\n    }\n  ],\n  \"userIDOverrides\": [\n    {\n      \"groupID\": \"<string>\",\n      \"ids\": [\n        \"<string>\"\n      ],\n      \"environment\": \"<string>\",\n      \"unitType\": \"<string>\"\n    }\n  ]\n}")

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

	req.Header.Add("STATSIG-API-KEY", "<api-key>")
	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://statsigapi.net/console/v1/experiments/{id}/overrides")
  .header("STATSIG-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"overrides\": [\n    {\n      \"id\": \"<string>\",\n      \"groupID\": \"<string>\"\n    }\n  ],\n  \"userIDOverrides\": [\n    {\n      \"groupID\": \"<string>\",\n      \"ids\": [\n        \"<string>\"\n      ],\n      \"environment\": \"<string>\",\n      \"unitType\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://statsigapi.net/console/v1/experiments/{id}/overrides")

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

request = Net::HTTP::Patch.new(url)
request["STATSIG-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"overrides\": [\n    {\n      \"id\": \"<string>\",\n      \"groupID\": \"<string>\"\n    }\n  ],\n  \"userIDOverrides\": [\n    {\n      \"groupID\": \"<string>\",\n      \"ids\": [\n        \"<string>\"\n      ],\n      \"environment\": \"<string>\",\n      \"unitType\": \"<string>\"\n    }\n  ]\n}"

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

{
  "overrides": [
    {
      "type": "gate",
      "id": "a_gate",
      "groupID": "Test"
    }
  ],
  "userIDOverrides": [
    {
      "groupID": "Control",
      "ids": [
        "newly_added_id"
      ]
    }
  ]
}

{
  "status": 401,
  "message": "This endpoint only accepts an active CONSOLE key, but an invalid key was sent. Key: console-xxxXXXxxxXXXxxx"
}

{
  "status": 404,
  "message": "Not Found. The requested resource could not be found."
}

Authorizations

STATSIG-API-KEY

string

header

required

Headers

x-respect-review-settings

string

Optional header to respect review settings for mutation endpoints.

Path Parameters

string

required

Body

application/json

overrides

object[]

required

Array of experiment overrides, each specifying type, ID, and group ID.

Maximum array length: 1000

Show child attributes

userIDOverrides

object[]

required

Array of user ID overrides, specifying which users to force into experiment groups.

Show child attributes

Response

Partially Update Experiment Overrides Success

message

string

required

A simple string explaining the result of the operation.

data

object

required

A single result.

Show child attributes

⌘I

HTTP API

Console API

Alerts

Audit Logs

Autotunes

Company

Dynamic Configs

Events

Experiments

Experiments (Warehouse Native)

Configs

Gates

Holdouts

Ingestions

Keys

Layers

Metrics

Metrics (Warehouse Native)

Project

Usage

Reports

Segments

Tags

Target App

Users

Partially Update Experiment Overrides

Authorizations

Headers

Path Parameters

Body

Response