Skip to main content
Tapfiliate logo
  • Category: marketing automation
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 40
  • Triggers: 0
  • Slug: TAPFILIATE
  • Version: 20261101_00

Tools

Slug: TAPFILIATE_AFFILIATES_RETRIEVE_AN_AFFILIATERetrieve selected details of an affiliate by affiliate ID, including name, email, company name, metadata, and creation time.

Input Parameters

string
required
Unique identifier of the affiliate to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAPFILIATE_CANCEL_PAYMENTTool to cancel a specific payment. Use when you need to cancel a payment by its payment_id.

Input Parameters

string
required
Unique identifier of the payment to cancel.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAPFILIATE_COMMISSIONS_LIST_ALL_COMMISSIONSList commission records with optional filters and pagination. Use the affiliate and approval status filters to narrow results, and request further pages as needed.

Input Parameters

integer
Page number to retrieve; must be >=1. Defaults to first page
string
Filter by commission status (e.g., approved, pending)
integer
Number of items per page; must be >=1
string
Only return commissions belonging to this program
string
Only return commissions belonging to this affiliate
string
Only return commissions for this conversion
string
ISO 8601 timestamp; include commissions created at or before this time
string
ISO 8601 timestamp; include commissions created at or after this time

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAPFILIATE_CREATE_AFFILIATECreate a new affiliate account with contact details. The affiliate is archived until added to a program.

Input Parameters

string
required
Email address of the affiliate
object
Address details for an affiliate.
object
Company details for an affiliate.
string
required
Last name of the affiliate
string
required
First name of the affiliate
object
Optional custom metadata fields

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAPFILIATE_CREATE_AFFILIATE_GROUPTool to create a new affiliate group. Use when you need to organize affiliates into groups for management purposes.

Input Parameters

string
required
The title/name of the affiliate group to create.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAPFILIATE_CREATE_AFFILIATE_NOTETool to create a note for an affiliate. Use when you need to add a note or comment to an affiliate’s profile.

Input Parameters

string
required
The content/text of the note to be created.
string
required
The identifier for the affiliate to attach the note to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAPFILIATE_CREATE_AFFILIATE_PROSPECTCreate an affiliate prospect to register a potential affiliate before they become a full affiliate. Provide the prospect’s name and email; the returned record can include a referral link.

Input Parameters

string
required
Email address of the affiliate prospect (must be unique).
string
Address of the affiliate prospect.
string
Company name of the affiliate prospect.
string
required
Last name of the affiliate prospect.
string
required
First name of the affiliate prospect.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAPFILIATE_DELETE_AFFILIATE_META_DATATool to delete metadata by key for an affiliate. Use when you need to remove a specific metadata field from an affiliate’s profile.

Input Parameters

string
required
The metadata key to delete.
string
required
The affiliate’s unique identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAPFILIATE_DELETE_AFFILIATE_PROSPECTTool to delete a specific affiliate prospect. Use when you need to remove an affiliate prospect by their affiliate_prospect_id.

Input Parameters

string
required
The unique identifier of the affiliate prospect to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAPFILIATE_DELETE_AN_AFFILIATETool to delete a specific affiliate. Use when you need to remove an affiliate by their affiliate_id after confirming it exists.

Input Parameters

string
required
Unique identifier of the affiliate to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAPFILIATE_GET_AFFILIATE_BALANCESTool to retrieve an affiliate’s balances across multiple currencies. Use when you need to check an affiliate’s current balance state.

Input Parameters

string
required
Unique identifier of the affiliate to retrieve balances for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAPFILIATE_GET_AFFILIATE_META_DATA_BY_KEYTool to retrieve specific metadata value by key for an affiliate. Use when you need to fetch a single custom metadata field.

Input Parameters

string
required
The metadata key to retrieve.
string
required
Unique identifier of the affiliate.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAPFILIATE_GET_AFFILIATE_PROSPECTRetrieve details of a specific Tapfiliate affiliate prospect by prospect ID. Use this to inspect the prospect’s information and referral link.

Input Parameters

string
required
Unique identifier of the affiliate prospect to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAPFILIATE_GET_PROGRAMTool to retrieve details of a specific program. Use when you have the program_id and need full program information.

Input Parameters

