Skip to main content
POST
/
api
/
v1
/
groups
Create Group
curl --request POST \
  --url https://api.athenahq.ai/api/v1/groups \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "Enterprise Clients",
  "website_ids": [
    "123e4567-e89b-12d3-a456-426614174000",
    "987e6543-e21b-12d3-a456-426614174000"
  ],
  "billing_enabled": false,
  "external_id": "acct_9e4c1b8d"
}
'
{
  "group": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "Enterprise Clients",
    "orgId": "987e6543-e21b-12d3-a456-426614174000",
    "billingEnabled": false,
    "websiteIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "createdAt": "2024-06-15T10:30:00.000Z",
    "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.

Body

application/json

Request body for creating a new group

​
name
string
required

Name of the group.

Minimum string length: 1
Example:

"Enterprise Clients"

​
website_ids
string<uuid>[]
required

List of website IDs to include in the group. All websites must belong to your organization.

Minimum array length: 1
Example:
[
  "123e4567-e89b-12d3-a456-426614174000",
  "987e6543-e21b-12d3-a456-426614174000"
]
​
billing_enabled
boolean
default:false

Whether to enable billing for this group

Example:

false

​
external_id
string

Partner-only. An identifier from your own system to map to this Athena group. 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 — duplicates return 409 with the existing resource in the payload.

Minimum string length: 1
Example:

"acct_9e4c1b8d"

Response

Group created successfully

​
group
object
required

A newly created group resource