Skip to main content
POST
Invite Affiliate

Authorizations

Authorization
string
header
required

You can retrieve your API key from your dashboard under Account > Developers.

Path Parameters

shopId
integer
required

The shop ID.

Body

application/json
email
string
required

The affiliate's email.

Example:

"partner@example.com"

affiliate_code
string
required

The code to assign.

Example:

"PARTNER10"

tier_id
integer
required

The tier to place them in. Required.

Example:

1

send_email
boolean

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

Example:

null

Response

200 - undefined