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.
Global options These options are available on every command:
Option Description --jsonOutput as JSON --api-key <key>API key for this request --base-url <url>Custom API base URL --no-colorDisable colored output --versionShow version --helpShow help
Affiliates Manage your affiliate partners.
affonso affiliates list [--status pending | approved | rejected] [--search < quer y > ] [--limit < n > ] [--page < n > ] affonso affiliates get < i d > affonso affiliates create --name < nam e > --email < emai l > --program-id < i d > affonso affiliates update < i d > [--name < nam e > ] [--status < statu s > ] [--email < emai l > ] affonso affiliates delete < i d >
Example: List pending affiliates
affonso affiliates list --status pending --json
Example: Approve an affiliate
affonso affiliates update aff_123 --status approved
Referrals Track clicks, leads, and conversions.
affonso referrals list [--affiliate-id < i d > ] [--status < statu s > ] [--limit < n > ] affonso referrals get < i d > affonso referrals create --email < emai l > --affiliate-id < i d > affonso referrals update < i d > [--status < statu s > ] [--email < emai l > ] affonso referrals delete < i d >
Commissions Manage commission transactions.
affonso commissions list [--status < statu s > ] [--affiliate-id < i d > ] [--limit < n > ] [--page < n > ] affonso commissions get < i d > affonso commissions create --referral-id < i d > --sale-amount < n > --sale-amount-currency < cod e > --commission-amount < n > --commission-currency < cod e > affonso commissions update < i d > [--status < statu s > ] [--sale-amount < n > ] affonso commissions delete < i d >
Coupons Create and manage affiliate coupons.
affonso coupons list [--affiliate-id < i d > ] [--search < quer y > ] affonso coupons get < i d > affonso coupons create --affiliate-id < i d > --code < cod e > --discount-type < typ e > --discount-value < n > --duration < du r > affonso coupons delete < i d >
Payouts Process and track affiliate payouts.
affonso payouts list [--status < statu s > ] [--affiliate-id < i d > ] affonso payouts get < i d > affonso payouts update < i d > --status < statu s >
Clicks Track affiliate link clicks.
affonso clicks create --program-id < i d > --tracking-id < i d > [--referrer < ur l > ] [--utm-source < va l > ]
Embed tokens Generate tokens for embedded affiliate dashboards.
affonso embed-tokens create [--affiliate-id < i d > ] [--email < emai l > ]
Program settings Configure your affiliate program.
affonso program get affonso program update [--name < nam e > ] [--access-mode < mod e > ]
Sub-resources # Payment terms affonso program payment-terms get affonso program payment-terms update [options] # Tracking affonso program tracking get affonso program tracking update [options] # Restrictions affonso program restrictions get affonso program restrictions update [options] # Fraud rules affonso program fraud-rules get affonso program fraud-rules update [options] # Portal affonso program portal get affonso program portal update [options] # Notifications affonso program notifications list affonso program notifications update < i d > [options] # Groups affonso program groups list affonso program groups get < i d > affonso program groups create [options] affonso program groups update < i d > [options] affonso program groups delete < i d > # Creatives affonso program creatives list affonso program creatives get < i d > affonso program creatives create [options] affonso program creatives update < i d > [options] affonso program creatives delete < i d >
Marketplace Browse public affiliate programs. No authentication required.
affonso marketplace list [--category < ca t > ] [--search < quer y > ] affonso marketplace get < i d >
Config Manage local CLI configuration.
affonso config get < ke y > # api-key, base-url affonso config set < ke y > < valu e >
