Sign in

v4

latestOpenAPI 3.0.02026-08-04109113304.5 KB
Groups

Update an Exclusion Group

Update an exclusion group by ID.

patch/groups/{group_id}

Path parameters

group_idinteger required

The group ID of the Exclusion Group you want to change

Request body

archivedboolean

Whether the Exclusion Group has been archived

descriptionstring

The updated description of the Exclusion Group

namestring

The updated name of the Exclusion Group

Example request

{
  "description": "The Exclusion Group is updated!",
  "entities": [
    {
      "id": 1234,
      "kind": "Experiment",
      "weight": 5000
    }
  ],
  "name": "Updated Exclusion Group"
}

Response

Return the updated Exclusion Group

archivedboolean

Whether the group is archived

createdstring date-time

The time when the Exclusion Group was initially created

descriptionstring

The description for an Exclusion Group

idinteger

The unique identifier for the Exclusion Group

last_modifiedstring date-time

The last time the Exclusion Group was modified

namestring required

Name of the Exclusion Group

project_idinteger required

The Project the Exclusion Group is in

Example response

{
  "entities": [
    {
      "id": 1234,
      "kind": "Experiment",
      "weight": 5000
    }
  ],
  "id": 3000,
  "name": "Homepage Group",
  "project_id": 1000
}