Skip to main content
PATCH
/
v1
/
program
/
tracking
curl -X PATCH "https://api.affonso.io/v1/program/tracking" \
  -H "Authorization: Bearer sk_live_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "default_referral_parameter": "ref",
    "enabled_referral_parameters": ["ref", "via"],
    "email_tracking_enabled": true
  }'

{
  "success": true,
  "data": {
    "default_referral_parameter": "ref",
    "enabled_referral_parameters": ["ref", "via"],
    "email_tracking_enabled": true,
    "name_tracking_enabled": false,
    "postbacks_enabled": false
  }
}

Documentation Index

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

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

Update your program’s referral tracking configuration. All fields are optional.
Enabling postback URLs requires the Growth plan or higher. Attempting to enable postbacks on the Launch plan will return a 403 PLAN_UPGRADE_REQUIRED error.

​
Body Parameters

​
default_referral_parameter
string
Default referral query parameter name. Must be between 1 and 50 characters.
​
enabled_referral_parameters
array
List of accepted referral parameter names. Each must be between 1 and 50 characters.
​
email_tracking_enabled
boolean
Enable referral tracking by email address.
​
name_tracking_enabled
boolean
Enable referral tracking by affiliate name.
​
postbacks_enabled
boolean
Enable postback URLs. Requires Growth plan or higher.

​
Response

Returns the updated tracking settings object. Same structure as the Get Tracking Settings response. 
curl -X PATCH "https://api.affonso.io/v1/program/tracking" \
  -H "Authorization: Bearer sk_live_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "default_referral_parameter": "ref",
    "enabled_referral_parameters": ["ref", "via"],
    "email_tracking_enabled": true
  }'

{
  "success": true,
  "data": {
    "default_referral_parameter": "ref",
    "enabled_referral_parameters": ["ref", "via"],
    "email_tracking_enabled": true,
    "name_tracking_enabled": false,
    "postbacks_enabled": false
  }
}