Group (v1)

This is the legacy v1 endpoint. We recommend using POST /v2/group for new integrations.

The v1 group endpoint requires the API key in the request body as api_key rather than in the Authorization header.

Request Body

application/json

Group identify

TypeScript Definitions

Use the request body type in TypeScript.

api_key*string

Your unique Accoil API key. Found under Account > General settings.

timestamp*integer

Unix timestamp in milliseconds. Example: 1500000000000

Formatint64

group_id*string

A unique identifier for the group or account.

Use the same ID as in tools like HubSpot or Intercom for seamless integration.
This allows Accoil-generated metrics to be pushed into these external platforms.

user_id?string

Optional. The identifier of the user being associated with the group.

traits?object

Optional. Key-value pairs describing the group, such as:

name: The name of the group (e.g., "Acme Corp").
created_at: The group's creation date in ISO 8601 format.
status: The group's subscription status (e.g., "trial", "paid").
mrr: Monthly recurring revenue in cents (e.g., 100000 for $1,000).

Response Body

curl -X POST "https://in.accoil.com/v1/groups" \  -H "Content-Type: application/json" \  -d '{    "api_key": "f6ed0379283b149a2fd87a069d2b0d623c601272",    "timestamp": 1500000000000,    "group_id": "account_22"  }'

Empty

Group (v1)

Request Body

Response Body

202

413

503