POST
/
affiliates
Create a new affiliate
curl --request POST \
  --url https://www.pushlapgrowth.com/api/v1/affiliates \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "firstName": "<string>",
  "lastName": "<string>",
  "email": "jsmith@example.com",
  "commissionRate": 123,
  "affiliateLink": "<string>"
}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "firstName": "<string>",
  "lastName": "<string>",
  "name": "<string>",
  "email": "jsmith@example.com",
  "password": "<string>",
  "emailVerified": true,
  "image": "<string>",
  "detailsComplete": true,
  "programId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "payoutEmail": "jsmith@example.com",
  "paymentMethod": "<string>",
  "commissionRate": 123,
  "link": "<string>",
  "status": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "numberOfReferredUsers": 123,
  "numberOfClicks": 123,
  "totalCommissionEarned": 123
}

Authorizations

Authorization
string
header
required

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

Body

application/json

Affiliate details

firstName
string
required

First name of the affiliate

lastName
string
required

Last name of the affiliate

email
string<email>
required

Email of the affiliate

commissionRate
number

Commission rate for the affiliate

Custom affiliate link for the affiliate

Response

Affiliate created successfully

id
string<uuid>

The affiliate ID

firstName
string

First name of the affiliate

lastName
string

Last name of the affiliate

name
string | null

Full name of the affiliate (optional)

email
string<email>

Email of the affiliate

password
string | null
deprecated

Hashed Password of the affiliate (optional)

emailVerified
boolean | null

Flag to indicate if the email has been verified

image
string | null

Profile image URL of the affiliate

detailsComplete
boolean

Flag to indicate if affiliate details are complete

programId
string<uuid>

The program ID that the affiliate is associated with

payoutEmail
string<email>

Email to be used for payouts

paymentMethod
string

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

commissionRate
number

Commission rate for the affiliate (0 - 100)

Affiliate's custom referral link

status
string

Status of the affiliate (active/inactive)

createdAt
string<date-time>

Timestamp when the affiliate was created

updatedAt
string<date-time>

Timestamp when the affiliate was last updated

numberOfReferredUsers
integer

Number of users referred by the affiliate

numberOfClicks
integer

Number of clicks generated by the affiliate

totalCommissionEarned
number

Total commission earned by the affiliate