Skip to content
Partner Console Developers

Onboard affiliates via API

If partners sign up inside your own product (an agency portal, a partner form), enroll them in your affiliate program server-to-server instead of inviting them by hand:

Terminal window
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"}'

The response includes the minted handle and the full tracked link, ready to display back to the partner:

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

Notes:

  • Calling again with the same email returns the existing affiliate (200 instead of 201) with their current handle: safe to retry.
  • handle is optional; omitted, one is derived from the name or email and de-duplicated automatically.
  • If the program requires approval, the affiliate lands as pending and appears in the console’s approval queue.
  • Affiliates sign in to their portal at partnerconsole.co/portal with the email you enrolled: passwordless one-time codes, nothing for you to provision.