Skip to main content
POST
Create Group

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

billingEntityCreated
boolean

Present only when billing_enabled was requested: whether the billing entity exists after provisioning. When false, entity creation failed even after a retry, and setting group credits fails with a 400 until billing is repaired via PATCH /api/v1/groups/{group_id} with billing_enabled: true.