Skip to main content
New to Corsair? See API access, authentication, and error handling.

Affiliates

balances

affiliates.balances Read one affiliate’s balance per currency Risk: read
Input Output: 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
Input The reference documents a 200 with no body; then the plugin reports { 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.
Output: object

customFields

affiliates.customFields List the custom fields on your signup form, whose IDs affiliate creates take Risk: read
Input: empty object Output: object[]

delete

affiliates.delete Permanently delete an affiliate; their personal data is cleared and the record is locked Risk: destructive · Irreversible
Input Output

get

affiliates.get Read one affiliate with their company, address, custom fields and metadata Risk: read
Input Output

list

affiliates.list List affiliates, newest first, 25 per page, filtered by email, referral code, click, parent or group Risk: read
Input Output: object[]

payments

affiliates.payments List one affiliate’s payments, newest first Risk: read
Input Output: object[]

programs

affiliates.programs List the programs an affiliate belongs to, with the coupon, approval state and referral link for each Risk: read
Input Output: object[]

Balances

list

balances.list List what you owe each affiliate with a non-zero balance, per currency Risk: read
Input Output: object[]

Clicks

create

clicks.create Record a click and return its ID for use as click_id when creating a conversion Risk: write
Input Returns { 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
Input Output

list

clicks.list List clicks on your programs, filtered by program, affiliate or date; needs the click-report feature on your plan Risk: read
Input Requires the click-report feature on your plan, otherwise 403.
Output: object[]

Commissions

approve

commissions.approve Approve a commission, also when it was disapproved before, and fire the commission triggers Risk: destructive
Input Output

disapprove

commissions.disapprove Disapprove a commission from pending or approved, which removes it from the affiliate balance Risk: destructive
Input Output

get

commissions.get Read one commission of any kind: regular, recurring, MLM level or bonus Risk: read
Input Output

list

commissions.list List commissions, filtered by affiliate, status or whether they are paid Risk: read
Input Output: object[]

update

commissions.update Change a commission’s amount or comment Risk: destructive
Input Output

Conversions

create

conversions.create Track a conversion and create its commissions, attributed through a coupon, click, referral code, asset or tracking ID Risk: destructive
Input Send at least one of coupon, click_id, referral_code, asset_id or tracking_id, or a customer_id that matches an existing customer in a recurring program; with commissions, their sub_amount values must add up to amount.
Output

delete

conversions.delete Permanently delete a conversion with all of its commissions and metadata Risk: destructive · Irreversible
Input Output

get

conversions.get Read one conversion with every commission, including MLM levels, and its fraud warnings Risk: read
Input Output

list

conversions.list List conversions with their commissions, newest first, filtered by program, affiliate, external ID or date Risk: read
Input Output: object[]

update

conversions.update Change a conversion’s amount, external ID or metadata; commissions change only with recalculate_commissions and a numeric amount Risk: destructive
Input recalculate_commissions travels as a query flag and needs a numeric amount; without it the amount changes and the commissions do not. The route answers 200 with no body, so the plugin reports { id, updated: true }. Output: object

Customers

cancel

customers.cancel Cancel a customer, which stops its automatic recurring commissions; another call can reactivate it Risk: write
Input Output

create

customers.create Create a customer attributed to an affiliate; no commission is created until a conversion arrives Risk: write
Input customer_id is required and must be unique; at least one tracking reference is required. status takes new (the default), trial or lead. Output

delete

customers.delete Permanently delete a customer and its metadata; its conversions and commissions stay but lose the link Risk: destructive · Irreversible
Input Output

get

customers.get Read one customer with the click it was tracked from and its current fraud warnings Risk: read
Input Output

list

customers.list List customers, newest first, filtered by program, customer ID, affiliate or date range Risk: read
Input Output: object[]

uncancel

customers.uncancel Reactivate a canceled customer, restoring recurring commissions from now without back-filling Risk: write
Input Output

update

customers.update Change a customer’s customer_id or replace its metadata Risk: write
Input Output

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
Input A DELETE route that cancels the payment and raises the affiliate balance again; it does not reverse a payout made outside Tapfiliate. Output

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
Input: object \| object[]
Output: object[]

get

payments.get Read one payment with its affiliate, amount and currency Risk: read
Input Output

list

payments.list List payments that were not canceled, newest first Risk: read
Input Output: object[]

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
Input approved defaults to true, false disapproves and null leaves the affiliate pending; the program auto-approve setting is not applied. Output

affiliates

programs.affiliates List a program’s affiliates in every approval state, with each one’s coupon and referral link Risk: read
Input Output: object[]

approveAffiliate

programs.approveAffiliate Approve an affiliate for a program and email them when the program notifies on approval Risk: destructive
Input Output

disapproveAffiliate

programs.disapproveAffiliate Disapprove an affiliate for a program; they keep the record but earn nothing there Risk: write
Input Output

get

programs.get Read one program, including an archived one, with its currency, cookie time and status Risk: read
Input Output

getAffiliate

programs.getAffiliate Read one affiliate within a program, with their program-specific coupon and approval state Risk: read
Input Output

list

programs.list List your programs, archived ones included, 25 per page Risk: read
Input Output: object[]

updateAffiliate

programs.updateAffiliate Change an affiliate’s coupon in a program; null removes it and omitting it changes nothing Risk: write
Input coupon null removes the coupon, a string replaces it, and omitting the field changes nothing. Output