Skip to main content
PATCH
/
v1
/
program
/
portal
curl -X PATCH "https://api.affonso.io/v1/program/portal" \
  -H "Authorization: Bearer sk_live_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "primary_color": "#881337",
    "hide_branding": true,
    "show_leaderboard": true,
    "support_email_status": true,
    "support_email_value": "affiliates@acme.com"
  }'
{
  "success": true,
  "data": {
    "single_program_portal": false,
    "hide_branding": true,
    "hide_details": false,
    "primary_color": "#881337",
    "secondary_color": null,
    "show_leaderboard": true,
    "terms_conditions_status": false,
    "terms_conditions_value": null,
    "privacy_policy_status": false,
    "privacy_policy_value": null,
    "support_email_status": true,
    "support_email_value": "affiliates@acme.com",
    "custom_texts": null
  }
}

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 affiliate portal settings. All fields are optional. If no portal settings exist yet, they will be created.

Body Parameters

single_program_portal
boolean
Show only one program in the portal.
hide_branding
boolean
Hide Affonso branding from the portal.
hide_details
boolean
Hide program details from affiliates.
primary_color
string | null
Primary brand color (hex code). Maximum 255 characters. Set to null to clear.
secondary_color
string | null
Secondary brand color (hex code). Maximum 255 characters. Set to null to clear.
show_leaderboard
boolean
Show the affiliate leaderboard.
terms_conditions_status
boolean
Enable terms & conditions.
terms_conditions_value
string | null
Terms & conditions content or URL. Set to null to clear.
privacy_policy_status
boolean
Enable privacy policy.
privacy_policy_value
string | null
Privacy policy content or URL. Set to null to clear.
support_email_status
boolean
Show support email in the portal.
support_email_value
string | null
Support email address. Must be a valid email, max 255 characters. Set to null to clear.
custom_texts
object | null
Custom text overrides for portal UI elements. Set to null to clear.

Response

Returns the updated portal settings object. Same structure as the Get Portal Settings response.
curl -X PATCH "https://api.affonso.io/v1/program/portal" \
  -H "Authorization: Bearer sk_live_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "primary_color": "#881337",
    "hide_branding": true,
    "show_leaderboard": true,
    "support_email_status": true,
    "support_email_value": "affiliates@acme.com"
  }'
{
  "success": true,
  "data": {
    "single_program_portal": false,
    "hide_branding": true,
    "hide_details": false,
    "primary_color": "#881337",
    "secondary_color": null,
    "show_leaderboard": true,
    "terms_conditions_status": false,
    "terms_conditions_value": null,
    "privacy_policy_status": false,
    "privacy_policy_value": null,
    "support_email_status": true,
    "support_email_value": "affiliates@acme.com",
    "custom_texts": null
  }
}