Create an Affiliate
Creates an affiliate in your program and gives them their first referral link.
firstName, lastName and email are required; the email must be unique within the program. If you do not send affiliateLink, a slug is generated from the email address. If you do send one and it is already taken, the request fails rather than silently picking another slug.
When commissionRate is omitted the affiliate inherits the program’s default rate. When affiliateStatus is omitted, the program’s auto-approve setting decides whether the affiliate starts active or pending.
Creating an affiliate also triggers the admin notification email, the affiliate welcome email (active affiliates only, unless sendWelcomeEmail is false), any automatic promo codes, and the affiliate.created webhook.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
The affiliate to create
First name of the affiliate
Last name of the affiliate
Email of the affiliate
Commission rate for the affiliate
Optional slug for the affiliate's first referral link. If omitted, a slug is generated automatically.
Status of the new affiliate. If omitted, the program's auto-approve setting decides whether the affiliate is created active or inactive.
active, inactive Set to false to skip the affiliate welcome email. The welcome email is only sent when the affiliate is created active.
Assign the affiliate to a commission plan in this program. Returns 400 if the plan does not exist in this program.
Assign the affiliate to an affiliate group in this program. Returns 400 if the group does not exist, or if commissionPlanId belongs to a different group.
Response
The created affiliate, including its generated affiliateLinks entry.
The affiliate ID
First name of the affiliate
Last name of the affiliate
Full name of the affiliate (optional)
Email of the affiliate
Hashed Password of the affiliate (optional)
Flag to indicate if the email has been verified
Profile image URL of the affiliate
Flag to indicate if affiliate details are complete
The program ID that the affiliate is associated with
Email to be used for payouts
Payment method for the affiliate (e.g., WISE)
Commission rate for the affiliate (0 - 100)
Deprecated legacy field and almost always null. Read affiliateLinks instead.
All affiliate link records for this affiliate. This is the source of truth for referral link slugs.
Affiliate status. INACTIVE is shown as Pending in the dashboard and is kept for backwards compatibility.
ACTIVE, INACTIVE, INVITED, DECLINED, DEACTIVATED, BANNED Timestamp when the affiliate was created
Timestamp when the affiliate was last updated
Number of users referred by the affiliate
Number of clicks generated by the affiliate
Total commission earned by the affiliate
How the affiliate joined. Affiliates created through this API have API.
The commission plan assigned to this affiliate, if any
The affiliate group this affiliate belongs to, if any