# Affonso Docs ## Docs - [Authentication](https://docs.affonso.io/api/authentication.md): How to authenticate with the Affonso API - [Embedded Referral Dashboard](https://docs.affonso.io/api/embedded-dashboard.md): Display partner dashboards directly in your application - [Create Affiliate](https://docs.affonso.io/api/endpoint/affiliates/create.md): Create a new affiliate user - [Delete Affiliate](https://docs.affonso.io/api/endpoint/affiliates/delete.md): Delete an affiliate user and optionally their associated user account - [Get Affiliate](https://docs.affonso.io/api/endpoint/affiliates/get.md): Retrieve a single affiliate by ID with optional expanded data - [List Affiliates](https://docs.affonso.io/api/endpoint/affiliates/list.md): Get a paginated list of all affiliates with optional filtering and expansion - [Generate Portal Login Token](https://docs.affonso.io/api/endpoint/affiliates/portal-token.md): Generate a short-lived token to automatically authenticate an affiliate into the hosted portal - [Update Affiliate](https://docs.affonso.io/api/endpoint/affiliates/update.md): Update an existing affiliate - [Track Click](https://docs.affonso.io/api/endpoint/clicks/create.md): Record a click event for affiliate tracking. This endpoint uses burst rate limiting for high-frequency tracking. - [Create Commission](https://docs.affonso.io/api/endpoint/commissions/create.md): Create a new commission transaction manually - [Delete Commission](https://docs.affonso.io/api/endpoint/commissions/delete.md): Delete a commission transaction - [Get Commission](https://docs.affonso.io/api/endpoint/commissions/get.md): Retrieve a single commission by ID - [List Commissions](https://docs.affonso.io/api/endpoint/commissions/list.md): Get a paginated list of all commissions with optional filtering - [Update Commission](https://docs.affonso.io/api/endpoint/commissions/update.md): Update a commission's status, transaction status, hold period, or amounts - [Create Coupon](https://docs.affonso.io/api/endpoint/coupons/create.md): Generate a new promotional coupon for an affiliate - [Delete Coupon](https://docs.affonso.io/api/endpoint/coupons/delete.md): Permanently remove a promotional coupon - [Get Coupon](https://docs.affonso.io/api/endpoint/coupons/get.md): Retrieve details for a specific coupon - [List Coupons](https://docs.affonso.io/api/endpoint/coupons/list.md): Get a paginated list of affiliate promotional coupons - [Create Self-Service Coupon](https://docs.affonso.io/api/endpoint/embed/create-coupon.md): Allow affiliates to create their own coupon code - [Create Embed Token](https://docs.affonso.io/api/endpoint/embed/create-token.md): Generate a token for the embedded referral dashboard - [Get Embed Data](https://docs.affonso.io/api/endpoint/embed/get-data.md): Retrieve all data needed to render the embedded referral dashboard - [Get Marketplace Program](https://docs.affonso.io/api/endpoint/marketplace/get.md): Get details for a program listed in the Affonso marketplace - [List Marketplace Programs](https://docs.affonso.io/api/endpoint/marketplace/list.md): Get a paginated list of all programs listed in the Affonso marketplace - [Create Onboarding Form](https://docs.affonso.io/api/endpoint/onboarding/create-form.md): Atomically create your team's onboarding form along with its initial set of questions - [Delete Onboarding Form](https://docs.affonso.io/api/endpoint/onboarding/delete-form.md): Permanently delete your team's onboarding form and all related data - [Get Onboarding Form](https://docs.affonso.io/api/endpoint/onboarding/get-form.md): Retrieve your team's custom onboarding form together with its active questions - [Get Affiliate Onboarding Responses](https://docs.affonso.io/api/endpoint/onboarding/get-responses.md): Retrieve an affiliate's saved answers to the onboarding form along with completion status - [Submit Onboarding Responses](https://docs.affonso.io/api/endpoint/onboarding/submit-responses.md): Upsert one or more answers for an affiliate and optionally mark onboarding as complete - [Update Onboarding Form](https://docs.affonso.io/api/endpoint/onboarding/update-form.md): Update form metadata and/or replace the question set atomically - [Get Payout](https://docs.affonso.io/api/endpoint/payouts/get.md): Retrieve a single payout by ID with transaction details - [List Payouts](https://docs.affonso.io/api/endpoint/payouts/list.md): Get a paginated list of all payouts with optional filtering - [Update Payout](https://docs.affonso.io/api/endpoint/payouts/update.md): Update a payout's status, payment method, or payment reference - [Create Creative](https://docs.affonso.io/api/endpoint/program/create-creative.md): Create a new creative asset for your program - [Create Group](https://docs.affonso.io/api/endpoint/program/create-group.md): Create a new affiliate group - [Delete Creative](https://docs.affonso.io/api/endpoint/program/delete-creative.md): Delete a creative asset - [Delete Group](https://docs.affonso.io/api/endpoint/program/delete-group.md): Delete an affiliate group - [Get Creative](https://docs.affonso.io/api/endpoint/program/get-creative.md): Get a single creative by ID - [Get Fraud Rules](https://docs.affonso.io/api/endpoint/program/get-fraud-rules.md): Get fraud detection rule settings for your program - [Get Group](https://docs.affonso.io/api/endpoint/program/get-group.md): Get a single affiliate group by ID - [Get Program Info](https://docs.affonso.io/api/endpoint/program/get-info.md): Get your affiliate program configuration and plan features - [Get Payment Terms](https://docs.affonso.io/api/endpoint/program/get-payment-terms.md): Get commission and payment configuration for your program - [Get Portal Settings](https://docs.affonso.io/api/endpoint/program/get-portal.md): Get the affiliate portal appearance and configuration settings - [Get Restrictions](https://docs.affonso.io/api/endpoint/program/get-restrictions.md): Get allowed traffic sources and restrictions for your program - [Get Tracking Settings](https://docs.affonso.io/api/endpoint/program/get-tracking.md): Get referral tracking configuration including referral parameters and postbacks - [List Creatives](https://docs.affonso.io/api/endpoint/program/list-creatives.md): Get a paginated list of creatives for your program - [List Groups](https://docs.affonso.io/api/endpoint/program/list-groups.md): List all affiliate groups for your program - [List Notification Settings](https://docs.affonso.io/api/endpoint/program/list-notifications.md): Get all notification types with your team-specific settings - [Update Creative](https://docs.affonso.io/api/endpoint/program/update-creative.md): Update a creative asset - [Update Fraud Rules](https://docs.affonso.io/api/endpoint/program/update-fraud-rules.md): Update fraud detection rule modes and configurations - [Update Group](https://docs.affonso.io/api/endpoint/program/update-group.md): Update an affiliate group - [Update Program Info](https://docs.affonso.io/api/endpoint/program/update-info.md): Update your affiliate program name, description, and other settings - [Update Notification Setting](https://docs.affonso.io/api/endpoint/program/update-notification.md): Update a notification setting by email type ID - [Update Payment Terms](https://docs.affonso.io/api/endpoint/program/update-payment-terms.md): Update commission rates, payment frequency, cookie lifetime, and other payment settings - [Update Portal Settings](https://docs.affonso.io/api/endpoint/program/update-portal.md): Update portal appearance, branding, and policy settings - [Update Restrictions](https://docs.affonso.io/api/endpoint/program/update-restrictions.md): Update allowed traffic sources and restrictions - [Update Tracking Settings](https://docs.affonso.io/api/endpoint/program/update-tracking.md): Update referral tracking configuration including referral parameters and postbacks - [Create Referral](https://docs.affonso.io/api/endpoint/referrals/create.md): Create a new referral or convert an existing click to a referral - [Delete Referral](https://docs.affonso.io/api/endpoint/referrals/delete.md): Delete a referral and all associated commission transactions - [Get Referral](https://docs.affonso.io/api/endpoint/referrals/get.md): Retrieve a single referral by ID with optional expanded data and statistics - [List Referrals](https://docs.affonso.io/api/endpoint/referrals/list.md): Get a cursor-paginated list of all referrals with optional filtering and expansion - [Update Referral](https://docs.affonso.io/api/endpoint/referrals/update.md): Update an existing referral's email, customer ID, subscription ID, or status - [API Introduction](https://docs.affonso.io/api/introduction.md): Build powerful integrations with the Affonso REST API - [Rate Limits](https://docs.affonso.io/api/rate-limits.md): API rate limits and best practices - [TypeScript](https://docs.affonso.io/api/sdk/typescript.md): Official TypeScript SDK for the Affonso API - [AI Agents](https://docs.affonso.io/cli/ai-agents.md): Use the Affonso CLI as a tool for AI agents to automate affiliate management - [Authentication](https://docs.affonso.io/cli/authentication.md): Authenticate the Affonso CLI with OAuth or an API key - [Commands](https://docs.affonso.io/cli/commands.md): Full reference for all Affonso CLI commands - [CLI Introduction](https://docs.affonso.io/cli/introduction.md): Manage your Affonso affiliate program from the terminal or through AI agents - [Example Queries](https://docs.affonso.io/mcp/examples.md): Sample prompts and use cases for Affonso MCP - [MCP Introduction](https://docs.affonso.io/mcp/introduction.md): Connect AI assistants directly to your Affonso affiliate data using the Model Context Protocol - [ChatGPT Setup](https://docs.affonso.io/mcp/setup/chatgpt.md): Connect Affonso to ChatGPT using MCP for natural language affiliate management - [Claude Setup](https://docs.affonso.io/mcp/setup/claude.md): Connect Affonso to Claude.ai or Claude Desktop using OAuth or API key - [Cursor Setup](https://docs.affonso.io/mcp/setup/cursor.md): Configure Affonso MCP in Cursor IDE for AI-powered affiliate management - [Other MCP Clients](https://docs.affonso.io/mcp/setup/other-clients.md): Configure Affonso MCP with any MCP-compatible client - [Affiliate Tools](https://docs.affonso.io/mcp/tools/affiliates.md): MCP tools for managing affiliates in your program - [Commission Tools](https://docs.affonso.io/mcp/tools/commissions.md): MCP tools for managing commission transactions - [Payout Tools](https://docs.affonso.io/mcp/tools/payouts.md): MCP tools for managing affiliate payouts - [Referral Tools](https://docs.affonso.io/mcp/tools/referrals.md): MCP tools for tracking referrals, clicks, leads, and conversions - [Affiliate Events](https://docs.affonso.io/webhooks/events/affiliate.md): Webhook events for affiliate lifecycle changes - [Coupon Events](https://docs.affonso.io/webhooks/events/coupon.md): Webhook events for affiliate coupon lifecycle changes - [Payout Events](https://docs.affonso.io/webhooks/events/payout.md): Webhook events for affiliate payouts and payments - [Referral Events](https://docs.affonso.io/webhooks/events/referral.md): Webhook events for referral tracking and conversions - [Transaction Events](https://docs.affonso.io/webhooks/events/transaction.md): Webhook events for sales, commissions, and refunds - [Code Examples](https://docs.affonso.io/webhooks/examples.md): Implementation examples for handling Affonso webhooks - [Webhooks Overview](https://docs.affonso.io/webhooks/introduction.md): Receive real-time notifications when events happen in your affiliate program - [Make (Integromat) Integration](https://docs.affonso.io/webhooks/make.md): Build powerful automations with Affonso webhooks using Make - [n8n Integration](https://docs.affonso.io/webhooks/n8n.md): Self-hosted automation with Affonso webhooks using n8n - [Webhook Setup](https://docs.affonso.io/webhooks/setup.md): Configure webhook endpoints in your Affonso dashboard - [Zapier Integration](https://docs.affonso.io/webhooks/zapier.md): Connect Affonso webhooks to thousands of apps using Zapier ## Optional - [Home](https://affonso.io) - [Blog](https://affonso.io/blog) - [Help Center](https://affonso.io/help)