Affiliate Manager Public API: Overview, Endpoints, and Scopes
The Affiliate Manager Public API lets developers and marketplace app builders run a location's entire affiliate program programmatically. You can manage campaigns, affiliates, referred customers, commissions, payouts, and payout methods through REST APIs, the same data that agencies manage in the Affiliate Manager UI.
The API suite includes 28 new endpoints, plus 4 existing endpoints that were tightened, for 32 endpoints in total. It is available in the v3 API catalog on the Chat To Clients CRM Developer Marketplace.
Key Capabilities
- Manage affiliates without the UI: Onboard, update, activate, and deactivate affiliates from your own app.
- Report on commissions and payouts: Pull commission and payout data into external dashboards, reconciliation, and finance workflows.
- Attribute conversions: Validate referral IDs and create leads from external landing pages and checkout flows, so conversions are credited to the right affiliate.
- Collect payout details in your own flow: Manage affiliate payout methods, including a lookup of the bank fields each country requires.
Who Can Use This Feature
Developers and agencies building custom dashboards, CRM syncs, automated reporting, or partner apps on top of Affiliate Manager.
API Endpoint Groups
All endpoints are available under /affiliate-manager and are organized into seven groups:
| Group | Endpoints | What you can do |
|---|---|---|
| Affiliates | 10 | Create, read, update, and list affiliates. Activate or deactivate an affiliate. Move an affiliate between campaigns. Set and validate referral IDs. Suspend an affiliate from a campaign. Upload a tax form. |
| Payout Methods | 6 | Create, read, update, and delete an affiliate's payout methods. Mark a payout method as primary. Look up the bank fields required for each country. |
| Commissions | 5 | Create, list, and delete commissions. Update commission status. Deny commissions. |
| Customers | 5 | List the customers an affiliate referred. Create and validate leads. Update a customer's state. Delete a customer. |
| Affiliate Media | 3 | List, update, and delete the marketing media attached to affiliates. |
| Campaigns | 2 | List campaigns and fetch a single campaign with its commission structure. |
| Payouts | 1 | List payouts for a location. |
Authentication and Scopes
The APIs use standard v3 OAuth 2.0 with Location-Access. Two scopes control what your app can do:
- affiliate-manager.readonly: Required for the 12 endpoints that read data.
- affiliate-manager.write: Required for the 20 endpoints that create, update, or delete data.
How to Get Started
- Open the Affiliate Manager API (v3) documentation in the Chat To Clients CRM Developer Marketplace: Affiliate Manager API v3.
- Create or open your app in the Developer Marketplace and enable the affiliate-manager.readonly and/or affiliate-manager.write scopes, depending on what your app needs to do.
- Authorize your app for a location using OAuth 2.0 with Location-Access.
- Call the endpoints for the group you need. Each group has its own reference page with request and response details:
Common Use Cases
- Build a custom affiliate dashboard for your clients.
- Sync affiliates, commissions, and payouts with your CRM or finance tools.
- Onboard affiliates from your own signup flow, including collecting their payout details.
- Attribute leads and sales from external landing pages and checkout flows back to the right affiliate.
Frequently Asked Questions
Do I need an app in the Developer Marketplace to use these APIs?
The APIs use v3 OAuth 2.0 with Location-Access, so your integration needs to be authorized for the location whose affiliate data it accesses.
Where can I find request and response examples?
In the Affiliate Manager section of the Chat To Clients CRM API documentation linked above. Each endpoint group has its own reference page.