Skip to main content

Update Exclusion Group

PATCH/v2/project/{project_key}/exclusion-groups/{group_id}

Change an exclusion group's membership, splits, name or description. The tests array REPLACES the whole membership — to add one experiment, send the existing tests plus the new one.

Path parameters

ParameterDescription
project_keyYour project's API key
group_idThe group's id from List Exclusion Groups

Body parameters

At least one field must be present.

FieldTypeDescription
namestringNew label
descriptionstringNew note
testsarrayThe complete new membership, replacing the old. Same rules as Create: at least two entries, percents all-or-none summing to 100
tests replaces the membership

Sending only the new experiment would silently drop every other experiment from the group. Call List Exclusion Groups first and send the full list.

Example

Add experiment 34601 to a group that currently holds 34567 and 34580:

curl -X PATCH "https://api-{region}.mida.so/v2/project/YOUR_PROJECT_KEY/exclusion-groups/42" \
-H "Authorization: Bearer YOUR_GENERATED_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"tests": [
{"test_id": 34567},
{"test_id": 34580},
{"test_id": 34601}
]
}'

Success response

{
"success": true,
"group_id": 42,
"group_name": "Pricing page tests",
"tests": [
{ "test_id": 34567, "percent": 33 },
{ "test_id": 34580, "percent": 33 },
{ "test_id": 34601, "percent": 34 }
]
}

Errors

StatusMeaning
400Invalid membership (see Create), or an empty body
404No exclusion group with that id in this project