Groups
Update group
Update a group by ID. Requires a partner API token. Only name and
external_id can be changed; the plan limits (max_pageviews_per_month
and max_unique_visitors_per_month) are set at creation time and are
ignored here.
PUT
/
groups
/
{id}
Update group
curl --request PUT \
--url https://cookiechimp.com/api/v1/groups/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"group": {
"name": "Example Ltd",
"external_id": "ABC_123"
}
}
'import requests
url = "https://cookiechimp.com/api/v1/groups/{id}"
payload = { "group": {
"name": "Example Ltd",
"external_id": "ABC_123"
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({group: {name: 'Example Ltd', external_id: 'ABC_123'}})
};
fetch('https://cookiechimp.com/api/v1/groups/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://cookiechimp.com/api/v1/groups/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'group' => [
'name' => 'Example Ltd',
'external_id' => 'ABC_123'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://cookiechimp.com/api/v1/groups/{id}"
payload := strings.NewReader("{\n \"group\": {\n \"name\": \"Example Ltd\",\n \"external_id\": \"ABC_123\"\n }\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://cookiechimp.com/api/v1/groups/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"group\": {\n \"name\": \"Example Ltd\",\n \"external_id\": \"ABC_123\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://cookiechimp.com/api/v1/groups/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"group\": {\n \"name\": \"Example Ltd\",\n \"external_id\": \"ABC_123\"\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "abc123",
"partner": "partner_one",
"name": "Example Ltd",
"external_id": "ABC_123",
"max_pageviews_per_month": 500000,
"max_unique_visitors_per_month": 100000
}{
"errors": [
{
"code": 401,
"message": "API key must belong to a partner"
}
]
}{
"errors": [
{
"code": 404,
"message": "Record not found"
}
]
}{
"name": [
"can't be blank"
],
"external_id": [
"has already been taken"
]
}{
"errors": [
{
"code": 429,
"message": "Too many requests. Please retry later."
}
]
}Authorizations
API token obtained from the login endpoint or the dashboard
Path Parameters
ID of the resource
Body
application/json
Group to update
Show child attributes
Show child attributes
Response
Updated group
Unique identifier for the group
Name of the partner the group belongs to
Name of the group
External ID set by the partner
Maximum number of pageviews per month
Maximum number of unique visitors per month
Was this page helpful?
⌘I
Update group
curl --request PUT \
--url https://cookiechimp.com/api/v1/groups/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"group": {
"name": "Example Ltd",
"external_id": "ABC_123"
}
}
'import requests
url = "https://cookiechimp.com/api/v1/groups/{id}"
payload = { "group": {
"name": "Example Ltd",
"external_id": "ABC_123"
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({group: {name: 'Example Ltd', external_id: 'ABC_123'}})
};
fetch('https://cookiechimp.com/api/v1/groups/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://cookiechimp.com/api/v1/groups/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'group' => [
'name' => 'Example Ltd',
'external_id' => 'ABC_123'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://cookiechimp.com/api/v1/groups/{id}"
payload := strings.NewReader("{\n \"group\": {\n \"name\": \"Example Ltd\",\n \"external_id\": \"ABC_123\"\n }\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://cookiechimp.com/api/v1/groups/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"group\": {\n \"name\": \"Example Ltd\",\n \"external_id\": \"ABC_123\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://cookiechimp.com/api/v1/groups/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"group\": {\n \"name\": \"Example Ltd\",\n \"external_id\": \"ABC_123\"\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "abc123",
"partner": "partner_one",
"name": "Example Ltd",
"external_id": "ABC_123",
"max_pageviews_per_month": 500000,
"max_unique_visitors_per_month": 100000
}{
"errors": [
{
"code": 401,
"message": "API key must belong to a partner"
}
]
}{
"errors": [
{
"code": 404,
"message": "Record not found"
}
]
}{
"name": [
"can't be blank"
],
"external_id": [
"has already been taken"
]
}{
"errors": [
{
"code": 429,
"message": "Too many requests. Please retry later."
}
]
}