Skip to main content
POST
/
api
/
v1
/
affiliate
/
import
Imports affiliate items.
curl --request POST \
  --url https://api.example.com/api/v1/affiliate/import \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "items": [
    {
      "externalId": "<string>",
      "email": "<string>",
      "username": "<string>",
      "name": "<string>",
      "balance": 123,
      "paid": 123,
      "website": "<string>",
      "companyName": "<string>",
      "companyNumber": "<string>",
      "addressLine1": "<string>",
      "addressLine2": "<string>",
      "city": "<string>",
      "region": "<string>",
      "country": "<string>",
      "postcode": "<string>"
    }
  ]
}
'
import requests

url = "https://api.example.com/api/v1/affiliate/import"

payload = { "items": [
        {
            "externalId": "<string>",
            "email": "<string>",
            "username": "<string>",
            "name": "<string>",
            "balance": 123,
            "paid": 123,
            "website": "<string>",
            "companyName": "<string>",
            "companyNumber": "<string>",
            "addressLine1": "<string>",
            "addressLine2": "<string>",
            "city": "<string>",
            "region": "<string>",
            "country": "<string>",
            "postcode": "<string>"
        }
    ] }
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    items: [
      {
        externalId: '<string>',
        email: '<string>',
        username: '<string>',
        name: '<string>',
        balance: 123,
        paid: 123,
        website: '<string>',
        companyName: '<string>',
        companyNumber: '<string>',
        addressLine1: '<string>',
        addressLine2: '<string>',
        city: '<string>',
        region: '<string>',
        country: '<string>',
        postcode: '<string>'
      }
    ]
  })
};

fetch('https://api.example.com/api/v1/affiliate/import', 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://api.example.com/api/v1/affiliate/import",
  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([
    'items' => [
        [
                'externalId' => '<string>',
                'email' => '<string>',
                'username' => '<string>',
                'name' => '<string>',
                'balance' => 123,
                'paid' => 123,
                'website' => '<string>',
                'companyName' => '<string>',
                'companyNumber' => '<string>',
                'addressLine1' => '<string>',
                'addressLine2' => '<string>',
                'city' => '<string>',
                'region' => '<string>',
                'country' => '<string>',
                'postcode' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "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://api.example.com/api/v1/affiliate/import"

	payload := strings.NewReader("{\n  \"items\": [\n    {\n      \"externalId\": \"<string>\",\n      \"email\": \"<string>\",\n      \"username\": \"<string>\",\n      \"name\": \"<string>\",\n      \"balance\": 123,\n      \"paid\": 123,\n      \"website\": \"<string>\",\n      \"companyName\": \"<string>\",\n      \"companyNumber\": \"<string>\",\n      \"addressLine1\": \"<string>\",\n      \"addressLine2\": \"<string>\",\n      \"city\": \"<string>\",\n      \"region\": \"<string>\",\n      \"country\": \"<string>\",\n      \"postcode\": \"<string>\"\n    }\n  ]\n}")

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

	req.Header.Add("Authorization", "<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.post("https://api.example.com/api/v1/affiliate/import")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"items\": [\n    {\n      \"externalId\": \"<string>\",\n      \"email\": \"<string>\",\n      \"username\": \"<string>\",\n      \"name\": \"<string>\",\n      \"balance\": 123,\n      \"paid\": 123,\n      \"website\": \"<string>\",\n      \"companyName\": \"<string>\",\n      \"companyNumber\": \"<string>\",\n      \"addressLine1\": \"<string>\",\n      \"addressLine2\": \"<string>\",\n      \"city\": \"<string>\",\n      \"region\": \"<string>\",\n      \"country\": \"<string>\",\n      \"postcode\": \"<string>\"\n    }\n  ]\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/affiliate/import")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"items\": [\n    {\n      \"externalId\": \"<string>\",\n      \"email\": \"<string>\",\n      \"username\": \"<string>\",\n      \"name\": \"<string>\",\n      \"balance\": 123,\n      \"paid\": 123,\n      \"website\": \"<string>\",\n      \"companyName\": \"<string>\",\n      \"companyNumber\": \"<string>\",\n      \"addressLine1\": \"<string>\",\n      \"addressLine2\": \"<string>\",\n      \"city\": \"<string>\",\n      \"region\": \"<string>\",\n      \"country\": \"<string>\",\n      \"postcode\": \"<string>\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body
{
  "numImported": 123,
  "numDuplicates": 123,
  "numFailed": 123,
  "firstFailureId": "<string>",
  "firstFailureMessage": "<string>"
}

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}"

Headers

X-Api-Key
string

Body

Affiliate items.

items
object[]
required

Response

OK

numImported
integer<int32>
numDuplicates
integer<int32>
numFailed
integer<int32>
firstFailureId
string | null
firstFailureMessage
string | null