curl -X PATCH "https://api.affonso.io/v1/program" \
-H "Authorization: Bearer sk_live_your_api_key" \
-H "Content-Type: application/json" \
-d '{
"name": "Acme SaaS Pro",
"tagline": "The #1 project management tool",
"access_mode": "PRIVATE"
}'
{
"success": true,
"data": {
"id": "cm7xutqbb0001yfkcrnpextmp",
"name": "Acme SaaS Pro",
"slug": "acme-saas",
"tagline": "The #1 project management tool",
"description": "The best project management tool for teams",
"website_url": "https://acme.com",
"access_mode": "private",
"status": "active",
"affiliate_links_enabled": true,
"logo_url": "https://cdn.affonso.io/logos/acme.png",
"customer_information_visibility": "hidden",
"default_referral_parameter": "ref",
"created_at": "2024-01-10T08:00:00.000Z",
"updated_at": "2024-06-15T15:00:00.000Z",
"plan": {
"tier": "growth",
"postbacks": true,
"groups_limit": 5
}
}
}
Info
Update Program Info
Update your affiliate program name, description, and other settings
PATCH
/
v1
/
program
curl -X PATCH "https://api.affonso.io/v1/program" \
-H "Authorization: Bearer sk_live_your_api_key" \
-H "Content-Type: application/json" \
-d '{
"name": "Acme SaaS Pro",
"tagline": "The #1 project management tool",
"access_mode": "PRIVATE"
}'
{
"success": true,
"data": {
"id": "cm7xutqbb0001yfkcrnpextmp",
"name": "Acme SaaS Pro",
"slug": "acme-saas",
"tagline": "The #1 project management tool",
"description": "The best project management tool for teams",
"website_url": "https://acme.com",
"access_mode": "private",
"status": "active",
"affiliate_links_enabled": true,
"logo_url": "https://cdn.affonso.io/logos/acme.png",
"customer_information_visibility": "hidden",
"default_referral_parameter": "ref",
"created_at": "2024-01-10T08:00:00.000Z",
"updated_at": "2024-06-15T15:00:00.000Z",
"plan": {
"tier": "growth",
"postbacks": true,
"groups_limit": 5
}
}
}
Update your affiliate program’s basic information. All fields are optional — only include the fields you want to change.
Body Parameters
Deprecated compatibility alias for the global promotion URL. Updating it also updates the global promotion URL. Use Create Promotion URL for new integrations. Must be a valid URL, max 255 characters.
Program access mode. One of
PUBLIC (auto-approve all), PRIVATE (manual approval), or INVITE (invite-only, auto-approved).Response
Returns the updated program info object with plan features. Same structure as the Get Program Info response.curl -X PATCH "https://api.affonso.io/v1/program" \
-H "Authorization: Bearer sk_live_your_api_key" \
-H "Content-Type: application/json" \
-d '{
"name": "Acme SaaS Pro",
"tagline": "The #1 project management tool",
"access_mode": "PRIVATE"
}'
{
"success": true,
"data": {
"id": "cm7xutqbb0001yfkcrnpextmp",
"name": "Acme SaaS Pro",
"slug": "acme-saas",
"tagline": "The #1 project management tool",
"description": "The best project management tool for teams",
"website_url": "https://acme.com",
"access_mode": "private",
"status": "active",
"affiliate_links_enabled": true,
"logo_url": "https://cdn.affonso.io/logos/acme.png",
"customer_information_visibility": "hidden",
"default_referral_parameter": "ref",
"created_at": "2024-01-10T08:00:00.000Z",
"updated_at": "2024-06-15T15:00:00.000Z",
"plan": {
"tier": "growth",
"postbacks": true,
"groups_limit": 5
}
}
}
Was this page helpful?
