Identify a customer

POST/api/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

appstringrequired

Your app’s slug.

myshopifyDomainstringrequired

The shop’s *.myshopify.com domain.

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.

Returns

200Updated; the body lists what changed.

400app or myshopifyDomain missing.

401Bad or missing X-Api-Key.

Request

cURL

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

Node.js

await fetch(
  'https://partnerconsole.co/api/v1/identify',
  {
    method: 'POST',
    headers: {
      'X-Api-Key': process.env.PC_API_KEY,
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      app: 'your-app-slug',
      myshopifyDomain: shop.domain,
      name: shop.name,
      email: shop.ownerEmail,
      customFields: {
        plan_seats: shop.seats,
        onboarded: true,
      },
    }),
  },
);

Python

import os, requests

requests.post(
    "https://partnerconsole.co/api/v1/identify",
    headers={"X-Api-Key": os.environ["PC_API_KEY"]},
    json={
        "app": "your-app-slug",
        "myshopifyDomain": shop.domain,
        "name": shop.name,
        "email": shop.owner_email,
        "customFields": {
            "plan_seats": shop.seats,
            "onboarded": True,
        },
    },
    timeout=10,
)

Response · 200

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