Sign in
Affiliates

Invite Affiliate

Creates (or reuses) a customer by email and assigns them an affiliate code, making them an affiliate.

post/v1/shops/{shopId}/affiliates/invite

Request body

emailstring required

The affiliate's email.

affiliate_codestring required

The code to assign.

tier_idinteger required

The tier to place them in. Required.

send_emailboolean

Whether to email the affiliate their code and referral link. Defaults to true.

Example request

{
  "email": "partner@example.com",
  "affiliate_code": "PARTNER10",
  "tier_id": 1
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.