Identify

Identify a user

POSTtracking/identify

To create/update profiles in People CRM and track individual users, you will need to call the identify method and provide a person_id. The person_id is a unique identifier, we recommend using the person's email address. You can alternatively use an id as the person_id but this can lead to duplicate profiles being created with the same email address. You can also track additional information as properties.

Track via email address (recommended)

To use an email address as the person_id you must use the prefix email: like this:

person_id: "email:user@example.com"

Track via ID

To use an id as the person_id there is no need to prefix the id, like this:

person_id: 123456

Note: Tracking users by their ID and email separately will create two different profiles. GoSquared will merge these two profiles together when you next identify a user with both ID and email in the properties of the same identify call.

Identify is very similar to properties, but it requires there to be an identifying property (id or email).

How many different custom properties can I track?

Take some time to think about the name you give to your properties. You can name them anything you like, but it's best to use a clear, concise name.

Each GoSquared project can track up to 1000 custom properties. Above this limit, properties with new names will be ignored in that project.

POST Body

person_id

StringRequired

The People person ID that this action is associated with.

If the identifier used is an email it should be prefixed with email: like this: email:jon@example.com

visitor_id

String

The anonymous visitor ID that this action is associated with.

properties

Object

email

String

name

String or null

first_name

String or null

last_name

String or null

username

String or null

avatar

String or null

URL of an avatar image for this person. Defaults to the Gravatar for the email

description

String or null

Bio of this person. Will be filled in automatically from social data if available

phone

String or null

created_at

String

A valid ISO 8601 timestamp of when this user was created. When the user is being identified for the first time, this defaults to the current timestamp

company

Object

name

String or null

size

Number

industry

String or null

position

String or null

custom

Object

Any custom properties associated with this person

Run in PostmanPostman is a useful developer tool for experimenting with and managing APIs that you work with

Definition

POST https://api.gosquared.com/tracking/v1/identify

Example Request

curl -X POST -H "Content-Type: application/json" \
  "https://api.gosquared.com/tracking/v1/identify?api_key=demo&site_token=GSN-106863-S" 

Live Responseundefined undefined

Your API Key is not authorised for this endpoint