Skip to main content
POST
/
contacts
/
identify
Identify a contact
curl --request POST \
  --url https://insights.reforge.com/api/v1/contacts/identify \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "<string>",
  "shouldUnflattenProperties": true,
  "properties": {
    "$email": "<string>",
    "$name": "<string>",
    "$createdAt": "2023-11-07T05:31:56Z",
    "$updatedAt": "2023-11-07T05:31:56Z",
    "$contractValue": 100000
  },
  "account": {
    "id": "account-789",
    "shouldUnflattenProperties": true,
    "properties": {
      "$name": "Acme, Inc.",
      "$domain": "acme.com",
      "$createdAt": "2023-11-07T05:31:56Z",
      "$updatedAt": "2023-11-07T05:31:56Z",
      "$contractValue": 100000
    }
  },
  "source": "<string>"
}
'
{
  "success": true
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer , where is your auth token.

Body

application/json
​
id
string
required

External contact ID

​
shouldUnflattenProperties
boolean | null

Whether to unflatten properties that are meant to be nested objects for example { "plan.type": "Pro" } will be unflattened to { "plan": { "type": "Pro" } }

​
properties
object

Properties prefixed with $ are handled specially. Otherwise, additional key-value pairs will be metadata once ingested into the system

​
account
object
​
source
string | null

Source system to limit search to

Response

201 - application/json

The customer was identified successfully

​
success
boolean