Update Referral

Updates a referral based on their ID

PUT /referrals

Update a referral by ID

cURL

curl --request PUT \
  --url https://www.referly.so/api/v1/referrals \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "referralId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "email": "[e-mail]",
  "referredUserExternalId": "<string>",
  "plan": "<string>",
  "status": "<string>"
}
'

import requests

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

payload = {
    "referralId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "email": "[e-mail]",
    "referredUserExternalId": "<string>",
    "plan": "<string>",
    "status": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    referralId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    name: '<string>',
    email: '[e-mail]',
    referredUserExternalId: '<string>',
    plan: '<string>',
    status: '<string>'
  })
};

fetch('https://www.referly.so/api/v1/referrals', 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/referrals",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'referralId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'name' => '<string>',
    'email' => '[e-mail]',
    'referredUserExternalId' => '<string>',
    'plan' => '<string>',
    'status' => '<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/referrals"

	payload := strings.NewReader("{\n  \"referralId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"name\": \"<string>\",\n  \"email\": \"[e-mail]\",\n  \"referredUserExternalId\": \"<string>\",\n  \"plan\": \"<string>\",\n  \"status\": \"<string>\"\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://www.referly.so/api/v1/referrals")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"referralId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"name\": \"<string>\",\n  \"email\": \"[e-mail]\",\n  \"referredUserExternalId\": \"<string>\",\n  \"plan\": \"<string>\",\n  \"status\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"referralId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"name\": \"<string>\",\n  \"email\": \"[e-mail]\",\n  \"referredUserExternalId\": \"<string>\",\n  \"plan\": \"<string>\",\n  \"status\": \"<string>\"\n}"

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

400

{
  "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

Referral update details

referralId · string<uuid> · required

The referral ID to update

name · string

Name of the referred user

email · string<email>

Email of the referred user

referredUserExternalId · string

The external ID of the referred user. This will be an ID you actively maintain that identifies the user on your server (for example, the User ID in your database, or Stripe Customer ID)

plan · string

The plan associated with the referred user

status · string

Status of the referral (active/inactive)

Response

200

Referral updated successfully