Tapfiliate

MARKETING · MARKETING

Affiliates, conversions, commissions, and payouts in that program’s account.

Acts as the person, not as itself

Each user connects their own account. Every call carries both identities — the agent and the person it is acting for — so the agent can never reach past what that individual can already do.

Credentials never touch the agent

Tokens live in the vault and attach server-side at call time. The agent holds a session, not a secret, and revoking access does not mean rotating a key.

Every call on the record

Who asked, which agent acted, which action ran, and the verdict that let it through — one audit trail across every integration, not one per vendor.

What an agent can do

Each action is granted on its own. An agent allowed to read is not thereby allowed to write, and the scope beside each row is what the acting user must have connected for it to run at all.

tapfiliate_delete_affiliate_prospects_by_affiliate_prospect_idWRITE

Delete an affiliate prospect via DELETE /affiliate-prospects/{affiliate_prospect_id}/.

api

tapfiliate_delete_affiliates_by_affiliate_idWRITE

Delete an affiliate via DELETE /affiliates/{affiliate_id}/.

api

tapfiliate_delete_affiliates_by_affiliate_id_groupWRITE

Remove affiliate group via DELETE /affiliates/{affiliate_id}/group/.

api

tapfiliate_delete_affiliates_by_affiliate_id_meta_data_by_keyWRITE

Delete meta data by key (affiliate) via DELETE /affiliates/{affiliate_id}/meta-data/{key}/.

api

tapfiliate_delete_affiliates_by_affiliate_id_notes_by_idWRITE

Delete note via DELETE /affiliates/{affiliate_id}/notes/{id}/.

api

tapfiliate_delete_affiliates_by_child_affiliate_id_parentWRITE

Remove parent via DELETE /affiliates/{child_affiliate_id}/parent/.

api

tapfiliate_delete_commissions_by_commission_id_approvedWRITE

Disapprove a commission via DELETE /commissions/{commission_id}/approved/.

api

tapfiliate_delete_conversions_by_conversion_idWRITE

Delete a Conversion via DELETE /conversions/{conversion_id}/.

api

tapfiliate_delete_conversions_by_conversion_id_meta_data_by_keyWRITE

Delete meta data by key (conversion) via DELETE /conversions/{conversion_id}/meta-data/{key}/.

api

tapfiliate_delete_customers_by_idWRITE

Delete a Customer via DELETE /customers/{id}/.

api

tapfiliate_delete_customers_by_id_meta_data_by_keyWRITE

Delete meta data by key (customer) via DELETE /customers/{id}/meta-data/{key}/.

api

tapfiliate_delete_customers_by_id_statusWRITE

Cancel a customer via DELETE /customers/{id}/status/.

api

tapfiliate_delete_payments_by_idWRITE

Cancel payment via DELETE /payments/{id}/. Cancels the payment and re-adds the amount to the affiliate’s balance.

api

tapfiliate_delete_programs_by_program_id_affiliates_by_affiliate_id_approvedWRITE

Disapprove an affiliate via DELETE /programs/{program_id}/affiliates/{affiliate_id}/approved/.

api

tapfiliate_get_affiliate_groupsREAD

List all affiliate groups via GET /affiliate-groups/.

api

tapfiliate_get_affiliate_prospectsREAD

List all affiliate prospects via GET /affiliate-prospects/.

api

tapfiliate_get_affiliate_prospects_by_affiliate_prospect_idREAD

Retrieve an affiliate prospect via GET /affiliate-prospects/{affiliate_prospect_id}/.

api

tapfiliate_get_affiliatesREAD

List all affiliates via GET /affiliates/.

api

tapfiliate_get_affiliates_by_affiliate_idREAD

Retrieve an affiliate via GET /affiliates/{affiliate_id}/.

api

tapfiliate_get_affiliates_by_affiliate_id_balancesREAD

Retrieve affiliate's balances via GET /affiliates/{affiliate_id}/balances/.

api

tapfiliate_get_affiliates_by_affiliate_id_meta_dataREAD

Retrieve meta data (affiliate) via GET /affiliates/{affiliate_id}/meta-data/.

api

tapfiliate_get_affiliates_by_affiliate_id_meta_data_by_keyREAD

Retrieve meta data by key (affiliate) via GET /affiliates/{affiliate_id}/meta-data/{key}/.

api

tapfiliate_get_affiliates_by_affiliate_id_notesREAD

List notes via GET /affiliates/{affiliate_id}/notes/.

api

