Identify

The identify call creates or updates a user in Accoil and sets traits such as email, name, and creation date.

Looking for the legacy v1 endpoint? See POST /v1/users.

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

application/json

User identification payload

TypeScript Definitions

Use the request body type in TypeScript.

timestamp?string

ISO 8601 Formatted date string. Will default to UTC now if not supplied.

Formatdate-time

userId*string

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

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

curl -X POST "https://in.accoil.com/v2/identify" \  -H "Content-Type: application/json" \  -d '{    "userId": "user_12345"  }'

Empty