Create an Affiliate

Creates a new affiliate on your Affiliate Program. The response includes an affiliateLinks array (initially containing the link created from affiliateLink, or an auto-generated slug).

POST /affiliates

Create a new affiliate

cURL

curl --request POST \
  --url https://www.referly.so/api/v1/affiliates \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "firstName": "<string>",
  "lastName": "<string>",
  "email": "[e-mail]",
  "commissionRate": 123,
  "affiliateLink": "<string>"
}
'

import requests

url = "https://www.referly.so/api/v1/affiliates"

payload = {
    "firstName": "<string>",
    "lastName": "<string>",
    "email": "[e-mail]",
    "commissionRate": 123,
    "affiliateLink": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    firstName: '<string>',
    lastName: '<string>',
    email: '[e-mail]',
    commissionRate: 123,
    affiliateLink: '<string>'
  })
};

fetch('https://www.referly.so/api/v1/affiliates', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://www.referly.so/api/v1/affiliates",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'firstName' => '<string>',
    'lastName' => '<string>',
    'email' => '[e-mail]',
    'commissionRate' => 123,
    'affiliateLink' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://www.referly.so/api/v1/affiliates"

	payload := strings.NewReader("{\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"email\": \"[e-mail]\",\n  \"commissionRate\": 123,\n  \"affiliateLink\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://www.referly.so/api/v1/affiliates")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"email\": \"[e-mail]\",\n  \"commissionRate\": 123,\n  \"affiliateLink\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://www.referly.so/api/v1/affiliates")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"email\": \"[e-mail]\",\n  \"commissionRate\": 123,\n  \"affiliateLink\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "firstName": "<string>",
  "lastName": "<string>",
  "name": "<string>",
  "email": "[e-mail]",
  "password": "<string>",
  "emailVerified": true,
  "image": "<string>",
  "detailsComplete": true,
  "programId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "payoutEmail": "[e-mail]",
  "paymentMethod": "<string>",
  "commissionRate": 123,
  "link": "<string>",
  "affiliateLinks": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "link": "<string>",
      "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "programId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "status": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "numberOfReferredUsers": 123,
  "numberOfClicks": 123,
  "totalCommissionEarned": 123
}

{
  "error": 123,
  "message": "<string>"
}

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<float>

Commission rate for the affiliate

affiliateLink · string

Optional slug for the affiliate's first referral link. If omitted, a slug is generated automatically.

Response

200

application/json

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<float>

Commission rate for the affiliate (0 - 100)

link · string | null · deprecated

Deprecated legacy field; often null. Use affiliateLinks for all link slugs.

affiliateLinks · object[]

All affiliate link records for this affiliate. This is the source of truth for referral link slugs.

Show child attributes

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<float>

Total commission earned by the affiliate