Skip to main content
PUT
/
api
/
v2
/
affiliate
/
profile
Update affiliate profile
curl --request PUT \
  --url https://{domain}/api/v2/affiliate/profile \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "company": "Example Inc",
  "firstname": "string",
  "lastname": "string",
  "password": "string",
  "phone": "+15551234567",
  "api_whitelist": "203.0.113.10, 203.0.113.0/24"
}
'
import requests

url = "https://{domain}/api/v2/affiliate/profile"

payload = {
"company": "Example Inc",
"firstname": "string",
"lastname": "string",
"password": "string",
"phone": "+15551234567",
"api_whitelist": "203.0.113.10, 203.0.113.0/24"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'PUT',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
company: 'Example Inc',
firstname: 'string',
lastname: 'string',
password: 'string',
phone: '+15551234567',
api_whitelist: '203.0.113.10, 203.0.113.0/24'
})
};

fetch('https://{domain}/api/v2/affiliate/profile', 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://{domain}/api/v2/affiliate/profile",
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([
'company' => 'Example Inc',
'firstname' => 'string',
'lastname' => 'string',
'password' => 'string',
'phone' => '+15551234567',
'api_whitelist' => '203.0.113.10, 203.0.113.0/24'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);

$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://{domain}/api/v2/affiliate/profile"

payload := strings.NewReader("{\n \"company\": \"Example Inc\",\n \"firstname\": \"string\",\n \"lastname\": \"string\",\n \"password\": \"string\",\n \"phone\": \"+15551234567\",\n \"api_whitelist\": \"203.0.113.10, 203.0.113.0/24\"\n}")

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

req.Header.Add("X-API-Key", "<api-key>")
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://{domain}/api/v2/affiliate/profile")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"company\": \"Example Inc\",\n \"firstname\": \"string\",\n \"lastname\": \"string\",\n \"password\": \"string\",\n \"phone\": \"+15551234567\",\n \"api_whitelist\": \"203.0.113.10, 203.0.113.0/24\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://{domain}/api/v2/affiliate/profile")

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

request = Net::HTTP::Put.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"company\": \"Example Inc\",\n \"firstname\": \"string\",\n \"lastname\": \"string\",\n \"password\": \"string\",\n \"phone\": \"+15551234567\",\n \"api_whitelist\": \"203.0.113.10, 203.0.113.0/24\"\n}"

response = http.request(request)
puts response.read_body
{
  "status": "success",
  "code": 200,
  "name": "OK",
  "message": "<string>",
  "info": {
    "affiliate": {}
  }
}
{
"message": "Request could not be parsed.",
"success": false,
"info": {
"errors": {}
}
}
{
"message": "API key is invalid or missing.",
"success": false
}
{
"message": "This endpoint is not available for your role.",
"success": false
}
{
"message": "Resource not found.",
"success": false
}
{
"message": "Validation error",
"success": false,
"info": {
"errors": {
"email": [
"Email cannot be blank."
],
"currency": [
"Currency must be a valid ISO code."
]
}
}
}
{
"message": "An unexpected error occurred.",
"success": false,
"info": {
"errors": {}
}
}

Authorizations

X-API-Key
string
header
required

Preferred authentication method. Pass the API key in the X-API-Key HTTP request header. The user account must have api_status enabled.

Body

application/json
company
string
firstname
string
lastname
string
password
string

New password. Repeating consecutive characters are allowed.

phone
string
messenger
string

Messenger handle/contact.

address
string
city
string
country
string
postcode
string
api_whitelist
string

SCL-12694. Full-replace of the affiliate's API IP whitelist. Comma-separated IPv4 / IPv6 / CIDR. Empty string clears all entries. Invalid entries return 422 with per-entry errors and nothing is persisted.

Example:

"203.0.113.10, 203.0.113.0/24"

Response

Updated profile.

status
string
Example:

"success"

code
integer
Example:

200

name
string
Example:

"OK"

message
string
info
object