Identify a customer

POST/v1/identify

Updates (or creates) a customer record with what your app knows: display name, contact email, and custom fields. Unknown custom fields create definitions automatically with inferred types.

Idempotent: resending the same payload is harmless. Database-linked custom fields are read-only here; pushes to them are skipped because their linked SQL query is the source of truth.

Body parameters

myshopifyDomainstringrequired: The shop's *.myshopify.com domain.
appstring: Optional. Your app's slug. The X-Api-Key already identifies the app; if you send this, it must match.
namestring: Shop display name.
emailstring: Contact email; becomes the recipient for flows and campaigns.
customFieldsobject: Any keys; values may be text, number, boolean, or JSON. Unknown fields create definitions with inferred types. A null value unsets the field. Database-linked fields are skipped (their SQL query is the source of truth).

Returns

200Updated; the body lists what changed.

400myshopifyDomain missing.

401Bad or missing X-Api-Key.

Request

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
    }
  }'

Response · 200

{
  "ok": true,
  "updated": ["shop_name", "contact_email"],
  "customFields": 2
}

Body parameters

Returns

On this page