tapfiliate_get_affiliates_by_affiliate_id_paymentsREAD

List affiliate's payments via GET /affiliates/{affiliate_id}/payments/.

api

tapfiliate_get_affiliates_by_affiliate_id_payout_methodsREAD

List payout methods via GET /affiliates/{affiliate_id}/payout-methods/.

api

tapfiliate_get_affiliates_by_affiliate_id_payout_methods_by_payout_method_idREAD

Get payout method via GET /affiliates/{affiliate_id}/payout-methods/{payout_method_id}/.

api

tapfiliate_get_affiliates_by_id_programsREAD

Get affiliations via GET /affiliates/{id}/programs/.

api

tapfiliate_get_affiliates_custom_fieldsREAD

Get custom fields via GET /affiliates/custom-fields/.

api

tapfiliate_get_balancesREAD

List all balances via GET /balances/. Returns a non-paginated list of all non-zero affiliate balances.

api

tapfiliate_get_clicksREAD

List all clicks via GET /clicks/. Enterprise plan only: Tapfiliate's 'Detailed API click report' is not included on Launch or Scale, so a key from those plans is refused here by entitlement, not by a bad credential.

api

tapfiliate_get_clicks_by_idREAD

Get detailed information about click via GET /clicks/{id}/. Enterprise plan only: Tapfiliate's 'Detailed API click report' is not included on Launch or Scale, so a key from those plans is refused here by entitlement, not by a bad credential.

api

tapfiliate_get_commissionsREAD

List all commissions via GET /commissions/.

api

tapfiliate_get_commissions_by_commission_idREAD

Retrieve a commission via GET /commissions/{commission_id}/.

api

tapfiliate_get_conversionsREAD

List all conversions via GET /conversions/.

api

tapfiliate_get_conversions_by_conversion_idREAD

Retrieve a Conversion via GET /conversions/{conversion_id}/.

api

tapfiliate_get_conversions_by_conversion_id_meta_dataREAD

Retrieve meta data (conversion) via GET /conversions/{conversion_id}/meta-data/.

api

tapfiliate_get_conversions_by_conversion_id_meta_data_by_keyREAD

Retrieve meta data by key (conversion) via GET /conversions/{conversion_id}/meta-data/{key}/.

api

tapfiliate_get_customersREAD

List all Customers via GET /customers/.

api

tapfiliate_get_customers_by_idREAD

Retrieve a Customer via GET /customers/{id}/.

api

tapfiliate_get_customers_by_id_meta_dataREAD

Retrieve meta data (customer) via GET /customers/{id}/meta-data/.

api

tapfiliate_get_customers_by_id_meta_data_by_keyREAD

Retrieve meta data by key (customer) via GET /customers/{id}/meta-data/{key}/.

api

tapfiliate_get_paymentsREAD

List all payments via GET /payments/.

api

tapfiliate_get_payments_by_idREAD

Retrieve payment via GET /payments/{id}/.

api

tapfiliate_get_programsREAD

List all programs via GET /programs/.

api

tapfiliate_get_programs_by_program_idREAD

Retrieve a Program via GET /programs/{program_id}/.

api

tapfiliate_get_programs_by_program_id_affiliatesREAD

List all affiliates in program via GET /programs/{program_id}/affiliates/.

api

tapfiliate_get_programs_by_program_id_affiliates_by_affiliate_idREAD

Retrieve an affiliate in a program via GET /programs/{program_id}/affiliates/{affiliate_id}/.

api

tapfiliate_get_programs_by_program_id_bonusesREAD

List program bonuses via GET /programs/{program_id}/bonuses/.

api

tapfiliate_get_programs_by_program_id_commission_typesREAD

List program commission types via GET /programs/{program_id}/commission-types/.

api

tapfiliate_get_programs_by_program_id_levelsREAD

List program MLM levels via GET /programs/{program_id}/levels/.

api

tapfiliate_patch_affiliate_groups_by_affiliate_group_idWRITE

Update affiliate group via PATCH /affiliate-groups/{affiliate_group_id}/.

api

tapfiliate_patch_commissions_by_commission_idWRITE

Update a commission via PATCH /commissions/{commission_id}/.

api

tapfiliate_patch_conversions_by_conversion_idWRITE

Update a Conversion via PATCH /conversions/{conversion_id}/.

api

tapfiliate_patch_customers_by_idWRITE

Update a Customer via PATCH /customers/{id}/.

api

tapfiliate_patch_programs_by_program_id_affiliates_by_affiliate_idWRITE

