Identify customers

Identify tells PartnerConsole what your app knows about a merchant: their shop name, contact email, and any custom fields. Call it when a merchant installs, when their details change, and whenever a field you track updates.

curl -X POST https://api.partnerconsole.co/v1/identify \
  -H "X-Api-Key: $API_KEY" -H "Content-Type: application/json" \
  -d '{
    "myshopifyDomain": "example.myshopify.com",
    "name": "Example Store",
    "email": "[email protected]",
    "customFields": {"plan_seats": 5, "onboarded": true}
  }'

What happens on the console side:

• The customer record updates in place; unknown custom fields create definitions automatically with inferred types (text, number, boolean, json).
• Fields become usable everywhere immediately: segment conditions (cf:plan_seats gte 5), flow conditions, and the customer page.
• The contact email becomes the recipient for flows and campaigns, so sending it early matters.

When to call it

• On install (or first boot of your app for that shop).
• Whenever the merchant edits their profile or settings you mirror.
• On a schedule if your fields are computed (e.g. nightly counters), though for high-volume computed data consider a database-linked custom field instead: the console queries your database directly and your app sends nothing.

Identify is idempotent per call: sending the same payload twice is harmless.