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>"
    }
  ]
}
'
{
  "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

Success

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