Identify a contact

Changed on
post/contacts/identify

Request

  • Base URL
    https://insights.reforge.com/api/v1
  • Auth
    HTTP bearer

Request body

idstring required

External contact ID

shouldUnflattenPropertiesboolean nullable

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

sourcestring nullable

Source system to limit search to

Example request

{
  "properties": {
    "$contractValue": 100000
  },
  "account": {
    "id": "account-789",
    "properties": {
      "$name": "Acme, Inc.",
      "$domain": "acme.com",
      "$contractValue": 100000
    }
  }
}

Response

The customer was identified successfully

successboolean

Changes