POST
/
affiliates

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
email
string
required

Email of the affiliate

firstName
string
required

First name of the affiliate

lastName
string
required

Last name of the affiliate

commissionRate
number

Commission rate for the affiliate

Response

200 - application/json
commissionRate
number

Commission rate for the affiliate (0 - 100)

createdAt
string

Timestamp when the affiliate was created

detailsComplete
boolean

Flag to indicate if affiliate details are complete

email
string

Email of the affiliate

emailVerified
boolean | null

Flag to indicate if the email has been verified

firstName
string

First name of the affiliate

id
string

The affiliate ID

image
string | null

Profile image URL of the affiliate

lastName
string

Last name of the affiliate

Affiliate's custom referral link

name
string | null

Full name of the affiliate (optional)

numberOfClicks
integer

Number of clicks generated by the affiliate

numberOfReferredUsers
integer

Number of users referred by the affiliate

password
string | null
deprecated

Hashed Password of the affiliate (optional)

paymentMethod
string

Payment method for the affiliate (e.g., WISE)

payoutEmail
string

Email to be used for payouts

programId
string

The program ID that the affiliate is associated with

status
string

Status of the affiliate (active/inactive)

totalCommissionEarned
number

Total commission earned by the affiliate

updatedAt
string

Timestamp when the affiliate was last updated