Skip to main content
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
}
'
{
  "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": "acct_9e4c1b8d"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.athenahq.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

API key for authentication. You can create one here.

Path Parameters

​
group_id
string<uuid>
required

The unique identifier of the group

Body

application/json

Request body for updating a group. At least one field must be provided.

​
name
string

New name for the group.

Minimum string length: 1
Example:

"Renamed Group"

​
add_website_ids
string<uuid>[]

Website IDs to add to the group. Must belong to your organization. Websites already in the group are silently ignored.

Minimum array length: 1
Example:
["123e4567-e89b-12d3-a456-426614174000"]
​
remove_website_ids
string<uuid>[]

Website IDs to remove from the group. IDs not currently in the group are silently ignored.

Minimum array length: 1
Example:
["987e6543-e21b-12d3-a456-426614174000"]
​
external_id
string | null

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: 1
Example:

"acct_9e4c1b8d"

​
billing_enabled
boolean

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.

​
group
object
required

A group of websites in your organization