Partners
Create partner
Create a new affiliate partner in your program programmatically
POST
Create partner
Endpoint
Partners are automatically created when someone signs up through the partner portal. Use this endpoint to create partners programmatically.
Request body
| Parameter | Type | Required | Description |
|---|---|---|---|
email | string | Yes | Must be a unique email address |
name | string | No | Partner’s first name |
surname | string | No | Partner’s last name |
password | string | No | Password for portal login. Auto-generated if not provided. Must have min 8 chars, 1 lowercase, 1 uppercase, 1 number |
id | string | No | Custom unique ID (auto-generated if not provided) |
key | string | No | Referral key for links (auto-generated if not provided) |
tags | array | No | Tags to associate with the partner |
referring_partner | object | No | Assign a referring partner (multi-tier programs) |
referring_partner.id | string | No | Referring partner’s ID |
referring_partner.key | string | No | Referring partner’s key |
referring_partner.email | string | No | Referring partner’s email |
Request
cURL
Response
Error responses
| Status | Error | Solution |
|---|---|---|
| 422 | Email already exists | Use a unique email address |
| 422 | ID already exists | Use a unique partner ID |
| 422 | Key already exists | Use a unique referral key |
| 400 | Referring partner not found | Check the referring partner ID/key/email |
Invite a partner
Send an invitation email to a potential partner. The partner receives an email with a link to sign up through the portal.This endpoint is available for affiliate programs only.
| Parameter | Type | Required | Description |
|---|---|---|---|
email | string | Yes | Email address of the partner |
name | string | Yes | Partner’s first name |
surname | string | No | Partner’s last name |
cURL
Create partner
