Update an Exclusion Group

1 min

PATCH

https://api.optimizely.com/v2/groups/{group_id}

Update an exclusion group by ID.

Path Parameters

group_idinteger<int64>required
Description
The group ID of the Exclusion Group you want to change
Format
int64

Body Parameters

bodyGroupUpdaterequired
Description
A string in JSON format that includes all the fields you'd like to change for an Exclusion Group
- archivedboolean
  Description
  Whether the Exclusion Group has been archived
  Default
  false
- descriptionstring
  Example
  The Exclusion Group is updated!
  Description
  The updated description of the Exclusion Group
- entitiesGroupEntity[]
  Description
  Array of experiments or campaigns in the Exclusion Group, represented as a GroupEntity object
  - idintegerrequired
    Example
    3000
    Description
    The unique identifier for the Group Entity
  - kindstring<Campaign | Experiment>required
    Description
    The kind of the Group Entity
    Allowed
    CampaignExperiment
  - weightintegerrequired
    Example
    1000
    Description
    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
- namestring
  Example
  Updated Exclusion Group
  Description
  The updated name of the Exclusion Group

Responses

200Return the updated Exclusion Group

Group
- archivedboolean
  Description
  Whether the group is archived
- createdstring<date-time>
  Description
  The time when the Exclusion Group was initially created
  Format
  date-time
- descriptionstring
  Description
  The description for an Exclusion Group
- entitiesGroupEntity[]
  Description
  Array of Group Entities in the Exclusion Group
  - idintegerrequired
    Example
    3000
    Description
    The unique identifier for the Group Entity
  - kindstring<Campaign | Experiment>required
    Description
    The kind of the Group Entity
    Allowed
    CampaignExperiment
  - weightintegerrequired
    Example
    1000
    Description
    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
- idinteger<int64>
  Example
  3000
  Description
  The unique identifier for the Exclusion Group
  Format
  int64
- last_modifiedstring<date-time>
  Description
  The last time the Exclusion Group was modified
  Format
  date-time
- namestringrequired
  Example
  Homepage Group
  Description
  Name of the Exclusion Group
- project_idinteger<int64>required
  Example
  1000
  Description
  The Project the Exclusion Group is in
  Format
  int64

400Invalid ID or request body supplied

Error
- codestring
- messagestring
- messagesobject
- uuidstring<uuid>
  Format
  uuid

401Invalid credentials

Error
- codestring
- messagestring
- messagesobject
- uuidstring<uuid>
  Format
  uuid

403You do not have permission to edit the specified Exclusion Group

Error
- codestring
- messagestring
- messagesobject
- uuidstring<uuid>
  Format
  uuid

404Experimentation Group not found

Error
- codestring
- messagestring
- messagesobject
- uuidstring<uuid>
  Format
  uuid

defaultUnexpected error

Error
- codestring
- messagestring
- messagesobject
- uuidstring<uuid>
  Format
  uuid

curl

curl --request PATCH \
     --url https://api.optimizely.com/v2/groups/{group_id} \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "entities": [
     {
     "id": 3000,
     "kind": "",
     "weight": 1000
     }
     ]
     }'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var raw = JSON.stringify({
   "entities": [
      {
         "id": 3000,
         "kind": "",
         "weight": 1000
      }
   ]
});

var requestOptions = {
   method: 'PATCH',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("https://api.optimizely.com/v2/groups/{group_id}", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.optimizely.com/v2/groups/{group_id}")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request.body = JSON.dump({
   "entities": [
      {
         "id": 3000,
         "kind": "",
         "weight": 1000
      }
   ]
})

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

python

import requests
import json

url = "https://api.optimizely.com/v2/groups/{group_id}"

payload = json.dumps({
   "entities": [
      {
         "id": 3000,
         "kind": "",
         "weight": 1000
      }
   ]
})
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("PATCH", url, headers=headers, data=payload)

print(response.text)

200

// Return the updated Exclusion Group
{
  "archived": false,
  "created": "",
  "description": "",
  "entities": [
    {
      "id": 3000,
      "kind": "",
      "weight": 1000
    }
  ],
  "id": 3000,
  "last_modified": "",
  "name": "Homepage Group",
  "project_id": 1000
}

400

// Invalid ID or request body supplied
{
  "code": "",
  "message": "",
  "messages": {},
  "uuid": ""
}

401

// Invalid credentials
{
  "code": "",
  "message": "",
  "messages": {},
  "uuid": ""
}

403

// You do not have permission to edit the specified Exclusion Group
{
  "code": "",
  "message": "",
  "messages": {},
  "uuid": ""
}

404

// Experimentation Group not found
{
  "code": "",
  "message": "",
  "messages": {},
  "uuid": ""
}

default

// Unexpected error
{
  "code": "",
  "message": "",
  "messages": {},
  "uuid": ""
}