delete_affiliate_prospect
Delete Affiliate Prospect
Permanently delete an affiliate prospect. This action cannot be undone.
delete_affiliate_prospect
Permanently delete an affiliate prospect. This action cannot be undone.
create_conversion
Create a new conversion (sale/transaction) in Tapfiliate. Attribute the conversion via referral code, coupon code, click ID, customer ID, tracking ID, or asset/source ID. Supports setting amounts, currencies, external IDs, and metadata.
create_customer
Create a new referred customer in Tapfiliate. Customers are tracked for recurring/lifetime commission attribution — each subsequent conversion for the customer will be attributed to the original referring affiliate.
list_customers
List referred customers with optional filters by program, customer ID, affiliate, and date range. Results are paginated (25 per page).
manage_affiliate_group
Assign an affiliate to a group or remove them from their current group. Groups are used to organize affiliates and can apply different commission rates.
create_affiliate_prospect
Create a potential affiliate prospect. Prospects are promoted to full affiliates once they generate a conversion or customer. Optionally assign them to a program or group.
manage_mlm_parent
Set or remove a parent-child relationship between affiliates for multi-level marketing (MLM). The parent affiliate earns commissions from the child affiliate's conversions based on the MLM levels configured in the program.
list_affiliate_groups
List all affiliate groups. Groups are used to organize affiliates and can apply different commission rates or rules.
create_affiliate_group
Create a new affiliate group for organizing affiliates with shared commission rules or management purposes.
create_affiliate
Create a new affiliate in Tapfiliate. Register affiliates with their personal information, company details, and optional metadata. The affiliate will receive a unique referral link.
list_conversions
List conversions with optional filters by program, affiliate, external ID, pending status, and date range. Results are paginated (25 per page).
list_clicks
List tracked clicks with optional filters by affiliate, program, asset, source, and date range. Results are paginated (25 per page).
update_conversion
Update an existing conversion's amount, external ID, or metadata. Commissions can be optionally recalculated when the amount changes (e.g., for partial refunds).
create_payment
Create a payment to settle an affiliate's balance. This marks approved commissions as paid.
cancel_payment
Cancel a payment, reversing the settled commissions back to the affiliate's balance.
get_conversion
Retrieve detailed information about a specific conversion, including its commissions, affiliate, program, and metadata.
list_programs
List all affiliate programs. Programs define commission structures, landing pages, and affiliate relationships. Programs are read-only through the API.
list_program_affiliates
List all affiliates enrolled in a specific program. Results are paginated (25 per page).
list_payments
List payment history with optional filters by affiliate and date range. Results are paginated (25 per page).
manage_program_affiliate
Add, approve, disapprove, or update an affiliate within a program. Use this to manage the relationship between affiliates and programs, including approval status and coupon assignments.
update_affiliate_metadata
Set or replace metadata on an affiliate. Metadata is stored as key-value pairs. When replacing all metadata, any existing keys not included will be removed.
delete_customer
Permanently delete a customer record from Tapfiliate. This action cannot be undone.
update_commission
Update a commission's amount or comment. The comment will be visible to the affiliate.
get_commission
Retrieve detailed information about a specific commission including its amount, approval status, associated affiliate, and payout details.
get_affiliate
Retrieve detailed information about a specific affiliate including their personal data, referral links, programs, and metadata.
delete_conversion
Permanently delete a conversion and its associated commissions. This action cannot be undone.
get_program
Retrieve detailed information about a specific affiliate program, including its commission types, MLM levels, and bonuses.
add_commission_to_conversion
Add additional commission(s) to an existing conversion. Useful for recurring subscription payments where each payment generates a new commission on the original conversion.
update_affiliate_group
Update an existing affiliate group's title.
delete_affiliate
Permanently delete an affiliate from Tapfiliate. This action cannot be undone.
list_commissions
List commissions with optional filters by program, affiliate, approval status, pending status, and date range. Results are paginated (25 per page).
disapprove_commission
Disapprove a commission, typically used when an order is canceled or refunded. The commission will not be paid out.
list_balances
View affiliate balances across all affiliates or for a specific affiliate. Balances reflect approved commissions that are pending payment. Supports multi-currency.
approve_commission
Approve a pending commission, making it eligible for payout to the affiliate.
get_customer
Retrieve detailed information about a specific customer, including their status, referring affiliate, program, and metadata.
list_affiliates
List affiliates with optional filters. Supports filtering by email, referral code, click ID, source ID, parent ID, or affiliate group. Results are paginated (25 per page).
update_customer_status
Cancel or uncancel a customer. Canceling a customer stops future commission generation for that customer. Uncanceling restores them to their appropriate status.
list_affiliate_prospects
List potential affiliate prospects with optional program filtering. Results are paginated (25 per page).
create_click
Create a click programmatically for REST-only integrations (without JavaScript tracking). This is used to attribute conversions when the standard JavaScript tracking snippet is not available.
manage_affiliate_payout_method
Get or set the payout method for an affiliate. Supports retrieving the current payout method or setting a new one (e.g., PayPal).
Manage affiliate marketing programs, track conversions, and handle affiliate payments. Create and organize affiliates into groups, track clicks and conversions attributed via referral codes or coupons, manage commissions with approval workflows, and process affiliate payouts. Supports customer lifecycle tracking for recurring commissions, multi-level marketing (MLM) structures, and attaching custom meta data to affiliates, customers, and conversions.
Common questions about connecting Tapfiliate to AI agents with Metorial.