PATCH /groups/{group_id}
Update an exclusion group by ID.
Servers
- https://api.optimizely.com/v2
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
group_id |
Integer | Yes |
The group ID of the Exclusion Group you want to change |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
entities[] |
Array | No |
Array of experiments or campaigns in the Exclusion Group, represented as a GroupEntity object |
entities[].id |
Integer | Yes |
The unique identifier for the Group Entity |
entities[].kind |
String | Yes |
The kind of the Group Entity Valid values:
|
entities[].weight |
Integer | Yes |
The weight of the Group Entity. The weight is a value between 0 and 10000. An entity with weight 5000 will receive 50% of this group's traffic |
name |
String | No |
The updated name of the Exclusion Group |
archived |
Boolean | No |
Whether the Exclusion Group has been archived Default value: false |
description |
String | No |
The updated description of the Exclusion Group |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.