> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Tapfiliate

> Tapfiliate is an affiliate and referral tracking platform that enables businesses to create, track, and scale their affiliate programs efficiently.

![Tapfiliate logo](https://mintcdn.com/composio-preview/IA0_SoMcsWt17HEC/images/toolkits/tapfiliate.svg?fit=max\&auto=format\&n=IA0_SoMcsWt17HEC\&q=85\&s=55a31f7dd47bf59f0511b8404930d667)

* **Category:** marketing automation
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 40
* **Triggers:** 0
* **Slug:** `TAPFILIATE`
* **Version:** 20261101\_00

## Tools

> [accordion] Retrieve an Affiliate
>
> **Slug:** `TAPFILIATE_AFFILIATES_RETRIEVE_AN_AFFILIATE`
>
> Retrieve selected details of an affiliate by affiliate ID, including name, email, company name, metadata, and creation time.
>
> #### Input Parameters
>
> **affiliate\_id** `string` *required*
>
> Unique identifier of the affiliate to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Cancel a Payment
>
> **Slug:** `TAPFILIATE_CANCEL_PAYMENT`
>
> Tool to cancel a specific payment. Use when you need to cancel a payment by its payment\_id.
>
> #### Input Parameters
>
> **payment\_id** `string` *required*
>
> Unique identifier of the payment to cancel.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List all commissions
>
> **Slug:** `TAPFILIATE_COMMISSIONS_LIST_ALL_COMMISSIONS`
>
> List 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
>
> **page** `integer`
>
> Page number to retrieve; must be >=1. Defaults to first page
>
> **status** `string`
>
> Filter by commission status (e.g., approved, pending)
>
> **per\_page** `integer`
>
> Number of items per page; must be >=1
>
> **program\_id** `string`
>
> Only return commissions belonging to this program
>
> **affiliate\_id** `string`
>
> Only return commissions belonging to this affiliate
>
> **conversion\_id** `string`
>
> Only return commissions for this conversion
>
> **created\_at\_to** `string`
>
> ISO 8601 timestamp; include commissions created at or before this time
>
> **created\_at\_from** `string`
>
> ISO 8601 timestamp; include commissions created at or after this time
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create an Affiliate
>
> **Slug:** `TAPFILIATE_CREATE_AFFILIATE`
>
> Create a new affiliate account with contact details. The affiliate is archived until added to a program.
>
> #### Input Parameters
>
> **email** `string` *required*
>
> Email address of the affiliate
>
> **address** `object`
>
> Address details for an affiliate.
>
> **company** `object`
>
> Company details for an affiliate.
>
> **lastname** `string` *required*
>
> Last name of the affiliate
>
> **firstname** `string` *required*
>
> First name of the affiliate
>
> **meta\_data** `object`
>
> Optional custom metadata fields
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Affiliate Group
>
> **Slug:** `TAPFILIATE_CREATE_AFFILIATE_GROUP`
>
> Tool to create a new affiliate group. Use when you need to organize affiliates into groups for management purposes.
>
> #### Input Parameters
>
> **title** `string` *required*
>
> The title/name of the affiliate group to create.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Affiliate Note
>
> **Slug:** `TAPFILIATE_CREATE_AFFILIATE_NOTE`
>
> Tool to create a note for an affiliate. Use when you need to add a note or comment to an affiliate's profile.
>
> #### Input Parameters
>
> **message** `string` *required*
>
> The content/text of the note to be created.
>
> **affiliate\_id** `string` *required*
>
> The identifier for the affiliate to attach the note to.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Affiliate Prospect
>
> **Slug:** `TAPFILIATE_CREATE_AFFILIATE_PROSPECT`
>
> Create 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
>
> **email** `string` *required*
>
> Email address of the affiliate prospect (must be unique).
>
> **address** `string`
>
> Address of the affiliate prospect.
>
> **company** `string`
>
> Company name of the affiliate prospect.
>
> **lastname** `string` *required*
>
> Last name of the affiliate prospect.
>
> **firstname** `string` *required*
>
> First name of the affiliate prospect.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete affiliate meta data
>
> **Slug:** `TAPFILIATE_DELETE_AFFILIATE_META_DATA`
>
> Tool 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
>
> **key** `string` *required*
>
> The metadata key to delete.
>
> **affiliate\_id** `string` *required*
>
> The affiliate's unique identifier.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete an affiliate prospect
>
> **Slug:** `TAPFILIATE_DELETE_AFFILIATE_PROSPECT`
>
> Tool to delete a specific affiliate prospect. Use when you need to remove an affiliate prospect by their affiliate\_prospect\_id.
>
> #### Input Parameters
>
> **affiliate\_prospect\_id** `string` *required*
>
> The unique identifier of the affiliate prospect to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete an affiliate
>
> **Slug:** `TAPFILIATE_DELETE_AN_AFFILIATE`
>
> Tool to delete a specific affiliate. Use when you need to remove an affiliate by their affiliate\_id after confirming it exists.
>
> #### Input Parameters
>
> **affiliate\_id** `string` *required*
>
> Unique identifier of the affiliate to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Affiliate Balances
>
> **Slug:** `TAPFILIATE_GET_AFFILIATE_BALANCES`
>
> Tool to retrieve an affiliate's balances across multiple currencies. Use when you need to check an affiliate's current balance state.
>
> #### Input Parameters
>
> **affiliate\_id** `string` *required*
>
> Unique identifier of the affiliate to retrieve balances for.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Affiliate Meta Data by Key
>
> **Slug:** `TAPFILIATE_GET_AFFILIATE_META_DATA_BY_KEY`
>
> Tool to retrieve specific metadata value by key for an affiliate. Use when you need to fetch a single custom metadata field.
>
> #### Input Parameters
>
> **key** `string` *required*
>
> The metadata key to retrieve.
>
> **affiliate\_id** `string` *required*
>
> Unique identifier of the affiliate.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Affiliate Prospect
>
> **Slug:** `TAPFILIATE_GET_AFFILIATE_PROSPECT`
>
> Retrieve details of a specific Tapfiliate affiliate prospect by prospect ID. Use this to inspect the prospect's information and referral link.
>
> #### Input Parameters
>
> **affiliate\_prospect\_id** `string` *required*
>
> Unique identifier of the affiliate prospect to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Retrieve a Program
>
> **Slug:** `TAPFILIATE_GET_PROGRAM`
>
> Tool to retrieve details of a specific program. Use when you have the program\_id and need full program information.
>
> #### Input Parameters
>
> **program\_id** `string` *required*
>
> The unique identifier of the program to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List affiliate custom fields
>
> **Slug:** `TAPFILIATE_LIST_AFFILIATE_CUSTOM_FIELDS`
>
> List the custom field definitions configured for affiliate profiles in Tapfiliate. Use this to discover the fields available for affiliates.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List all affiliate groups
>
> **Slug:** `TAPFILIATE_LIST_AFFILIATE_GROUPS`
>
> List the first page of affiliate groups in your Tapfiliate account.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Affiliate Meta Data
>
> **Slug:** `TAPFILIATE_LIST_AFFILIATE_META_DATA`
>
> Tool to retrieve metadata for a specific affiliate. Use when you need to fetch custom metadata key-value pairs associated with an affiliate.
>
> #### Input Parameters
>
> **affiliate\_id** `string` *required*
>
> The unique identifier of the affiliate to retrieve metadata for.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List affiliate notes
>
> **Slug:** `TAPFILIATE_LIST_AFFILIATE_NOTES`
>
> List a page of notes for a specific affiliate by ID. Specify a page to retrieve subsequent results.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number to retrieve, must be >=1. Defaults to first page
>
> **per\_page** `integer`
>
> Number of items per page, must be >=1
>
> **affiliate\_id** `string` *required*
>
> The unique identifier of the affiliate whose notes to retrieve
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List affiliate's payments
>
> **Slug:** `TAPFILIATE_LIST_AFFILIATE_PAYMENTS`
>
> Tool 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
>
> **page** `integer`
>
> Page number to retrieve, must be >=1. Defaults to first page
>
> **per\_page** `integer`
>
> Number of items per page, must be >=1
>
> **affiliate\_id** `string` *required*
>
> The unique identifier of the affiliate (e.g., 'charlielee3', 'janejameson')
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Affiliate Programs
>
> **Slug:** `TAPFILIATE_LIST_AFFILIATE_PROGRAMS`
>
> List the programs associated with a specified affiliate, including past affiliations. Use this to review the affiliate's program memberships.
>
> #### Input Parameters
>
> **affiliate\_id** `string` *required*
>
> Unique identifier of the affiliate to retrieve programs for.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Affiliate Prospects
>
> **Slug:** `TAPFILIATE_LIST_AFFILIATE_PROSPECTS`
>
> List 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
>
> **page** `integer`
>
> Page number to retrieve, must be >=1. Defaults to first page
>
> **email** `string`
>
> Filter prospects by email address
>
> **group\_id** `string`
>
> Filter by affiliate group ID
>
> **per\_page** `integer`
>
> Number of items per page, must be >=1
>
> **program\_id** `string`
>
> Filter by specific program ID
>
> **referral\_code** `string`
>
> Filter by affiliate referral code
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List all affiliates
>
> **Slug:** `TAPFILIATE_LIST_ALL_AFFILIATES`
>
> Tool to list all affiliates. Use after confirming API access to fetch affiliates with optional filters.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number to retrieve, must be >=1. Defaults to first page
>
> **email** `string`
>
> Filter by affiliate email
>
> **click\_id** `string`
>
> Filter by click ID
>
> **per\_page** `integer`
>
> Number of items per page, must be >=1
>
> **parent\_id** `string`
>
> Filter by parent affiliate ID
>
> **source\_id** `string`
>
> Filter by source ID
>
> **referral\_code** `string`
>
> Filter by referral code
>
> **affiliate\_group\_id** `string`
>
> Filter by affiliate group ID
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List all balances
>
> **Slug:** `TAPFILIATE_LIST_BALANCES`
>
> Tool to list all outstanding affiliate balances. Use when you need to retrieve balance records for affiliates, typically before processing payments.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number to retrieve, must be >=1. Default is 25 items per page
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List conversions
>
> **Slug:** `TAPFILIATE_LIST_CONVERSIONS`
>
> Tool to list all conversions. Use to fetch conversion records with optional filters for program, affiliate, date range, and pending status.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number for pagination; must be >=1. Defaults to first page
>
> **date\_to** `string`
>
> Filter conversions up to this date (ISO 8601 format or YYYY-MM-DD)
>
> **pending** `boolean`
>
> Filter by pending status (true for pending conversions, false for non-pending)
>
> **date\_from** `string`
>
> Filter conversions from this date (ISO 8601 format or YYYY-MM-DD)
>
> **program\_id** `string`
>
> Filter conversions by program ID
>
> **external\_id** `string`
>
> Filter conversions by external ID (merchant's order reference)
>
> **affiliate\_id** `string`
>
> Filter conversions by affiliate ID
>
> **use\_profile\_timezone** `boolean`
>
> Use profile timezone for date filtering instead of UTC
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List all customers
>
> **Slug:** `TAPFILIATE_LIST_CUSTOMERS`
>
> Tool 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
>
> **page** `integer`
>
> Page number to retrieve, must be >=1. Defaults to first page
>
> **date\_to** `string`
>
> Filter by end date in YYYY-MM-DD format
>
> **per\_page** `integer`
>
> Number of items per page, must be >=1
>
> **date\_from** `string`
>
> Filter by start date in YYYY-MM-DD format
>
> **program\_id** `string`
>
> Filter by program ID
>
> **customer\_id** `string`
>
> Filter by customer ID from your system
>
> **affiliate\_id** `string`
>
> Filter by affiliate ID
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List program affiliates
>
> **Slug:** `TAPFILIATE_LIST_PROGRAM_AFFILIATES`
>
> List a page of affiliates in a specific program, with optional filters for source ID, email, parent ID, or affiliate group ID.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number to retrieve, must be >=1. Defaults to first page
>
> **email** `string`
>
> Filter by affiliate email
>
> **per\_page** `integer`
>
> Number of items per page, must be >=1
>
> **parent\_id** `string`
>
> Filter by parent affiliate ID
>
> **source\_id** `string`
>
> Filter by source ID
>
> **program\_id** `string` *required*
>
> The program identifier to list affiliates from
>
> **affiliate\_group\_id** `string`
>
> Filter by affiliate group ID
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List program bonuses
>
> **Slug:** `TAPFILIATE_LIST_PROGRAM_BONUSES`
>
> List a page of performance bonuses configured for a specified program. Select a page to review further bonus records.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number to retrieve, must be >=1. Defaults to first page
>
> **per\_page** `integer`
>
> Number of items per page, must be >=1
>
> **program\_id** `string` *required*
>
> The unique identifier of the program to list bonuses for.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List program commission types
>
> **Slug:** `TAPFILIATE_LIST_PROGRAM_COMMISSION_TYPES`
>
> List commission types for a specific program. The request returns the first page of results.
>
> #### Input Parameters
>
> **program\_id** `string` *required*
>
> The unique identifier of the program to list commission types for.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List program MLM levels
>
> **Slug:** `TAPFILIATE_LIST_PROGRAM_MLM_LEVELS`
>
> List the MLM levels configured for a specified program. Use this to review the program's multi-level marketing commission structure.
>
> #### Input Parameters
>
> **program\_id** `string` *required*
>
> The ID of the program to retrieve MLM levels for. Uses kebab-case format (e.g., 'johns-affiliate-program').
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create a Payment
>
> **Slug:** `TAPFILIATE_PAYMENTS_CREATE_A_PAYMENT`
>
> Create a Tapfiliate payment record for an affiliate after payment has been made through a payment provider.
>
> #### Input Parameters
>
> **amount** `number` *required*
>
> The payment amount, must be greater than 0.
>
> **currency** `string` *required*
>
> Three-letter ISO 4217 currency code for the payment.
>
> **affiliate\_id** `string` *required*
>
> The ID of the affiliate to receive the payment.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List all payments
>
> **Slug:** `TAPFILIATE_PAYMENTS_LIST_ALL_PAYMENTS`
>
> Tool to list all payments. Use when you need to retrieve paginated payment records after confirming API credentials.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number to retrieve, must be >=1
>
> **per\_page** `integer`
>
> Number of items per page, must be >=1
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Retrieve a Payment
>
> **Slug:** `TAPFILIATE_PAYMENTS_RETRIEVE_A_PAYMENT`
>
> Tool to retrieve details of a specific payment. Use when you have the payment\_id and need full payment information.
>
> #### Input Parameters
>
> **payment\_id** `string` *required*
>
> Unique identifier of the payment to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List all payout methods
>
> **Slug:** `TAPFILIATE_PAYOUT_METHODS_LIST_ALL_PAYOUT_METHODS`
>
> List the payout methods configured for a specified affiliate. Use this to review the affiliate's available payment options and their details.
>
> #### Input Parameters
>
> **affiliate\_id** `string` *required*
>
> Tapfiliate-generated ID of the affiliate whose payout methods to list
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List all programs
>
> **Slug:** `TAPFILIATE_PROGRAMS_LIST_ALL_PROGRAMS`
>
> List the first page of programs, optionally filtered by asset ID.
>
> #### Input Parameters
>
> **asset\_id** `string`
>
> Filter programs by asset ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Remove affiliate group from affiliate
>
> **Slug:** `TAPFILIATE_REMOVE_AFFILIATE_GROUP`
>
> Tool 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
>
> **affiliate\_id** `string` *required*
>
> Unique identifier of the affiliate to remove the group from.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Set Affiliate Group
>
> **Slug:** `TAPFILIATE_SET_AFFILIATE_GROUP`
>
> Tool to set the affiliate group for a specific affiliate. Use when you need to assign or change an affiliate's group membership.
>
> #### Input Parameters
>
> **group\_id** `string` *required*
>
> The unique identifier of the affiliate group to assign to the affiliate.
>
> **affiliate\_id** `string` *required*
>
> The unique identifier of the affiliate to set the group for.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Set Affiliate Meta Data
>
> **Slug:** `TAPFILIATE_SET_AFFILIATE_META_DATA`
>
> Tool 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
>
> **meta\_data** `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.
>
> **affiliate\_id** `string` *required*
>
> Unique identifier of the affiliate whose metadata will be updated.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Set Affiliate Metadata by Key
>
> **Slug:** `TAPFILIATE_SET_AFFILIATE_META_DATA_BY_KEY`
>
> Tool 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
>
> **key** `string` *required*
>
> The metadata key to set. This is the field name for the metadata entry.
>
> **value** `string` *required*
>
> The metadata value to set for the specified key.
>
> **affiliate\_id** `string` *required*
>
> Unique identifier of the affiliate to update metadata for.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Set Affiliate Parent
>
> **Slug:** `TAPFILIATE_SET_AFFILIATE_PARENT`
>
> Tool 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
>
> **affiliate\_id** `string` *required*
>
> The ID of the parent affiliate to assign to the child.
>
> **child\_affiliate\_id** `string` *required*
>
> The ID of the child affiliate whose parent relationship will be set.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Affiliate Group
>
> **Slug:** `TAPFILIATE_UPDATE_AFFILIATE_GROUP`
>
> Update the title of an existing affiliate group.
>
> #### Input Parameters
>
> **title** `string` *required*
>
> The new title/name for the affiliate group.
>
> **affiliate\_group\_id** `string` *required*
>
> The unique identifier of the affiliate group to update.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
