Group
Associate a user with an account and set account traits.
The group call associates a user with an account in Accoil and sets account-level traits such as company name, plan, and industry.
Looking for the legacy v1 endpoint? See POST /v1/groups.
Authorization
V2BasicApiKey Authorization<token>
Use format "Basic API_KEY" where API_KEY is your unique Accoil API key. Found under Account > General settings.
In: header
Request Body
application/json
Group identify
timestamp?string
ISO 8601 Formatted date string. Will default to UTC now if not supplied.
Format
date-timegroupId*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.
userId?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/v2/group" \ -H "Content-Type: application/json" \ -d '{ "groupId": "account_22" }'Empty
Empty
Empty