Update Group
curl --request PATCH \
--url https://api.athenahq.ai/api/v1/groups/{group_id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "Renamed Group",
"add_website_ids": [
"123e4567-e89b-12d3-a456-426614174000"
],
"remove_website_ids": [
"987e6543-e21b-12d3-a456-426614174000"
],
"external_id": "acct_9e4c1b8d",
"billing_enabled": true
}
'import requests
url = "https://api.athenahq.ai/api/v1/groups/{group_id}"
payload = {
"name": "Renamed Group",
"add_website_ids": ["123e4567-e89b-12d3-a456-426614174000"],
"remove_website_ids": ["987e6543-e21b-12d3-a456-426614174000"],
"external_id": "acct_9e4c1b8d",
"billing_enabled": True
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Renamed Group',
add_website_ids: ['123e4567-e89b-12d3-a456-426614174000'],
remove_website_ids: ['987e6543-e21b-12d3-a456-426614174000'],
external_id: 'acct_9e4c1b8d',
billing_enabled: true
})
};
fetch('https://api.athenahq.ai/api/v1/groups/{group_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://api.athenahq.ai/api/v1/groups/{group_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Renamed Group',
'add_website_ids' => [
'123e4567-e89b-12d3-a456-426614174000'
],
'remove_website_ids' => [
'987e6543-e21b-12d3-a456-426614174000'
],
'external_id' => 'acct_9e4c1b8d',
'billing_enabled' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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://api.athenahq.ai/api/v1/groups/{group_id}"
payload := strings.NewReader("{\n \"name\": \"Renamed Group\",\n \"add_website_ids\": [\n \"123e4567-e89b-12d3-a456-426614174000\"\n ],\n \"remove_website_ids\": [\n \"987e6543-e21b-12d3-a456-426614174000\"\n ],\n \"external_id\": \"acct_9e4c1b8d\",\n \"billing_enabled\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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.patch("https://api.athenahq.ai/api/v1/groups/{group_id}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Renamed Group\",\n \"add_website_ids\": [\n \"123e4567-e89b-12d3-a456-426614174000\"\n ],\n \"remove_website_ids\": [\n \"987e6543-e21b-12d3-a456-426614174000\"\n ],\n \"external_id\": \"acct_9e4c1b8d\",\n \"billing_enabled\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.athenahq.ai/api/v1/groups/{group_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Renamed Group\",\n \"add_website_ids\": [\n \"123e4567-e89b-12d3-a456-426614174000\"\n ],\n \"remove_website_ids\": [\n \"987e6543-e21b-12d3-a456-426614174000\"\n ],\n \"external_id\": \"acct_9e4c1b8d\",\n \"billing_enabled\": true\n}"
response = http.request(request)
puts response.read_body{
"group": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "Enterprise Clients",
"orgId": "987e6543-e21b-12d3-a456-426614174000",
"billingEnabled": false,
"createdAt": "2024-06-15T10:30:00.000Z",
"websites": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"websiteUrl": "example.com",
"websiteName": "My Awesome Blog",
"externalId": "ws_a7f3b2c9"
}
],
"externalId": "acct_9e4c1b8d"
}
}Groups
Update Group
Updates a group’s name, adds websites, removes websites, and/or (partners only) sets or clears the external_id mapping. At least one field must be provided. Requires a global API key. Partner integrations may pass external_id as a non-empty string to set/replace the mapping, or as null to clear it. The partner response includes externalId on the group and on every website object inside websites (null when no mapping exists).
PATCH
/
api
/
v1
/
groups
/
{group_id}
Update Group
curl --request PATCH \
--url https://api.athenahq.ai/api/v1/groups/{group_id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "Renamed Group",
"add_website_ids": [
"123e4567-e89b-12d3-a456-426614174000"
],
"remove_website_ids": [
"987e6543-e21b-12d3-a456-426614174000"
],
"external_id": "acct_9e4c1b8d",
"billing_enabled": true
}
'import requests
url = "https://api.athenahq.ai/api/v1/groups/{group_id}"
payload = {
"name": "Renamed Group",
"add_website_ids": ["123e4567-e89b-12d3-a456-426614174000"],
"remove_website_ids": ["987e6543-e21b-12d3-a456-426614174000"],
"external_id": "acct_9e4c1b8d",
"billing_enabled": True
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Renamed Group',
add_website_ids: ['123e4567-e89b-12d3-a456-426614174000'],
remove_website_ids: ['987e6543-e21b-12d3-a456-426614174000'],
external_id: 'acct_9e4c1b8d',
billing_enabled: true
})
};
fetch('https://api.athenahq.ai/api/v1/groups/{group_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://api.athenahq.ai/api/v1/groups/{group_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Renamed Group',
'add_website_ids' => [
'123e4567-e89b-12d3-a456-426614174000'
],
'remove_website_ids' => [
'987e6543-e21b-12d3-a456-426614174000'
],
'external_id' => 'acct_9e4c1b8d',
'billing_enabled' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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://api.athenahq.ai/api/v1/groups/{group_id}"
payload := strings.NewReader("{\n \"name\": \"Renamed Group\",\n \"add_website_ids\": [\n \"123e4567-e89b-12d3-a456-426614174000\"\n ],\n \"remove_website_ids\": [\n \"987e6543-e21b-12d3-a456-426614174000\"\n ],\n \"external_id\": \"acct_9e4c1b8d\",\n \"billing_enabled\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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.patch("https://api.athenahq.ai/api/v1/groups/{group_id}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Renamed Group\",\n \"add_website_ids\": [\n \"123e4567-e89b-12d3-a456-426614174000\"\n ],\n \"remove_website_ids\": [\n \"987e6543-e21b-12d3-a456-426614174000\"\n ],\n \"external_id\": \"acct_9e4c1b8d\",\n \"billing_enabled\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.athenahq.ai/api/v1/groups/{group_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Renamed Group\",\n \"add_website_ids\": [\n \"123e4567-e89b-12d3-a456-426614174000\"\n ],\n \"remove_website_ids\": [\n \"987e6543-e21b-12d3-a456-426614174000\"\n ],\n \"external_id\": \"acct_9e4c1b8d\",\n \"billing_enabled\": true\n}"
response = http.request(request)
puts response.read_body{
"group": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "Enterprise Clients",
"orgId": "987e6543-e21b-12d3-a456-426614174000",
"billingEnabled": false,
"createdAt": "2024-06-15T10:30:00.000Z",
"websites": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"websiteUrl": "example.com",
"websiteName": "My Awesome Blog",
"externalId": "ws_a7f3b2c9"
}
],
"externalId": "acct_9e4c1b8d"
}
}Path Parameters
The unique identifier of the group
Body
application/json
Request body for updating a group. At least one field must be provided.
New name for the group.
Minimum string length:
1Example:
"Renamed Group"
Website IDs to add to the group. Must belong to your organization. Websites already in the group are silently ignored.
Minimum array length:
1Example:
["123e4567-e89b-12d3-a456-426614174000"]
Website IDs to remove from the group. IDs not currently in the group are silently ignored.
Minimum array length:
1Example:
["987e6543-e21b-12d3-a456-426614174000"]
Partner-only. Partner-supplied identifier to attach to this group. Pass a non-empty string to set or replace the mapping, or null to clear an existing mapping. Accepted only when authenticating with an API key for an organization flagged as a partner. Sending this field as a direct customer returns 403 Forbidden. Must be unique per resource type within your organization — setting a value already used by another group returns 409 with the existing resource in the payload.
Minimum string length:
1Example:
"acct_9e4c1b8d"
Set to true to enable billing for this group. This provisions a billing entity in the upstream billing provider, which is a prerequisite for setting credits on the group (a partner-only operation). Idempotent — safe to call on groups whose entity was never created or whose initial provisioning failed silently. Set to false to disable the flag without destroying existing billing state; credit balances and usage history are preserved. Returns 502 if the upstream billing provider fails to provision the entity — in that case the database is not modified, so the request can be retried cleanly.
Example:
true
Response
Group updated successfully. Partner responses include an externalId field (string or null); direct-customer responses omit the field entirely.
A group of websites in your organization
Show child attributes
Show child attributes
Was this page helpful?