Update Portal Settings

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
  }
}

PATCH

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
  }
}

Update your affiliate portal settings. All fields are optional. If no portal settings exist yet, they will be created.

Body Parameters

boolean

Show only one program in the portal.

boolean

Hide Affonso branding from the portal.

boolean

Hide program details from affiliates.

string | null

Primary brand color (hex code). Maximum 255 characters. Set to null to clear.

string | null

Secondary brand color (hex code). Maximum 255 characters. Set to null to clear.

boolean

Show the affiliate leaderboard.

boolean

Enable terms & conditions.

string | null

Terms & conditions content or URL. Set to null to clear.

boolean

Enable privacy policy.

string | null

boolean

Show support email in the portal.

string | null

Support email address. Must be a valid email, max 255 characters. Set to null to clear.

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
  }
}

Getting Started

Guide

Core Resources

Program Management

Marketplace

Body Parameters

Response

​Body Parameters

​Response

Body Parameters

Response