Identify (v1)

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

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

Request Body

application/json

User identification payload

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

user_id*string

A unique identifier for the user. Use the same ID as in external platforms (e.g., HubSpot, Intercom).

group_id?string

Optional. The external identifier for the account this user belongs to. Helps associate users with organizations.

traits?object

Optional. Key-value pairs describing user attributes, such as:

email: The user’s email address.
name: The user’s full name.
created_at: When the user first signed up (ISO 8601 format).
role: The user's role in the account (e.g., "admin", "member").

Response Body

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

Empty

Identify (v1)

Request Body

Response Body

202

413

503