Skip to main content
PUT
/
api
/
v2
/
network
/
affiliates
/
{id}
Update affiliate
curl --request PUT \
  --url 'https://{domain}/api/v2/network/affiliates/{id}?api-key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "user@example.com",
  "password": "string",
  "password_repeat": "string",
  "company_name": "string",
  "firstname": "string"
}
'
{
  "status": "success",
  "code": 200,
  "name": "OK",
  "message": "<string>",
  "info": {
    "affiliate": {}
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.scaleo.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
api-key
string
query
required

API key passed as query parameter. User must have api_status enabled.

Path Parameters

​
id
integer
required

Affiliate ID.

Body

application/json
​
email
string<email>
​
password
string

New password (min 8 chars). Repeating consecutive characters are allowed.

​
password_repeat
string

Password confirmation.

​
company_name
string
Maximum string length: 255
​
firstname
string
Maximum string length: 255
​
lastname
string
Maximum string length: 255
​
phone
string
Maximum string length: 64
​
website_url
string
Maximum string length: 255
​
status
integer

Status: 1=active, 2=disabled, 3=pending, 4=rejected.

​
api_status
integer

API access: 1=enabled, 2=disabled.

​
country
integer

Country geoname_id.

​
region
string
Maximum string length: 128
​
city
string
Maximum string length: 128
​
address
string
Maximum string length: 128
​
postal_code
string
Maximum string length: 16
​
timezone
string
Maximum string length: 64
​
number_format_id
integer
​
date_format_id
integer
​
contacts
string

JSON string with contact information.

​
notes
string
​
internal_notes
string
​
payment_details
string

Payment details (JSON string).

​
referred_by
integer

Referrer affiliate ID.

​
referral_commission
number

Referral commission percentage.

​
managers
string

Manager ID or comma-separated IDs.

​
custom_fields
object

Custom field values.

​
tags
string

Comma-separated tag labels.

​
traffic_sources
integer[]
​
login_redirect_url
string
​
image_data
string

Base64-encoded image (data:image/png;base64,...).

​
external_id
string
Maximum string length: 64
​
trafficback_url
string<uri>

Affiliate-level trafficback URL. All invalid traffic from this affiliate will be redirected to this URL. Overrides offer-level and global trafficback settings. Available on Enterprise and Custom plans only.

Maximum string length: 255

Response

Updated affiliate.

​
status
string
Example:

"success"

​
code
integer
Example:

200

​
name
string
Example:

"OK"

​
message
string
​
info
object