Identify contact

/identifyPOST

Creates or enriches the identified workspace contact. Ambiguous or contradictory identifiers are rejected. Custom fields are bounded to 100 keys and 64 KB. Required scope: contacts:write.

Authorization

BearerAuth *Bearer <token>

API key generated under Account Settings → API Keys (rk_live_...). Send as header Authorization: Bearer <key>.

Request Bodyapplication/jsonrequired

contact *object

Show properties

id?integer

external_id?string

external_customer_id?string

email?string (email)

phone?string

phone_number?string

first_name?string

last_name?string

company?string

country?string

city?string

birthday?string

timezone?string

custom_fields?object

Response

200 · Successful response. See the integration guide for status and lifecycle semantics.

Type: object

401 · Invalid, expired, revoked or missing key.

Invalid, expired, revoked or missing key.

403 · Required scope not granted.

Required scope not granted.

422 · Validation or eligibility failure.

Validation or eligibility failure.

Request example

curl -X POST "https://convert.ruut.chat/api/v1/identify" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
  "contact": {
    "id": 0,
    "external_id": "string",
    "external_customer_id": "string",
    "email": "[email protected]",
    "phone": "string",
    "phone_number": "string",
    "first_name": "string",
    "last_name": "string",
    "company": "string",
    "country": "string",
    "city": "string",
    "birthday": "string",
    "timezone": "string",
    "custom_fields": {}
  }
}'