Affiliates
balances
affiliates.balances
Read one affiliate’s balance per currency
Risk: read
Record<string, number>
create
affiliates.create
Create an affiliate and run the Affiliate created triggers; the new affiliate joins no program until you add it to one
Risk: write
{ created: true, email } and the id (derived from the first and last name) comes from affiliates.list. An address is kept only when address, postal_code, city and country.code are all sent.
company full type
company full type
address full type
address full type
object
Output full type
Output full type
customFields
affiliates.customFields
List the custom fields on your signup form, whose IDs affiliate creates take
Risk: read
object[]
Output full type
Output full type
delete
affiliates.delete
Permanently delete an affiliate; their personal data is cleared and the record is locked
Risk: destructive · Irreversible
get
affiliates.get
Read one affiliate with their company, address, custom fields and metadata
Risk: read
company full type
company full type
address full type
address full type
list
affiliates.list
List affiliates, newest first, 25 per page, filtered by email, referral code, click, parent or group
Risk: read
object[]
Output full type
Output full type
payments
affiliates.payments
List one affiliate’s payments, newest first
Risk: read
object[]
Output full type
Output full type
programs
affiliates.programs
List the programs an affiliate belongs to, with the coupon, approval state and referral link for each
Risk: read
object[]
Output full type
Output full type
Balances
list
balances.list
List what you owe each affiliate with a non-zero balance, per currency
Risk: read
object[]
Output full type
Output full type
Clicks
create
clicks.create
Record a click and return its ID for use as click_id when creating a conversion
Risk: write
{ id } for use as click_id in conversions.create. Name the affiliate with referral_code (a source_id then overrides its source) or with asset_id and source_id. ip, user_agent, referrer and landing_page are stored as sent.
Output
get
clicks.get
Read one click with its device details, country and metadata, plus its affiliate and program
Risk: read
meta_data full type
meta_data full type
affiliate full type
affiliate full type
program full type
program full type
list
clicks.list
List clicks on your programs, filtered by program, affiliate or date; needs the click-report feature on your plan
Risk: read
meta_data full type
meta_data full type
object[]
Output full type
Output full type
Commissions
approve
commissions.approve
Approve a commission, also when it was disapproved before, and fire the commission triggers
Risk: destructive
affiliate full type
affiliate full type
conversion full type
conversion full type
disapprove
commissions.disapprove
Disapprove a commission from pending or approved, which removes it from the affiliate balance
Risk: destructive
affiliate full type
affiliate full type
conversion full type
conversion full type
get
commissions.get
Read one commission of any kind: regular, recurring, MLM level or bonus
Risk: read
affiliate full type
affiliate full type
conversion full type
conversion full type
list
commissions.list
List commissions, filtered by affiliate, status or whether they are paid
Risk: read
object[]
Output full type
Output full type
update
commissions.update
Change a commission’s amount or comment
Risk: destructive
affiliate full type
affiliate full type
conversion full type
conversion full type
Conversions
create
conversions.create
Track a conversion and create its commissions, attributed through a coupon, click, referral code, asset or tracking ID
Risk: destructive
commissions full type
commissions full type
click full type
click full type
commissions full type
commissions full type
program full type
program full type
affiliate full type
affiliate full type
customer full type
customer full type
delete
conversions.delete
Permanently delete a conversion with all of its commissions and metadata
Risk: destructive · Irreversible
get
conversions.get
Read one conversion with every commission, including MLM levels, and its fraud warnings
Risk: read
click full type
click full type
commissions full type
commissions full type
program full type
program full type
affiliate full type
affiliate full type
customer full type
customer full type
list
conversions.list
List conversions with their commissions, newest first, filtered by program, affiliate, external ID or date
Risk: read
object[]
Output full type
Output full type
update
conversions.update
Change a conversion’s amount, external ID or metadata; commissions change only with recalculate_commissions and a numeric amount
Risk: destructive
{ id, updated: true }.
Output: object
Output full type
Output full type
Customers
cancel
customers.cancel
Cancel a customer, which stops its automatic recurring commissions; another call can reactivate it
Risk: write
click full type
click full type
program full type
program full type
affiliate full type
affiliate full type
create
customers.create
Create a customer attributed to an affiliate; no commission is created until a conversion arrives
Risk: write
click full type
click full type
program full type
program full type
affiliate full type
affiliate full type
delete
customers.delete
Permanently delete a customer and its metadata; its conversions and commissions stay but lose the link
Risk: destructive · Irreversible
get
customers.get
Read one customer with the click it was tracked from and its current fraud warnings
Risk: read
click full type
click full type
program full type
program full type
affiliate full type
affiliate full type
list
customers.list
List customers, newest first, filtered by program, customer ID, affiliate or date range
Risk: read
object[]
Output full type
Output full type
uncancel
customers.uncancel
Reactivate a canceled customer, restoring recurring commissions from now without back-filling
Risk: write
click full type
click full type
program full type
program full type
affiliate full type
affiliate full type
update
customers.update
Change a customer’s customer_id or replace its metadata
Risk: write
click full type
click full type
program full type
program full type
affiliate full type
affiliate full type
Payments
cancel
payments.cancel
Cancel a payment. It stops counting against the affiliate balance, so the balance goes back up by its amount; an outside payout already sent is not reversed, and there is no undo
Risk: destructive · Irreversible
create
payments.create
Record one payment or an array of payments; an affiliate on an automated payout method is also paid out through that provider. Tapfiliate creates none when any entry is invalid
Risk: destructive
object \| object[]
Input full type
Input full type
object[]
Output full type
Output full type
get
payments.get
Read one payment with its affiliate, amount and currency
Risk: read
affiliate full type
affiliate full type
list
payments.list
List payments that were not canceled, newest first
Risk: read
object[]
Output full type
Output full type
Programs
addAffiliate
programs.addAffiliate
Add an existing affiliate to a program, approved by default (which sends the approval email when the program notifies on approval), or pending or disapproved explicitly
Risk: destructive
company full type
company full type
address full type
address full type
referral_link full type
referral_link full type
affiliates
programs.affiliates
List a program’s affiliates in every approval state, with each one’s coupon and referral link
Risk: read
object[]
Output full type
Output full type
approveAffiliate
programs.approveAffiliate
Approve an affiliate for a program and email them when the program notifies on approval
Risk: destructive
company full type
company full type
address full type
address full type
referral_link full type
referral_link full type
disapproveAffiliate
programs.disapproveAffiliate
Disapprove an affiliate for a program; they keep the record but earn nothing there
Risk: write
company full type
company full type
address full type
address full type
referral_link full type
referral_link full type
get
programs.get
Read one program, including an archived one, with its currency, cookie time and status
Risk: read
getAffiliate
programs.getAffiliate
Read one affiliate within a program, with their program-specific coupon and approval state
Risk: read
company full type
company full type
address full type
address full type
referral_link full type
referral_link full type
list
programs.list
List your programs, archived ones included, 25 per page
Risk: read
object[]
Output full type
Output full type
updateAffiliate
programs.updateAffiliate
Change an affiliate’s coupon in a program; null removes it and omitting it changes nothing
Risk: write
company full type
company full type
address full type
address full type
referral_link full type
referral_link full type