Update Experiment Overrides

POST /console/v1/experiments/{id}/overrides

Try it

Update Experiment Overrides

cURL

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

200

{
  "overrides": [
    {
      "type": "segment",
      "id": "a_segment",
      "groupID": "Control"
    },
    {
      "type": "gate",
      "id": "a_gate",
      "groupID": "Test"
    }
  ],
  "userIDOverrides": [
    {
      "groupID": "Control",
      "ids": [
        "updated_control_id_list"
      ]
    },
    {
      "groupID": "Test",
      "ids": [
        "updated_test_id_list"
      ]
    }
  ]
}

Authorizations

STATSIG-API-KEY · string · header · required

Headers

x-respect-review-settings · string

Optional header to respect review settings for mutation endpoints.

Path Parameters

id · string · required

id

Body

application/json

overrides · object[] · required

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

Maximum array length: 1000

Show child attributes

overrides. type · enum<string> · required

Available options: gate, segment

overrides. id · string · required

The id of the segment or gate

overrides. groupID · string · required

The experiment group which user will be forced into

userIDOverrides · object[] · required

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

Show child attributes

userIDOverrides. groupID · string · required

The experiment group the user will be forced into.

userIDOverrides. ids · string[] · required

Array of user IDs to be assigned to the specified experiment group.

Maximum array length: 1000

userIDOverrides. environment · string | null

Optional environment designation (e.g., production, staging) for the experiment.

userIDOverrides. unitType · string | null

Optional type of unit for the experiment, defining the scope of the override.

Response

200

application/json

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

data. overrides · object[] · required

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

Maximum array length: 1000

Show child attributes

data.overrides. type · enum<string> · required

Available options: gate, segment

data.overrides. id · string · required

The id of the segment or gate

data.overrides. groupID · string · required

The experiment group which user will be forced into

data. userIDOverrides · object[] · required

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

Show child attributes

data.userIDOverrides. groupID · string · required

The experiment group the user will be forced into.

data.userIDOverrides. ids · string[] · required

Array of user IDs to be assigned to the specified experiment group.

Maximum array length: 1000

data.userIDOverrides. environment · string | null

Optional environment designation (e.g., production, staging) for the experiment.

data.userIDOverrides. unitType · string | null

Optional type of unit for the experiment, defining the scope of the override.