Update an affiliate in a program via PATCH /programs/{program_id}/affiliates/{affiliate_id}/.

api

tapfiliate_post_affiliate_groupsWRITE

Create new affiliate group via POST /affiliate-groups/.

api

tapfiliate_post_affiliate_prospectsWRITE

Create an affiliate prospect via POST /affiliate-prospects/.

api

tapfiliate_post_affiliatesWRITE

Create an affiliate via POST /affiliates/.

api

tapfiliate_post_affiliates_by_affiliate_id_notesWRITE

Create note via POST /affiliates/{affiliate_id}/notes/.

api

tapfiliate_post_affiliates_by_child_affiliate_id_parentWRITE

Set parent via POST /affiliates/{child_affiliate_id}/parent/.

api

tapfiliate_post_clicksWRITE

Create a Click via POST /clicks/. In case you elect to use a REST-only implementation, you can use the “Create a Click” endpoint to obtain a click id. This click id can be used to create a conversion, by passing it as the click_id . You can learn how to set up a full REST-only integration in our REST integration guide.

api

tapfiliate_post_conversionsWRITE

Create a conversion via POST /conversions/. You are required to use either a referral code, customer_id, click id, coupon code, tracking id, or asset_id & source_id combination. If more than one of these is sent, the precedence will be as follows (highest to lowest): Customer id, Coupon, Referral Code, Click Id, Asset id + Source id, Tracking id.

api

tapfiliate_post_conversions_by_conversion_id_commissionsWRITE

Add commissions to a conversion via POST /conversions/{conversion_id}/commissions/.

api

tapfiliate_post_customersWRITE

Create a Customer via POST /customers/. You are required to use either a Tracking id, referral code, click id, coupon code, or asset_id & source_id combination. If more than one of these is sent, the precedence will be as follows (highest to lowest): Coupon, Referral Code, Click Id, Asset id + Source id, Tracking id Please refer to our REST API integration guide for more info.

api

tapfiliate_post_paymentsWRITE

Create a payment via POST /payments/. Create a single payment or multiple (using an array of payments).

api

tapfiliate_post_programs_by_program_id_affiliatesWRITE

Add an affiliate to a program via POST /programs/{program_id}/affiliates/.

api

tapfiliate_put_affiliates_by_affiliate_id_groupWRITE

Set affiliate group via PUT /affiliates/{affiliate_id}/group/.

api

tapfiliate_put_affiliates_by_affiliate_id_meta_dataWRITE

Update (replace) meta data (affiliate) via PUT /affiliates/{affiliate_id}/meta-data/.

api

tapfiliate_put_affiliates_by_affiliate_id_meta_data_by_keyWRITE

Set meta data by key (affiliate) via PUT /affiliates/{affiliate_id}/meta-data/{key}/.

api

tapfiliate_put_affiliates_by_affiliate_id_notes_by_idWRITE

Update note via PUT /affiliates/{affiliate_id}/notes/{id}/.

api

tapfiliate_put_affiliates_by_affiliate_id_payout_methods_by_payout_method_idWRITE

Set payout method via PUT /affiliates/{affiliate_id}/payout-methods/{payout_method_id}/. The body of the request should contain the appropriate data for the payout method you are setting. The field ids can be found by exporting payouts as .csv on the payouts page.

api

tapfiliate_put_commissions_by_commission_id_approvedWRITE

Approve a commission via PUT /commissions/{commission_id}/approved/.

api

tapfiliate_put_conversions_by_conversion_id_meta_dataWRITE

Update (replace) meta data (conversion) via PUT /conversions/{conversion_id}/meta-data/.

api

tapfiliate_put_conversions_by_conversion_id_meta_data_by_keyWRITE

Set meta data by key (conversion) via PUT /conversions/{conversion_id}/meta-data/{key}/.

api

tapfiliate_put_customers_by_id_meta_dataWRITE

Update (replace) meta data (customer) via PUT /customers/{id}/meta-data/.

api

tapfiliate_put_customers_by_id_meta_data_by_keyWRITE

Set meta data by key (customer) via PUT /customers/{id}/meta-data/{key}/.

api

tapfiliate_put_customers_by_id_statusWRITE

Uncancel a customer via PUT /customers/{id}/status/. The customer will jump back to the appropriate status. You can read more about status statuses here.

api

tapfiliate_put_programs_by_program_id_affiliates_by_affiliate_id_approvedWRITE

Approve an affiliate via PUT /programs/{program_id}/affiliates/{affiliate_id}/approved/.

api