The Tapfiliate connector lets your AI agent act in each user's Tapfiliate account. Each user connects their own Tapfiliate API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 60 tools.
- Tools
- 60
- What they doRead · write · destructive
- 28 · 21 · 1128 read21 write11 destructive
- Users sign in with
- API key
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the Tapfiliate connection
In AgentKit > Connections, create a Tapfiliate connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'tapfiliate'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize Tapfiliate:', link)const rl = createInterface({ input: process.stdin, output: process.stdout })await rl.question('Press Enter after authorizing...')rl.close()// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'tapfiliate_affiliate_groups_list',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "tapfiliate"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize Tapfiliate:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="tapfiliate_affiliate_groups_list",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their Tapfiliate credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_tooltapfiliate_affiliate_balances_getGet what you owe one affiliate per currency: approved commissions minus payments made.Read-onlyGet Affiliate Balances
Get what you owe one affiliate per currency: approved commissions minus payments made. Returns balances by currency. Use tapfiliate_balances_list for all affiliates.
Inputs
affiliate_idstringrequired- Affiliate ID, from tapfiliate_affiliates_list. Example: janejameson.
tapfiliate_affiliate_getGet one affiliate by ID with their contact details, company, address and meta data.Read-onlyGet Affiliate
Get one affiliate by ID with their contact details, company, address and meta data. Returns the affiliate object.
Inputs
affiliate_idstringrequired- Affiliate ID, from tapfiliate_affiliates_list. Example: janejameson.
tapfiliate_affiliate_groups_listList affiliate groups, newest first, 25 per page.Read-onlyList Affiliate Groups
List affiliate groups, newest first, 25 per page. Returns group IDs, titles and affiliate counts.
Inputs
pageinteger- Page number of results, 25 per page, starting at 1. Example: 1.
tapfiliate_affiliate_meta_data_getGet all meta data stored on an affiliate as one key/value object.Read-onlyGet Affiliate Meta Data
Get all meta data stored on an affiliate as one key/value object. Returns the object ({} when empty).
Inputs
affiliate_idstringrequired- Affiliate ID, from tapfiliate_affiliates_list. Example: janejameson.
tapfiliate_affiliate_notes_listList the internal notes your team wrote on an affiliate, newest first.Read-onlyList Affiliate Notes
List the internal notes your team wrote on an affiliate, newest first. Returns notes with message, author and date.
Inputs
affiliate_idstringrequired- Affiliate ID, from tapfiliate_affiliates_list. Example: janejameson.
tapfiliate_affiliate_payments_listList the payments made to one affiliate, newest first, 25 per page, excluding canceled ones.Read-onlyList Affiliate Payments
List the payments made to one affiliate, newest first, 25 per page, excluding canceled ones. Returns payments with amount, currency and date.
Inputs
affiliate_idstringrequired- Affiliate ID, from tapfiliate_affiliates_list. Example: janejameson.
pageinteger- Page number of results, 25 per page, starting at 1. Example: 1.
tapfiliate_affiliate_programs_listList the programs an affiliate belongs to with their approval status, coupon and referral link, 25 per page.Read-onlyList Affiliate Programs
List the programs an affiliate belongs to with their approval status, coupon and referral link, 25 per page. Returns program memberships.
Inputs
affiliate_idstringrequired- Affiliate ID, from tapfiliate_affiliates_list. Example: janejameson.
pageinteger- Page number of results, 25 per page, starting at 1. Example: 1.
tapfiliate_affiliate_prospect_getGet one affiliate prospect by ID with their referral link.Read-onlyGet Affiliate Prospect
Get one affiliate prospect by ID with their referral link. Returns the prospect object.
Inputs
affiliate_prospect_idstringrequired- The id of the affiliate prospect. Example: jimprosper.
tapfiliate_affiliate_prospects_listList affiliate prospects (people you invited who have not signed up), newest first, 25 per page, optionally by email, referral code, program or group.Read-onlyList Affiliate Prospects
List affiliate prospects (people you invited who have not signed up), newest first, 25 per page, optionally by email, referral code, program or group. Returns prospects with their referral link.
Inputs
emailstring- Filter by prospect email address. Example: jane.jameson@example.com.
group_idstring- Affiliate group ID, from tapfiliate_affiliate_groups_list. Example: ag_eXampl3.
pageinteger- Page number of results, 25 per page, starting at 1. Example: 1.
program_idstring- Program ID, from tapfiliate_programs_list. Example: my-program-3.
referral_codestring- An affiliate prospect's referral code. This corresponds to the value of ref= in their referral link. Example: janejameson.
tapfiliate_affiliates_listList affiliates, newest first, 25 per page, optionally filtered by email, referral code, click, source, parent or affiliate group.Read-onlyList Affiliates
List affiliates, newest first, 25 per page, optionally filtered by email, referral code, click, source, parent or affiliate group. Returns affiliates with their name, email and company. Use tapfiliate_affiliate_get for one affiliate.
Inputs
affiliate_group_idstring- Affiliate group ID, from tapfiliate_affiliate_groups_list. Example: ag_eXampl3.
click_idstring- A click id. Example: Y2xpY2tfaWQ.
emailstring- Filter by affiliate email address. Example: jane.jameson@example.com.
pageinteger- Page number of results, 25 per page, starting at 1. Example: 1.
parent_idstring- Return the children of this parent affiliate ID. Example: johnsmith.
referral_codestring- An affiliate's referral code. This corresponds to the value of ref= in their referral link. Example: janejameson.
source_idstring- A source id. Example: 1-aaaaaa.
tapfiliate_balances_listList what you owe each affiliate with a non-zero balance, per currency, optionally excluding affiliates marked as fraud.Read-onlyList Balances
List what you owe each affiliate with a non-zero balance, per currency, optionally excluding affiliates marked as fraud. Returns balances by affiliate. Use it before recording payouts with tapfiliate_payment_create.
Inputs
include_fraudboolean- false leaves out affiliates you marked as fraud. Default: true. Example: false.
tapfiliate_click_getGet one click by ID with device details, country, meta data, affiliate and program.Read-onlyGet Click
Get one click by ID with device details, country, meta data, affiliate and program. Returns the click object.
Inputs
click_idstringrequired- Click ID, from tapfiliate_clicks_list or tapfiliate_click_create. Example: Y2xpY2tfaWQ.
tapfiliate_clicks_listList clicks on your programs, newest first, 25 per page, optionally filtered by program, affiliate or date.Read-onlyList Clicks
List clicks on your programs, newest first, 25 per page, optionally filtered by program, affiliate or date. Returns clicks with device, country and meta data. Use tapfiliate_click_get for one click.
Inputs
affiliate_idstring- Affiliate ID, from tapfiliate_affiliates_list. Example: janejameson.
date_fromstring- Start date (YYYY-MM-DD, UTC). Example: 2026-01-01.
date_tostring- End date (YYYY-MM-DD, UTC); a plain date means 00:00 that day, so pass the next day to include it. Example: 2026-01-31.
pageinteger- Page number of results, 25 per page, starting at 1. Example: 1.
program_idstring- Program ID, from tapfiliate_programs_list. Example: my-program-3.
tapfiliate_commission_getGet one commission by ID with its conversion, affiliate and status.Read-onlyGet Commission
Get one commission by ID with its conversion, affiliate and status. Returns the commission object.
Inputs
commission_idnumberrequired- Numeric commission ID, from tapfiliate_commissions_list. Example: 93847.
tapfiliate_commissions_listList commissions (regular, recurring, MLM level and bonus), 25 per page, optionally filtered by affiliate, approval status or paid state.Read-onlyList Commissions
List commissions (regular, recurring, MLM level and bonus), 25 per page, optionally filtered by affiliate, approval status or paid state. Returns commissions with amount, status and conversion. Use tapfiliate_commission_get for one.
Inputs
affiliate_idstring- Affiliate ID, from tapfiliate_affiliates_list. Example: janejameson.
pageinteger- Page number of results, 25 per page, starting at 1. Example: 1.
paidboolean- 1 returns only commissions in a payout marked as paid, 0 returns all other commissions. Valid values are: 1 | 0. Example: false.
statusstring- Commission approval status to filter by: approved, disapproved or pending. Example: approved.
tapfiliate_conversion_getGet one conversion by ID with all its commissions, customer, click and meta data.Read-onlyGet Conversion
Get one conversion by ID with all its commissions, customer, click and meta data. Returns the conversion object.
Inputs
conversion_idnumberrequired- Numeric conversion ID, from tapfiliate_conversions_list. Example: 4815162342.
tapfiliate_conversion_meta_data_getGet all meta data stored on a conversion as one key/value object.Read-onlyGet Conversion Meta Data
Get all meta data stored on a conversion as one key/value object. Returns the object ({} when empty).
Inputs
conversion_idnumberrequired- Numeric conversion ID, from tapfiliate_conversions_list. Example: 4815162342.
tapfiliate_conversions_listList conversions (tracked sales) with their commissions, newest first, 25 per page, optionally filtered by program, external ID, affiliate, pending commissions or date.Read-onlyList Conversions
List conversions (tracked sales) with their commissions, newest first, 25 per page, optionally filtered by program, external ID, affiliate, pending commissions or date. Returns conversions with amount, affiliate and commissions. Use tapfiliate_conversion_get for one conversion.
Inputs
affiliate_idstring- Affiliate ID, from tapfiliate_affiliates_list. Example: janejameson.
date_fromstring- Start date (YYYY-MM-DD, UTC). Example: 2026-01-01.
date_tostring- End date (YYYY-MM-DD, UTC); a plain date means 00:00 that day, so pass the next day to include it. Example: 2026-01-31.
external_idstring- The external Id. This is the unique id from your system or shopping cart. This id was passed when the conversions was first tracked. Example: ORD-2026-0042.
pageinteger- Page number of results, 25 per page, starting at 1. Example: 1.
pendingboolean- Only show conversions that have pending commissions. Example: true.
program_idstring- Program ID, from tapfiliate_programs_list. Example: my-program-3.
tapfiliate_customer_getGet one customer by its Tapfiliate ID with the click it came from and fraud warnings.Read-onlyGet Customer
Get one customer by its Tapfiliate ID with the click it came from and fraud warnings. Returns the customer object.
Inputs
tapfiliate_customer_idstringrequired- Tapfiliate customer ID (cu_...), from tapfiliate_customers_list. Example: cu_eXampl3.
tapfiliate_customer_meta_data_getGet all meta data stored on a customer as one key/value object.Read-onlyGet Customer Meta Data
Get all meta data stored on a customer as one key/value object. Returns the object ({} when empty).
Inputs
tapfiliate_customer_idstringrequired- Tapfiliate customer ID (cu_...), from tapfiliate_customers_list. Example: cu_eXampl3.
tapfiliate_customers_listList customers (referred sign-ups or leads), newest first, 25 per page, optionally filtered by program, your customer ID, affiliate or creation date.Read-onlyList Customers
List customers (referred sign-ups or leads), newest first, 25 per page, optionally filtered by program, your customer ID, affiliate or creation date. Returns customers with their status, affiliate and program. Use tapfiliate_customer_get for one customer.
Inputs
affiliate_idstring- Affiliate ID, from tapfiliate_affiliates_list. Example: janejameson.
customer_idstring- The id for this customer in your system. The customer id should be unique for each customer. Example: USER-48213.
date_fromstring- Start date (YYYY-MM-DD, UTC). Example: 2026-01-01.
date_tostring- End date (YYYY-MM-DD, UTC); a plain date means 00:00 that day, so pass the next day to include it. Example: 2026-01-31.
pageinteger- Page number of results, 25 per page, starting at 1. Example: 1.
program_idstring- Program ID, from tapfiliate_programs_list. Example: my-program-3.
tapfiliate_payment_getGet one payment by ID.Read-onlyGet Payment
Get one payment by ID. Returns the payment with affiliate, amount, currency and date.
Inputs
payment_idstringrequired- Payment ID (pa_...), from tapfiliate_payments_list. Example: pa_eXampl3.
tapfiliate_payments_listList payments to affiliates that are not canceled, newest first, 25 per page.Read-onlyList Payments
List payments to affiliates that are not canceled, newest first, 25 per page. Returns payments with affiliate, amount and currency.
Inputs
pageinteger- Page number of results, 25 per page, starting at 1. Example: 1.
tapfiliate_program_affiliate_getGet one affiliate's membership in a program: approval status, coupon and referral link.Read-onlyGet Program Affiliate
Get one affiliate's membership in a program: approval status, coupon and referral link. Returns the membership.
Inputs
affiliate_idstringrequired- Affiliate ID, from tapfiliate_affiliates_list. Example: janejameson.
program_idstringrequired- Program ID, from tapfiliate_programs_list. Example: my-program-3.
tapfiliate_program_affiliates_listList a program's affiliates in every approval status, most recently joined first, 25 per page, optionally by email, source, parent or group.Read-onlyList Program Affiliates
List a program's affiliates in every approval status, most recently joined first, 25 per page, optionally by email, source, parent or group. Returns affiliates with approval status, coupon and referral link.
Inputs
program_idstringrequired- Program ID, from tapfiliate_programs_list. Example: my-program-3.
emailstring- Filter by affiliate email address. Example: jane.jameson@example.com.
group_idstring- Affiliate group ID, from tapfiliate_affiliate_groups_list. Example: ag_eXampl3.
pageinteger- Page number of results, 25 per page, starting at 1. Example: 1.
parent_idstring- Retrieves children for a certain parent affiliate. Example: johnsmith.
source_idstring- A source id. Example: 1-aaaaaa.
tapfiliate_program_commission_types_listList a program's commission types, including hidden ones.Read-onlyList Program Commission Types
List a program's commission types, including hidden ones. Returns identifiers, names and rates. Pass an identifier as commission_type when creating conversions or commissions.
Inputs
program_idstringrequired- Program ID, from tapfiliate_programs_list. Example: my-program-3.
tapfiliate_program_getGet one affiliate program by ID with its currency, cookie time, landing page and status.Read-onlyGet Program
Get one affiliate program by ID with its currency, cookie time, landing page and status. Returns the program object.
Inputs
program_idstringrequired- Program ID, from tapfiliate_programs_list. Example: my-program-3.
tapfiliate_programs_listList affiliate programs, newest first, 25 per page, including archived ones, optionally the one for an asset ID.Read-onlyList Programs
List affiliate programs, newest first, 25 per page, including archived ones, optionally the one for an asset ID. Returns program IDs, titles, currencies and statuses.
Inputs
asset_idstring- An asset id. Example: 1-aaaaaa.
pageinteger- Page number of results, 25 per page, starting at 1. Example: 1.
tapfiliate_affiliate_createCreate an affiliate account with name, email and optional password, company, address and signup custom fields.WriteCreate Affiliate
Create an affiliate account with name, email and optional password, company, address and signup custom fields. Returns the affiliate with its generated ID (and a temporary password when none was given). Add them to a program with tapfiliate_program_affiliate_add.
Inputs
emailstringrequired- Email address. Example: jane.jameson@example.com.
firstnamestringrequired- First name. Example: Jane.
lastnamestringrequired- Last name. Example: Jameson.
addressobject- Postal address: address, address_two, postal_code, city, state and country.code; saved only when address, postal_code, city and country.code are all present. Example: {"address": "Rapenburgerstraat 173", "postal_code": "1011 VM", "city": "Amsterdam", "country": {"code": "NL"}}
companyobject- Company details: name and description. Example: {"name": "Referra Inc.", "description": "Comparison site for SaaS tools"}
custom_fieldsobject- Values for your affiliate signup form's custom fields, keyed by field ID from tapfiliate_affiliate_custom_fields_list. Example: {"field1": "value1"}
passwordstring- Password. Example: Str0ng-Passw0rd!.
tapfiliate_affiliate_group_createCreate an affiliate group with a unique title.WriteCreate Affiliate Group
Create an affiliate group with a unique title. Returns the new group. Needs a plan that includes affiliate groups. Assign affiliates with tapfiliate_affiliate_group_set.
Inputs
titlestringrequired- Group name, 2 to 63 characters, unique in the account. Example: Top partners.
tapfiliate_affiliate_group_setPut an affiliate in an affiliate group, replacing their current group.WriteSet Affiliate Group
Put an affiliate in an affiliate group, replacing their current group. Returns the result. Get group IDs from tapfiliate_affiliate_groups_list.
- Idempotent
Inputs
affiliate_idstringrequired- Affiliate ID, from tapfiliate_affiliates_list. Example: janejameson.
group_idstringrequired- Affiliate group ID, from tapfiliate_affiliate_groups_list. Example: ag_eXampl3.
tapfiliate_affiliate_group_updateRename an affiliate group.WriteUpdate Affiliate Group
Rename an affiliate group. Returns the updated group.
- Idempotent
Inputs
affiliate_group_idstringrequired- Affiliate group ID, from tapfiliate_affiliate_groups_list. Example: ag_eXampl3.
titlestringrequired- Group name, 2 to 63 characters, unique in the account. Example: Top partners.
tapfiliate_affiliate_meta_data_key_setCreate or overwrite one meta data key on an affiliate; other keys stay as they are.WriteSet Affiliate Meta Data Key
Create or overwrite one meta data key on an affiliate; other keys stay as they are. Returns the stored value.
- Idempotent
Inputs
affiliate_idstringrequired- Affiliate ID, from tapfiliate_affiliates_list. Example: janejameson.
keystringrequired- Meta data key (case-sensitive). Example: subid1.
valuestringrequired- Value to store under the key. Example: spring-campaign.
tapfiliate_affiliate_note_createAdd an internal note to an affiliate, authored by the API key's team member.WriteCreate Affiliate Note
Add an internal note to an affiliate, authored by the API key's team member. Returns the new note. Affiliates do not see notes.
Inputs
affiliate_idstringrequired- Affiliate ID, from tapfiliate_affiliates_list. Example: janejameson.
messagestringrequired- Text of the note. Example: Asked for a custom landing page.
tapfiliate_affiliate_prospect_createCreate an affiliate prospect with their own referral code, approved in a program (the default program when none is given) and optionally placed in a group.WriteCreate Affiliate Prospect
Create an affiliate prospect with their own referral code, approved in a program (the default program when none is given) and optionally placed in a group. Returns the prospect with its referral link. Tapfiliate may email them a welcome message.
Inputs
emailstringrequired- Email address. Example: jane.jameson@example.com.
firstnamestringrequired- First name. Example: Jane.
lastnamestringrequired- Last name. Example: Jameson.
addressobject- Postal address: address, address_two, postal_code, city, state and country.code; saved only when address, postal_code, city and country.code are all present. Example: {"address": "Rapenburgerstraat 173", "postal_code": "1011 VM", "city": "Amsterdam", "country": {"code": "NL"}}
affiliate_group_idstring- Affiliate group ID, from tapfiliate_affiliate_groups_list. Example: ag_eXampl3.
companyobject- Company details: name and description. Example: {"name": "Referra Inc.", "description": "Comparison site for SaaS tools"}
program_idstring- Program ID, from tapfiliate_programs_list. Example: my-program-3.
tapfiliate_click_createRecord a click for an affiliate, identified by referral code or by asset ID plus source ID.WriteCreate Click
Record a click for an affiliate, identified by referral code or by asset ID plus source ID. Returns the click ID to pass as click_id to tapfiliate_conversion_create or tapfiliate_customer_create.
Inputs
asset_idstring- Asset ID. Example: 1-aaaaaa.
ipstring- IP. Example: 203.0.113.42.
landing_pagestring- URL of the page the visitor landed on. Example: https://www.example.com/pricing.
meta_dataobject- Up to 10 key/value pairs to store on the click. Example: {"plan": "pro", "source": "newsletter"}
referral_codestring- Referral Code. Example: janejameson.
referrerstring- URL of the page the visitor came from. Example: https://partner-site.example/review.
source_idstring- Source ID. Example: 1-aaaaaa.
user_agentstring- User Agent. Example: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0 Safari/537.36.
tapfiliate_commission_approveApprove a commission, also one that was disapproved.WriteApprove Commission
Approve a commission, also one that was disapproved. Returns the updated commission.
- Idempotent
Inputs
commission_idnumberrequired- Numeric commission ID, from tapfiliate_commissions_list. Example: 93847.
tapfiliate_commission_updateChange a commission's amount, comment, approval or the conversion sub-amount it is based on.WriteUpdate Commission
Change a commission's amount, comment, approval or the conversion sub-amount it is based on. Returns the updated commission. Use tapfiliate_commission_approve or tapfiliate_commission_disapprove for approval only.
- Idempotent
Inputs
commission_idnumberrequired- Numeric commission ID, from tapfiliate_commissions_list. Example: 93847.
amountnumber- New commission amount. Example: 99.5.
approvedboolean- Set to true to approve or false to disapprove. Example: true.
commentstring- A comment for this commission. The comment will be visible to the affiliate. Example: Bonus for the spring campaign.
conversion_sub_amountnumber- New conversion amount the commission is based on. Example: 49.95.
tapfiliate_conversion_commission_addAdd a commission to an existing conversion, calculated from a sub-amount and an optional commission type.WriteAdd Commission to Conversion
Add a commission to an existing conversion, calculated from a sub-amount and an optional commission type. Returns the created commissions.
Inputs
conversion_idnumberrequired- Numeric conversion ID, from tapfiliate_conversions_list. Example: 4815162342.
conversion_sub_amountnumberrequired- Amount the commission is calculated on. Example: 49.95.
commentstring- A comment for this commission. The comment will be visible to the affiliate. Example: Bonus for the spring campaign.
commission_typestring- Commission type identifier, from tapfiliate_program_commission_types_list; the program default is used when empty. Example: standard.
tapfiliate_conversion_createRecord a conversion (a sale) attributed to an affiliate by referral code, tracking ID, click ID, coupon or customer ID, and create its commissions from the amount or per-item commissions.WriteCreate Conversion
Record a conversion (a sale) attributed to an affiliate by referral code, tracking ID, click ID, coupon or customer ID, and create its commissions from the amount or per-item commissions. Returns the conversion with its commissions. Use tapfiliate_customer_create for a sign-up without a sale.
Inputs
amountnumber- Amount. Example: 99.5.
asset_idstring- The asset id. Example: 1-aaaaaa.
click_idstring- The id of an affiliate's click. Attributes the conversion to that click's affiliate. Example: Y2xpY2tfaWQ.
commission_typestring- Commission type identifier, from tapfiliate_program_commission_types_list; the program default is used when empty. Example: standard.
commissionsarray- Per-item commissions, each with sub_amount and optional commission_type and comment; overrides amount and commission_type. Example: [{"sub_amount": 60, "commission_type": "standard"}, {"sub_amount": 39.5, "commission_type": "premium"}]
couponstring- A coupon code to track the conversion by. Example: JANE20OFF.
currencystring- Three-letter ISO currency code. Example: USD.
customer_idstring- The id for the current customer in your system. Depending on your program settings, this can be used for recurring / lifetime commissions. You can read more about this here (https://support.tapfiliate.com/en/articles/12682358-how-to-integrate-with-tapfiliate-via-the-rest-api). Example: USER-48213.
external_idstring- A unique id for this conversion. It can be anything that is meaningful to you, like an order number, user id, email adres etc.. After a conversion has taken place, you can find this id alongside the conversion on our platform. This makes it very easy to cross-reference data on our platform with your own administration. This id has to be unique for every conversion. Example: ORD-2026-0042.
ipstring- The client's ip. Used for fraud detection. Example: 203.0.113.42.
override_max_cookie_timeboolean- Set to true to attribute even when the affiliate's cookie time has passed. Example: false.
program_groupstring- The program group id. Example: pg_123.
referral_codestring- An affiliate's referral code. This corresponds to the value of ref= in their referral link. Example: janejameson.
source_idstring- The source id. Example: 1-aaaaaa.
tracking_idstring- The tracking id, to be retrieved from our javascript library. Please refer to our REST API integration guide (https://support.tapfiliate.com/en/articles/12682358-how-to-integrate-with-tapfiliate-via-the-rest-api) for more info. Example: dGFwZmlsaWF0ZQ.
user_agentstring- The client's user agent string. Used for statistics and fraud detection. Example: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0 Safari/537.36.
tapfiliate_conversion_meta_data_key_setCreate or overwrite one meta data key on a conversion; other keys stay as they are.WriteSet Conversion Meta Data Key
Create or overwrite one meta data key on a conversion; other keys stay as they are. Returns the stored value.
- Idempotent
Inputs
conversion_idnumberrequired- Numeric conversion ID, from tapfiliate_conversions_list. Example: 4815162342.
keystringrequired- Meta data key (case-sensitive). Example: subid1.
valuestringrequired- Value to store under the key. Example: spring-campaign.
tapfiliate_conversion_updateChange a conversion's amount, external ID or meta data, optionally recalculating its commissions.WriteUpdate Conversion
Change a conversion's amount, external ID or meta data, optionally recalculating its commissions. Returns the updated conversion.
- Idempotent
Inputs
conversion_idnumberrequired- Numeric conversion ID, from tapfiliate_conversions_list. Example: 4815162342.
amountnumber- New conversion amount; commissions change only with recalculate_commissions. Example: 99.5.
external_idstring- A unique id for this conversion. It can be anything that is meaningful to you, like an order number, user id, email adres etc.. After a conversion has taken place, you can find this id alongside the conversion on our platform. Example: ORD-2026-0042.
meta_dataobject- Meta data key/value pairs; replaces the whole set, at most 40 keys. Example: {"plan": "pro", "source": "newsletter"}
recalculate_commissionsboolean- Also re-calculate commissions when the request has a numeric amount, even one equal to the current amount. Example: true.
tapfiliate_customer_createCreate a customer (a referred sign-up or lead) attributed to an affiliate by referral code, tracking ID, click ID or coupon, without creating a commission.WriteCreate Customer
Create a customer (a referred sign-up or lead) attributed to an affiliate by referral code, tracking ID, click ID or coupon, without creating a commission. Returns the new customer. Use tapfiliate_conversion_create to record a sale and pay commission.
Inputs
customer_idstringrequired- The id for this customer in your system. The customer id should be unique for each customer. Example: USER-48213.
asset_idstring- The asset id. Example: 1-aaaaaa.
click_idstring- The id of an affiliate's click. Attributes the customer to that click's affiliate. Example: Y2xpY2tfaWQ.
couponstring- A coupon code to track the conversion by. Example: JANE20OFF.
ipstring- The client's ip. Used for fraud detection. Example: 203.0.113.42.
override_max_cookie_timeboolean- Set to true to attribute even when the affiliate's cookie time has passed. Example: false.
referral_codestring- An affiliate's referral code. This corresponds to the value of ref= in their referral link. Example: janejameson.
source_idstring- The source id. Example: 1-aaaaaa.
statusstring- Commission approval status to filter by: approved, disapproved or pending. Example: approved.
tracking_idstring- The tracking id, to be retrieved from our javascript library. Please refer to our REST API integration guide (https://support.tapfiliate.com/en/articles/12682358-how-to-integrate-with-tapfiliate-via-the-rest-api) for more info. Example: dGFwZmlsaWF0ZQ.
user_agentstring- The client's user agent string. Used for statistics and fraud detection. Example: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0 Safari/537.36.
tapfiliate_customer_meta_data_key_setCreate or overwrite one meta data key on a customer; other keys stay as they are.WriteSet Customer Meta Data Key
Create or overwrite one meta data key on a customer; other keys stay as they are. Returns the stored value. Use tapfiliate_customer_update to replace the whole set.
- Idempotent
Inputs
keystringrequired- Meta data key (case-sensitive). Example: subid1.
tapfiliate_customer_idstringrequired- Tapfiliate customer ID (cu_...), from tapfiliate_customers_list. Example: cu_eXampl3.
valuestringrequired- Value to store under the key. Example: spring-campaign.
tapfiliate_customer_updateChange a customer's ID from your system and/or replace its meta data.WriteUpdate Customer
Change a customer's ID from your system and/or replace its meta data. Returns the updated customer. Use tapfiliate_customer_cancel to change its status.
- Idempotent
Inputs
tapfiliate_customer_idstringrequired- Tapfiliate customer ID (cu_...), from tapfiliate_customers_list. Example: cu_eXampl3.
customer_idstring- New customer ID from your system, unique in the account. Example: USER-48213.
meta_dataobject- Meta data key/value pairs; replaces the whole set, at most 20 keys. Example: {"plan": "pro", "source": "newsletter"}
tapfiliate_payment_createRecord a payment made to an affiliate, which lowers their balance.WriteCreate Payment
Record a payment made to an affiliate, which lowers their balance. Returns the payment. Tapfiliate does not move money; pay the affiliate yourself.
Inputs
affiliate_idstringrequired- Affiliate ID, from tapfiliate_affiliates_list. Example: janejameson.
amountnumberrequired- Payment amount, greater than 0. Example: 99.5.
currencystringrequired- Three-letter ISO currency code. Example: USD.
tapfiliate_program_affiliate_addAdd an existing affiliate to a program, approved unless approved is false, with an optional coupon.WriteAdd Affiliate to Program
Add an existing affiliate to a program, approved unless approved is false, with an optional coupon. Returns the program membership with the referral link.
Inputs
affiliate_idstringrequired- ID of the affiliate to add, from tapfiliate_affiliates_list. Example: janejameson.
program_idstringrequired- Program ID, from tapfiliate_programs_list. Example: my-program-3.
approvedboolean- Set to true to approve or false to disapprove. Example: true.
couponstring- An optional coupon for this affiliate. Example: JANE20OFF.
tapfiliate_program_affiliate_approveApprove an affiliate in a program.WriteApprove Program Affiliate
Approve an affiliate in a program. Returns the membership. Tapfiliate may email the affiliate.
- Idempotent
Inputs
affiliate_idstringrequired- Affiliate ID, from tapfiliate_affiliates_list. Example: janejameson.
program_idstringrequired- Program ID, from tapfiliate_programs_list. Example: my-program-3.
tapfiliate_program_affiliate_updateSet an affiliate's coupon code in a program; the coupon must be unique across your programs.WriteUpdate Program Affiliate
Set an affiliate's coupon code in a program; the coupon must be unique across your programs. Returns the updated membership.
- Idempotent
Inputs
affiliate_idstringrequired- Affiliate ID, from tapfiliate_affiliates_list. Example: janejameson.
couponstringrequired- Coupon code for the affiliate in this program, unique across your programs. Example: JANE20OFF.
program_idstringrequired- Program ID, from tapfiliate_programs_list. Example: my-program-3.
tapfiliate_affiliate_deleteDelete an affiliate: their personal data is cleared and the account is locked.DestructiveDelete Affiliate
Delete an affiliate: their personal data is cleared and the account is locked. Returns nothing (204). This cannot be undone.
- Idempotent
Inputs
affiliate_idstringrequired- Affiliate ID, from tapfiliate_affiliates_list. Example: janejameson.
tapfiliate_affiliate_meta_data_key_deleteDelete one meta data key from an affiliate.DestructiveDelete Affiliate Meta Data Key
Delete one meta data key from an affiliate. Returns nothing (204), also when the key did not exist.
- Idempotent
Inputs
affiliate_idstringrequired- Affiliate ID, from tapfiliate_affiliates_list. Example: janejameson.
keystringrequired- Meta data key (case-sensitive). Example: subid1.
tapfiliate_affiliate_prospect_deleteDelete an affiliate prospect: their data is cleared and they are disapproved in all programs.DestructiveDelete Affiliate Prospect
Delete an affiliate prospect: their data is cleared and they are disapproved in all programs. Returns nothing (204).
- Idempotent
Inputs
affiliate_prospect_idstringrequired- The id of the affiliate prospect. Example: jimprosper.
tapfiliate_commission_disapproveDisapprove a pending or approved commission.DestructiveDisapprove Commission
Disapprove a pending or approved commission. Returns the updated commission. Use tapfiliate_commission_approve to reverse it.
- Idempotent
Inputs
commission_idnumberrequired- Numeric commission ID, from tapfiliate_commissions_list. Example: 93847.
tapfiliate_conversion_deletePermanently delete a conversion with all its commissions and meta data.DestructiveDelete Conversion
Permanently delete a conversion with all its commissions and meta data. Returns nothing (204).
- Idempotent
Inputs
conversion_idnumberrequired- Numeric conversion ID, from tapfiliate_conversions_list. Example: 4815162342.
tapfiliate_conversion_meta_data_key_deleteDelete one meta data key from a conversion.DestructiveDelete Conversion Meta Data Key
Delete one meta data key from a conversion. Returns nothing (204), also when the key did not exist.
- Idempotent
Inputs
conversion_idnumberrequired- Numeric conversion ID, from tapfiliate_conversions_list. Example: 4815162342.
keystringrequired- Meta data key (case-sensitive). Example: subid1.
tapfiliate_customer_cancelCancel a customer: its status becomes canceled, lost or stopped and automatic recurring commissions stop.DestructiveCancel Customer
Cancel a customer: its status becomes canceled, lost or stopped and automatic recurring commissions stop. Returns the updated customer.
- Idempotent
Inputs
tapfiliate_customer_idstringrequired- Tapfiliate customer ID (cu_...), from tapfiliate_customers_list. Example: cu_eXampl3.
tapfiliate_customer_deletePermanently delete a customer and its meta data.DestructiveDelete Customer
Permanently delete a customer and its meta data. Its conversions and commissions are kept but unlinked. Returns nothing (204).
- Idempotent
Inputs
tapfiliate_customer_idstringrequired- Tapfiliate customer ID (cu_...), from tapfiliate_customers_list. Example: cu_eXampl3.
tapfiliate_customer_meta_data_key_deleteDelete one meta data key from a customer.DestructiveDelete Customer Meta Data Key
Delete one meta data key from a customer. Returns nothing (204), also when the key did not exist.
- Idempotent
Inputs
keystringrequired- Meta data key (case-sensitive). Example: subid1.
tapfiliate_customer_idstringrequired- Tapfiliate customer ID (cu_...), from tapfiliate_customers_list. Example: cu_eXampl3.
tapfiliate_payment_cancelCancel a recorded payment so it no longer counts against the affiliate's balance.DestructiveCancel Payment
Cancel a recorded payment so it no longer counts against the affiliate's balance. Returns nothing (204).
- Idempotent
Inputs
payment_idstringrequired- Payment ID (pa_...), from tapfiliate_payments_list. Example: pa_eXampl3.
tapfiliate_program_affiliate_disapproveDisapprove an affiliate in a program so they no longer earn commissions there.DestructiveDisapprove Program Affiliate
Disapprove an affiliate in a program so they no longer earn commissions there. Returns the membership with approved false.
- Idempotent
Inputs
affiliate_idstringrequired- Affiliate ID, from tapfiliate_affiliates_list. Example: janejameson.
program_idstringrequired- Program ID, from tapfiliate_programs_list. Example: my-program-3.
No tools match.