Onboard an affiliate

POST/api/v1/affiliates

Creates (or finds) an affiliate by email and enrolls them in your app’s program, returning their referral handle and tracked link, ready to show back to the partner.

status comes back pending when the program requires approval; the affiliate then appears in the console’s approval queue and gets portal access once approved. Affiliates sign in at partnerconsole.co/portal with the enrolled email: passwordless one-time codes, nothing for you to provision.

Body parameters

appstringrequired: Your app’s slug; the affiliate joins this app’s program.
emailstringrequired: The affiliate’s portal sign-in identity.
namestring: Display name.
handlestring: Requested referral handle; derived from the name or email and de-duplicated when omitted.

Returns

201New affiliate created and enrolled.

200Email already existed; the current enrollment is returned (safe to retry).

400Invalid email, or the app has no affiliate program yet.

401Bad or missing X-Api-Key.

Request

curl -X POST \
  https://partnerconsole.co/api/v1/affiliates \
  -H "X-Api-Key: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "app": "your-app-slug",
    "email": "[email protected]",
    "name": "Acme Agency",
    "handle": "acme-agency"
  }'

const res = await fetch(
  'https://partnerconsole.co/api/v1/affiliates',
  {
    method: 'POST',
    headers: {
      'X-Api-Key': process.env.PC_API_KEY,
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      app: 'your-app-slug',
      email: partner.email,
      name: partner.company,
    }),
  },
);
const {link} = await res.json();

import os, requests

res = requests.post(
    "https://partnerconsole.co/api/v1"
    "/affiliates",
    headers={
        "X-Api-Key": os.environ["PC_API_KEY"],
    },
    json={
        "app": "your-app-slug",
        "email": partner.email,
        "name": partner.company,
    },
    timeout=10,
)
link = res.json()["link"]

Response · 201

{
  "affiliateId": 12,
  "created": true,
  "handle": "acme-agency",
  "link": "https://apps.shopify.com/your-app?mref=acme-agency",
  "status": "enrolled"
}