Add Holdout Overrides

curl --request PATCH \
  --url https://statsigapi.net/console/v1/holdouts/{id}/overrides \
  --header 'Content-Type: application/json' \
  --header 'STATSIG-API-KEY: <api-key>' \
  --data '
{
  "environmentOverrides": [
    {
      "environment": "staging",
      "unitID": "unit123",
      "passingIDs": [
        "id1",
        "id2"
      ],
      "failingIDs": [
        "id3",
        "id4"
      ]
    }
  ]
}
'

import requests

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

payload = { "environmentOverrides": [
        {
            "environment": "staging",
            "unitID": "unit123",
            "passingIDs": ["id1", "id2"],
            "failingIDs": ["id3", "id4"]
        }
    ] }
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({
    environmentOverrides: [
      {
        environment: 'staging',
        unitID: 'unit123',
        passingIDs: ['id1', 'id2'],
        failingIDs: ['id3', 'id4']
      }
    ]
  })
};

fetch('https://statsigapi.net/console/v1/holdouts/{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/holdouts/{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([
    'environmentOverrides' => [
        [
                'environment' => 'staging',
                'unitID' => 'unit123',
                'passingIDs' => [
                                'id1',
                                'id2'
                ],
                'failingIDs' => [
                                'id3',
                                'id4'
                ]
        ]
    ]
  ]),
  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/holdouts/{id}/overrides"

	payload := strings.NewReader("{\n  \"environmentOverrides\": [\n    {\n      \"environment\": \"staging\",\n      \"unitID\": \"unit123\",\n      \"passingIDs\": [\n        \"id1\",\n        \"id2\"\n      ],\n      \"failingIDs\": [\n        \"id3\",\n        \"id4\"\n      ]\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/holdouts/{id}/overrides")
  .header("STATSIG-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"environmentOverrides\": [\n    {\n      \"environment\": \"staging\",\n      \"unitID\": \"unit123\",\n      \"passingIDs\": [\n        \"id1\",\n        \"id2\"\n      ],\n      \"failingIDs\": [\n        \"id3\",\n        \"id4\"\n      ]\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://statsigapi.net/console/v1/holdouts/{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  \"environmentOverrides\": [\n    {\n      \"environment\": \"staging\",\n      \"unitID\": \"unit123\",\n      \"passingIDs\": [\n        \"id1\",\n        \"id2\"\n      ],\n      \"failingIDs\": [\n        \"id3\",\n        \"id4\"\n      ]\n    }\n  ]\n}"

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

{
  "message": "Holdout Overrides updated successfully.",
  "data": {
    "passingUserIDs": [
      "passing-user"
    ],
    "failingUserIDs": [
      "failing-user"
    ],
    "passingCustomIDs": [
      "passing-custom-id"
    ],
    "failingCustomIDs": [
      "failing-custom-id"
    ]
  }
}

PATCH

console

holdouts

{id}

overrides

Add Holdout Overrides

curl --request PATCH \
  --url https://statsigapi.net/console/v1/holdouts/{id}/overrides \
  --header 'Content-Type: application/json' \
  --header 'STATSIG-API-KEY: <api-key>' \
  --data '
{
  "environmentOverrides": [
    {
      "environment": "staging",
      "unitID": "unit123",
      "passingIDs": [
        "id1",
        "id2"
      ],
      "failingIDs": [
        "id3",
        "id4"
      ]
    }
  ]
}
'

import requests

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

payload = { "environmentOverrides": [
        {
            "environment": "staging",
            "unitID": "unit123",
            "passingIDs": ["id1", "id2"],
            "failingIDs": ["id3", "id4"]
        }
    ] }
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({
    environmentOverrides: [
      {
        environment: 'staging',
        unitID: 'unit123',
        passingIDs: ['id1', 'id2'],
        failingIDs: ['id3', 'id4']
      }
    ]
  })
};

fetch('https://statsigapi.net/console/v1/holdouts/{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/holdouts/{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([
    'environmentOverrides' => [
        [
                'environment' => 'staging',
                'unitID' => 'unit123',
                'passingIDs' => [
                                'id1',
                                'id2'
                ],
                'failingIDs' => [
                                'id3',
                                'id4'
                ]
        ]
    ]
  ]),
  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/holdouts/{id}/overrides"

	payload := strings.NewReader("{\n  \"environmentOverrides\": [\n    {\n      \"environment\": \"staging\",\n      \"unitID\": \"unit123\",\n      \"passingIDs\": [\n        \"id1\",\n        \"id2\"\n      ],\n      \"failingIDs\": [\n        \"id3\",\n        \"id4\"\n      ]\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/holdouts/{id}/overrides")
  .header("STATSIG-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"environmentOverrides\": [\n    {\n      \"environment\": \"staging\",\n      \"unitID\": \"unit123\",\n      \"passingIDs\": [\n        \"id1\",\n        \"id2\"\n      ],\n      \"failingIDs\": [\n        \"id3\",\n        \"id4\"\n      ]\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://statsigapi.net/console/v1/holdouts/{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  \"environmentOverrides\": [\n    {\n      \"environment\": \"staging\",\n      \"unitID\": \"unit123\",\n      \"passingIDs\": [\n        \"id1\",\n        \"id2\"\n      ],\n      \"failingIDs\": [\n        \"id3\",\n        \"id4\"\n      ]\n    }\n  ]\n}"

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

{
  "message": "Holdout Overrides updated successfully.",
  "data": {
    "passingUserIDs": [
      "passing-user"
    ],
    "failingUserIDs": [
      "failing-user"
    ],
    "passingCustomIDs": [
      "passing-custom-id"
    ],
    "failingCustomIDs": [
      "failing-custom-id"
    ]
  }
}

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

Option 1
Option 2

Contract for updating overrides

environmentOverrides

object[]

required

Show child attributes

Response

200 - application/json

Add Holdout Overrides Success

message

string

required

A simple string explaining the result of the operation.

data

object

required

Contract for overrides

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

Add Holdout Overrides

Authorizations

Headers

Path Parameters

Body

Response