string
required
The unique identifier of the program to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAPFILIATE_LIST_AFFILIATE_CUSTOM_FIELDSList the custom field definitions configured for affiliate profiles in Tapfiliate. Use this to discover the fields available for affiliates.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAPFILIATE_LIST_AFFILIATE_GROUPSList the first page of affiliate groups in your Tapfiliate account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAPFILIATE_LIST_AFFILIATE_META_DATATool to retrieve metadata for a specific affiliate. Use when you need to fetch custom metadata key-value pairs associated with an affiliate.

Input Parameters

string
required
The unique identifier of the affiliate to retrieve metadata for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAPFILIATE_LIST_AFFILIATE_NOTESList a page of notes for a specific affiliate by ID. Specify a page to retrieve subsequent results.

Input Parameters

integer
Page number to retrieve, must be >=1. Defaults to first page
integer
Number of items per page, must be >=1
string
required
The unique identifier of the affiliate whose notes to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAPFILIATE_LIST_AFFILIATE_PAYMENTSTool to list all payments for a specific affiliate. Use when you need to retrieve payment records for a particular affiliate by their affiliate_id.

Input Parameters

integer
Page number to retrieve, must be >=1. Defaults to first page
integer
Number of items per page, must be >=1
string
required
The unique identifier of the affiliate (e.g., ‘charlielee3’, ‘janejameson’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAPFILIATE_LIST_AFFILIATE_PROGRAMSList the programs associated with a specified affiliate, including past affiliations. Use this to review the affiliate’s program memberships.

Input Parameters

string
required
Unique identifier of the affiliate to retrieve programs for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAPFILIATE_LIST_AFFILIATE_PROSPECTSList Tapfiliate affiliate prospects, optionally filtering by email, referral code, program, or affiliate group. Results are paginated; specify a page to retrieve further prospects.

Input Parameters

integer
Page number to retrieve, must be >=1. Defaults to first page
string
Filter prospects by email address
string
Filter by affiliate group ID
integer
Number of items per page, must be >=1
string
Filter by specific program ID
string
Filter by affiliate referral code

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAPFILIATE_LIST_ALL_AFFILIATESTool to list all affiliates. Use after confirming API access to fetch affiliates with optional filters.

Input Parameters

integer
Page number to retrieve, must be >=1. Defaults to first page
string
Filter by affiliate email
string
Filter by click ID
integer
Number of items per page, must be >=1
string
Filter by parent affiliate ID
string
Filter by source ID
string
Filter by referral code
string
Filter by affiliate group ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAPFILIATE_LIST_BALANCESTool to list all outstanding affiliate balances. Use when you need to retrieve balance records for affiliates, typically before processing payments.

Input Parameters

integer
Page number to retrieve, must be >=1. Default is 25 items per page

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAPFILIATE_LIST_CONVERSIONSTool to list all conversions. Use to fetch conversion records with optional filters for program, affiliate, date range, and pending status.

Input Parameters

integer
Page number for pagination; must be >=1. Defaults to first page
string
Filter conversions up to this date (ISO 8601 format or YYYY-MM-DD)
boolean
Filter by pending status (true for pending conversions, false for non-pending)
string
Filter conversions from this date (ISO 8601 format or YYYY-MM-DD)
string
Filter conversions by program ID
string
Filter conversions by external ID (merchant’s order reference)
string
Filter conversions by affiliate ID
boolean
Use profile timezone for date filtering instead of UTC

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAPFILIATE_LIST_CUSTOMERSTool to list all customers with optional filtering by program, customer ID, affiliate, or date range. Use after verifying API credentials to fetch customer records.

Input Parameters

integer
Page number to retrieve, must be >=1. Defaults to first page
string
Filter by end date in YYYY-MM-DD format
integer
Number of items per page, must be >=1
string
Filter by start date in YYYY-MM-DD format
string
Filter by program ID
string
Filter by customer ID from your system
string
Filter by affiliate ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAPFILIATE_LIST_PROGRAM_AFFILIATESList a page of affiliates in a specific program, with optional filters for source ID, email, parent ID, or affiliate group ID.

Input Parameters

integer
Page number to retrieve, must be >=1. Defaults to first page
string
Filter by affiliate email
integer
Number of items per page, must be >=1
string
Filter by parent affiliate ID
string
Filter by source ID
string
required
The program identifier to list affiliates from
string
Filter by affiliate group ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAPFILIATE_LIST_PROGRAM_BONUSESList a page of performance bonuses configured for a specified program. Select a page to review further bonus records.

Input Parameters

integer
Page number to retrieve, must be >=1. Defaults to first page
integer
Number of items per page, must be >=1
string
required
The unique identifier of the program to list bonuses for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAPFILIATE_LIST_PROGRAM_COMMISSION_TYPESList commission types for a specific program. The request returns the first page of results.

Input Parameters

string
required
The unique identifier of the program to list commission types for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAPFILIATE_LIST_PROGRAM_MLM_LEVELSList the MLM levels configured for a specified program. Use this to review the program’s multi-level marketing commission structure.

Input Parameters

string
required
The ID of the program to retrieve MLM levels for. Uses kebab-case format (e.g., ‘johns-affiliate-program’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAPFILIATE_PAYMENTS_CREATE_A_PAYMENTCreate a Tapfiliate payment record for an affiliate after payment has been made through a payment provider.

Input Parameters

number
required
The payment amount, must be greater than 0.
string
required
Three-letter ISO 4217 currency code for the payment.
string
required
The ID of the affiliate to receive the payment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAPFILIATE_PAYMENTS_LIST_ALL_PAYMENTSTool to list all payments. Use when you need to retrieve paginated payment records after confirming API credentials.

Input Parameters

integer
Page number to retrieve, must be >=1
integer
Number of items per page, must be >=1

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAPFILIATE_PAYMENTS_RETRIEVE_A_PAYMENTTool to retrieve details of a specific payment. Use when you have the payment_id and need full payment information.

Input Parameters

string
required
Unique identifier of the payment to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAPFILIATE_PAYOUT_METHODS_LIST_ALL_PAYOUT_METHODSList the payout methods configured for a specified affiliate. Use this to review the affiliate’s available payment options and their details.

Input Parameters

string
required
Tapfiliate-generated ID of the affiliate whose payout methods to list

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAPFILIATE_PROGRAMS_LIST_ALL_PROGRAMSList the first page of programs, optionally filtered by asset ID.

Input Parameters

string
Filter programs by asset ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAPFILIATE_REMOVE_AFFILIATE_GROUPTool to remove affiliate group from an affiliate. Use when you need to unassign an affiliate from their current group, setting their affiliate_group_id to null.

Input Parameters

string
required
Unique identifier of the affiliate to remove the group from.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAPFILIATE_SET_AFFILIATE_GROUPTool to set the affiliate group for a specific affiliate. Use when you need to assign or change an affiliate’s group membership.

Input Parameters

string
required
The unique identifier of the affiliate group to assign to the affiliate.
string
required
The unique identifier of the affiliate to set the group for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAPFILIATE_SET_AFFILIATE_META_DATATool to update (replace) metadata for an affiliate. Use when you need to set custom metadata fields for a specific affiliate by their affiliate_id.

Input Parameters

object
required
JSON object containing metadata key-value pairs to set or update for the affiliate. This performs a full replacement of the affiliate’s metadata.
string
required
Unique identifier of the affiliate whose metadata will be updated.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAPFILIATE_SET_AFFILIATE_META_DATA_BY_KEYTool to set or update a specific metadata field for an affiliate by key. Use when you need to store custom data associated with an affiliate.

Input Parameters

string
required
The metadata key to set. This is the field name for the metadata entry.
string
required
The metadata value to set for the specified key.
string
required
Unique identifier of the affiliate to update metadata for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAPFILIATE_SET_AFFILIATE_PARENTTool to set a parent affiliate relationship for a child affiliate. Use when you need to create a hierarchical affiliate structure by assigning a parent to a child affiliate.

Input Parameters

string
required
The ID of the parent affiliate to assign to the child.
string
required
The ID of the child affiliate whose parent relationship will be set.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAPFILIATE_UPDATE_AFFILIATE_GROUPUpdate the title of an existing affiliate group.

Input Parameters

string
required
The new title/name for the affiliate group.
string
required
The unique identifier of the affiliate group to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not