Overview
The affiliate tools allow you to manage your affiliate users through natural language commands. All tools support both Markdown and JSON response formats.Available Tools
| Tool | Description | Permission |
|---|---|---|
affonso_list_affiliates | List affiliates with filtering and pagination | read:affiliates |
affonso_get_affiliate | Get a single affiliate by ID | read:affiliates |
affonso_create_affiliate | Create a new affiliate | write:affiliates |
affonso_update_affiliate | Update an existing affiliate | write:affiliates |
affonso_delete_affiliate | Delete an affiliate | delete:affiliates |
affonso_list_affiliates
List and search affiliates with powerful filtering options.Parameters
Page number for pagination
Number of results per page (max 100)
Search by name, email, or tracking ID
Filter by partnership status:
APPROVED, PENDING, REJECTEDSort field:
createdAt, name, emailSort order:
asc or descResponse format:
markdown or jsonExample Prompts
Response
affonso_get_affiliate
Retrieve detailed information about a specific affiliate.Parameters
The affiliate ID (starts with
aff_)Include related data:
promoCodes, commissionOverrides, invoiceDetails, payoutMethod, onboardingResponsesResponse format:
markdown or jsonExample Prompts
Response
affonso_create_affiliate
Create a new affiliate in your program.Parameters
Affiliate’s email address
Affiliate’s display name
Custom tracking ID (auto-generated if not provided)
Initial partnership status:
APPROVED, PENDINGResponse format:
markdown or jsonExample Prompts
Response
affonso_update_affiliate
Update an existing affiliate’s information.Parameters
The affiliate ID to update
New display name
New email address
New partnership status:
APPROVED, PENDING, REJECTEDResponse format:
markdown or jsonExample Prompts
Response
affonso_delete_affiliate
Parameters
The affiliate ID to delete
Response format:
markdown or jsonExample Prompts
Response
Error Handling
Common errors you may encounter:| Error | Cause | Solution |
|---|---|---|
NOT_FOUND | Affiliate ID doesn’t exist | Verify the ID is correct |
DUPLICATE_ERROR | Email already exists | Use a different email |
PERMISSION_DENIED | Missing required scope | Check your API key permissions |
VALIDATION_ERROR | Invalid parameter value | Check parameter format |