Tapfiliate
App · 30 actions
Run your Tapfiliate affiliate program: add and approve affiliates and groups, record sales and customers, review and approve commissions, and check what you owe in payments.
Actions
| Action | What it does |
|---|---|
| Add affiliate to program | Add an existing affiliate to a program, approved unless you choose otherwise. |
| Add note to affiliate | Add a private note to an affiliate. |
| Approve or disapprove affiliate in program | Approve an affiliate so they earn commission in a program, or disapprove them to stop it. |
| Approve or disapprove commission | Approve a commission so it can be paid, or disapprove it. |
| Create affiliate | Add an affiliate. |
| Create affiliate group | Create an affiliate group. |
| Create conversion | Record a sale and credit the affiliate it traces back to. |
| Create customer | Track a customer and tie them to the affiliate who referred them, so later sales and recurring commissions go to that affiliate. |
| Delete affiliate | Delete an affiliate and their program memberships. |
| Delete conversion | Delete a conversion and its commissions. |
| Delete customer | Delete a customer. |
| Get affiliate | Get one affiliate with their company, address, group and parent. |
| Get affiliate balances | Get what Tapfiliate owes one affiliate, with one amount per currency. |
| Get commission | Get one commission with its amount, status, affiliate and conversion. |
| Get conversion | Get one conversion with its commissions, affiliate and customer. |
| Get customer | Get one customer with their status, program and affiliate. |
| Get program | Get one program with its currency, cookie time and recurring settings. |
| List affiliate groups | List every affiliate group with how many affiliates it holds. |
| List affiliate notes | List the private notes on one affiliate. |
| List affiliates | List affiliates, 25 to a page, optionally by email, referral code, group or parent. |
| List affiliates in program | List the affiliates in a program, 25 to a page, with their referral links and coupons. |
| List balances | List every affiliate who is owed money, with the amount per currency. |
| List commissions | List commissions, 25 to a page, by affiliate, status or whether they are paid. |
| List conversions | List conversions (sales), 25 to a page, by program, affiliate, external id or date. |
| List customers | List customers, 25 to a page, by program, affiliate, your own customer id or date. |
| List payments | List the payments made to affiliates. |
| List programs | List every affiliate program in the account. |
| Put affiliate in group | Put an affiliate in an affiliate group, replacing any group they were in. |
| Rename affiliate group | Change an affiliate group's name. |
| Update conversion | Change a conversion's amount, external id or metadata. |
Add affiliate to program
Add an existing affiliate to a program, approved unless you choose otherwise. The result has their referral link.
Inputs
- Program
program_idtextRequired - The program. Pick one, or give its id from an earlier step.
- Affiliate
affiliate_idtextRequired - The affiliate. Pick one, or give its id from an earlier step.
- Approval
approvaltext - Whether they can earn straight away. Defaults to approved.One of:
approved(Approved (default)),pending,disapproved. - Coupon code
coupontext - A coupon code for this affiliate in the program, if you use them.
Outputs
membershipobject- The affiliate in the program
program_idtext- The program
Example output
{
"membership": {
"affiliate_group_id": null,
"applied_at": "2026-10-01T09:00:00+0000",
"approved": true,
"coupon": "JANE10",
"created_at": "2026-10-01T09:00:00+0000",
"email": "jane@example.com",
"firstname": "Jane",
"id": "janejameson",
"lastname": "Jameson",
"parent_id": null,
"referral_link": {
"asset_id": "ref",
"link": "https://example.com/?ref=janejameson",
"source_id": "janejameson"
}
},
"program_id": "my-program"
}Add note to affiliate
Add a private note to an affiliate. Only your team sees it.
Inputs
- Affiliate
affiliate_idtextRequired - The affiliate. Pick one, or give its id from an earlier step.
- Note
messagetextRequired - The text of the note.
Outputs
noteobject- The new note
Example output
{
"note": {
"created_at": "2026-10-01T09:00:00+0000",
"created_by": {
"firstname": "Alex",
"id": "adminuser",
"lastname": "Admin"
},
"id": 12,
"message": "Met at the conference."
}
}Approve or disapprove affiliate in program
Approve an affiliate so they earn commission in a program, or disapprove them to stop it.
Inputs
- Program
program_idtextRequired - The program. Pick one, or give its id from an earlier step.
- Affiliate
affiliate_idtextRequired - The affiliate. Pick one, or give its id from an earlier step.
- Approval
approvaltextRequired - Approve or disapprove.One of:
approved,disapproved.
Outputs
affiliate_idtext- The affiliate
approvaltext- What was set
membershipobject- The affiliate in the program
program_idtext- The program
Example output
{
"affiliate_id": "janejameson",
"approval": "approved",
"membership": {
"affiliate_group_id": null,
"applied_at": "2026-10-01T09:00:00+0000",
"approved": true,
"coupon": "JANE10",
"created_at": "2026-10-01T09:00:00+0000",
"email": "jane@example.com",
"firstname": "Jane",
"id": "janejameson",
"lastname": "Jameson",
"parent_id": null,
"referral_link": {
"asset_id": "ref",
"link": "https://example.com/?ref=janejameson",
"source_id": "janejameson"
}
},
"program_id": "my-program"
}Approve or disapprove commission
Approve a commission so it can be paid, or disapprove it. Accounts that pay through Tapfiliate Pay cannot undo an approval.
Inputs
- Commission ID
commission_idtextRequired - The commission's number, from 'List commissions' or a conversion.
- Approval
approvaltextRequired - Approve or disapprove.One of:
approved,disapproved.
Outputs
commissionobject- The commission
Example output
{
"commission": {
"affiliate": {
"firstname": "Jane",
"id": "janejameson",
"lastname": "Jameson"
},
"amount": 10,
"approved": true,
"comment": null,
"commission_name": "default",
"commission_type": "default",
"conversion": {
"id": 7
},
"conversion_sub_amount": 100,
"created_at": "2026-10-02T09:00:00+0000",
"currency": "USD",
"final": null,
"id": 1,
"kind": "regular"
}
}Create affiliate
Add an affiliate. They are not in any program yet: use 'Add affiliate to program'. Without a password Tapfiliate makes one and returns it.
Inputs
- Email
emailtextRequired - The affiliate's email address.
- First name
firstnametextRequired - The affiliate's first name.
- Last name
lastnametextRequired - The affiliate's last name.
- Password
passwordtext - Leave empty to have one made for you.
- Company
company_nametext - The affiliate's company name.
- Company description
company_descriptiontext - A short description of the company.
Outputs
affiliateobject- The new affiliate
Example output
{
"affiliate": {
"address": null,
"affiliate_group_id": null,
"company": {
"description": null,
"name": "Jane Co"
},
"created_at": "2026-10-01T09:00:00+0000",
"custom_fields": {},
"email": "jane@example.com",
"firstname": "Jane",
"id": "janejameson",
"lastname": "Jameson",
"meta_data": {},
"parent_id": null,
"password": "generated-password",
"promoted_at": null,
"promotion_method": null
}
}Create affiliate group
Create an affiliate group.
Inputs
- Name
titletextRequired - The group's name.
Outputs
groupobject- The new group
Example output
{
"group": {
"affiliate_count": 3,
"id": "ag_eXampl3",
"title": "VIPs"
}
}Create conversion
Record a sale and credit the affiliate it traces back to. Give one way to find the affiliate: a customer ID, referral code, coupon, click ID or tracking ID. Tapfiliate works out the commission.
Inputs
- Customer ID
customer_idtext - Your own id for a customer already tracked in Tapfiliate (the one you gave 'Create customer'). It only works in a program with lifetime or recurring commissions turned on; otherwise give a coupon, referral code or click ID.
- Referral code
referral_codetext - The affiliate's referral code, such as the end of their referral link.
- Coupon code
coupontext - A coupon code assigned to the affiliate in the program.
- Click ID
click_idtext - A click id from Tapfiliate's tracking, if you have one.
- Tracking ID
tracking_idtext - The tracking id Tapfiliate's script stored for the visitor.
- External ID
external_idtext - Your own id for the sale, such as an order number. It must be unique; Tapfiliate refuses a repeat.
- Amount
amountnumber - The sale amount in the program's currency. Commission is a share of it.At least 0.
- Currency
currencytext - A 3-letter code such as USD, if different from the program's.
- Commission type
commission_typetext - The program's commission type to use. Leave empty for its default.
- Metadata
meta_dataobject - Your own keys and values to keep on the record.
Outputs
conversionobject- The new conversion
Example output
{
"conversion": {
"affiliate": {
"firstname": "Jane",
"id": "janejameson",
"lastname": "Jameson"
},
"amount": 100,
"click": null,
"commissions": [
{
"affiliate": {
"firstname": "Jane",
"id": "janejameson",
"lastname": "Jameson"
},
"amount": 10,
"approved": null,
"comment": null,
"commission_name": "default",
"commission_type": "default",
"conversion": {
"id": 7
},
"conversion_sub_amount": 100,
"created_at": "2026-10-02T09:00:00+0000",
"currency": "USD",
"final": null,
"id": 1,
"kind": "regular"
}
],
"created_at": "2026-10-02T09:00:00+0000",
"customer": {
"customer_id": "user-42",
"id": "cu_0Th3r",
"status": "new"
},
"external_id": "order-1001",
"id": 7,
"meta_data": {},
"program": {
"currency": "USD",
"id": "my-program",
"title": "My program"
},
"tracking_source": "coupon-api",
"warnings": null
}
}Create customer
Track a customer and tie them to the affiliate who referred them, so later sales and recurring commissions go to that affiliate. Give one way to find the affiliate: a referral code, coupon, click ID or tracking ID.
Inputs
- Your customer ID
customer_idtextRequired - Your own id for this customer, such as a user id. It must be unique.
- Referral code
referral_codetext - The affiliate's referral code, such as the end of their referral link.
- Coupon code
coupontext - A coupon code assigned to the affiliate in the program.
- Click ID
click_idtext - A click id from Tapfiliate's tracking, if you have one.
- Tracking ID
tracking_idtext - The tracking id Tapfiliate's script stored for the visitor.
- Status
statustext - Where the customer starts. Defaults to new.One of:
new(New (default)),lead,trial. - Metadata
meta_dataobject - Your own keys and values to keep on the record.
Outputs
customerobject- The new customer
Example output
{
"customer": {
"affiliate": {
"firstname": "Jane",
"id": "janejameson",
"lastname": "Jameson"
},
"click": null,
"created_at": "2026-10-02T09:00:00+0000",
"customer_id": "user-42",
"id": "cu_0Th3r",
"meta_data": {},
"program": {
"currency": "USD",
"id": "my-program",
"title": "My program"
},
"status": "new"
}
}Delete affiliate
Delete an affiliate and their program memberships. This cannot be undone.
Inputs
- Affiliate
affiliate_idtextRequired - The affiliate. Pick one, or give its id from an earlier step.
Outputs
affiliate_idtext- The affiliate deleted
deletedtrue/false- Always true once deleted
Example output
{
"affiliate_id": "janejameson",
"deleted": true
}Delete conversion
Delete a conversion and its commissions. This cannot be undone.
Inputs
- Conversion ID
conversion_idtextRequired - The conversion's number, from 'List conversions' or 'Create conversion'.
Outputs
conversion_idtext- The conversion deleted
deletedtrue/false- Always true once deleted
Example output
{
"conversion_id": "7",
"deleted": true
}Delete customer
Delete a customer. This cannot be undone.
Inputs
- Customer ID
customer_idtextRequired - Tapfiliate's id for the customer (it starts with cu_), from 'List customers' or 'Create customer'.
Outputs
customer_idtext- The customer deleted
deletedtrue/false- Always true once deleted
Example output
{
"customer_id": "cu_0Th3r",
"deleted": true
}Get affiliate
Get one affiliate with their company, address, group and parent.
Inputs
- Affiliate
affiliate_idtextRequired - The affiliate. Pick one, or give its id from an earlier step.
Outputs
affiliateobject- The affiliate
Example output
{
"affiliate": {
"address": null,
"affiliate_group_id": null,
"company": {
"description": null,
"name": "Jane Co"
},
"created_at": "2026-10-01T09:00:00+0000",
"custom_fields": {},
"email": "jane@example.com",
"firstname": "Jane",
"id": "janejameson",
"lastname": "Jameson",
"meta_data": {},
"parent_id": null,
"promoted_at": null,
"promotion_method": null
}
}Get affiliate balances
Get what Tapfiliate owes one affiliate, with one amount per currency.
Inputs
- Affiliate
affiliate_idtextRequired - The affiliate. Pick one, or give its id from an earlier step.
Outputs
affiliate_idtext- The affiliate
balancesobject- Amount owed by currency code, like {"USD": 5}
Example output
{
"affiliate_id": "janejameson",
"balances": {
"USD": 5
}
}Get commission
Get one commission with its amount, status, affiliate and conversion.
Inputs
- Commission ID
commission_idtextRequired - The commission's number, from 'List commissions' or a conversion.
Outputs
commissionobject- The commission
Example output
{
"commission": {
"affiliate": {
"firstname": "Jane",
"id": "janejameson",
"lastname": "Jameson"
},
"amount": 10,
"approved": null,
"comment": null,
"commission_name": "default",
"commission_type": "default",
"conversion": {
"id": 7
},
"conversion_sub_amount": 100,
"created_at": "2026-10-02T09:00:00+0000",
"currency": "USD",
"final": null,
"id": 1,
"kind": "regular"
}
}Get conversion
Get one conversion with its commissions, affiliate and customer.
Inputs
- Conversion ID
conversion_idtextRequired - The conversion's number, from 'List conversions' or 'Create conversion'.
Outputs
conversionobject- The conversion
Example output
{
"conversion": {
"affiliate": {
"firstname": "Jane",
"id": "janejameson",
"lastname": "Jameson"
},
"amount": 100,
"click": null,
"commissions": [
{
"affiliate": {
"firstname": "Jane",
"id": "janejameson",
"lastname": "Jameson"
},
"amount": 10,
"approved": null,
"comment": null,
"commission_name": "default",
"commission_type": "default",
"conversion": {
"id": 7
},
"conversion_sub_amount": 100,
"created_at": "2026-10-02T09:00:00+0000",
"currency": "USD",
"final": null,
"id": 1,
"kind": "regular"
}
],
"created_at": "2026-10-02T09:00:00+0000",
"customer": {
"customer_id": "user-42",
"id": "cu_0Th3r",
"status": "new"
},
"external_id": "order-1001",
"id": 7,
"meta_data": {},
"program": {
"currency": "USD",
"id": "my-program",
"title": "My program"
},
"tracking_source": "coupon-api",
"warnings": null
}
}Get customer
Get one customer with their status, program and affiliate.
Inputs
- Customer ID
customer_idtextRequired - Tapfiliate's id for the customer (it starts with cu_), from 'List customers' or 'Create customer'.
Outputs
customerobject- The customer
Example output
{
"customer": {
"affiliate": {
"firstname": "Jane",
"id": "janejameson",
"lastname": "Jameson"
},
"click": null,
"created_at": "2026-10-02T09:00:00+0000",
"customer_id": "user-42",
"id": "cu_0Th3r",
"meta_data": {},
"program": {
"currency": "USD",
"id": "my-program",
"title": "My program"
},
"status": "new"
}
}Get program
Get one program with its currency, cookie time and recurring settings.
Inputs
- Program
program_idtextRequired - The program. Pick one, or give its id from an earlier step.
Outputs
programobject- The program
Example output
{
"program": {
"contact_email": null,
"cookie_time": 30,
"currency": "USD",
"currency_symbol": "$",
"default_landing_page_url": "https://example.com",
"id": "my-program",
"recurring": false,
"recurring_cap": null,
"recurring_period_days": null,
"status": "active",
"title": "My program"
}
}List affiliate groups
List every affiliate group with how many affiliates it holds.
Inputs
None.
Outputs
countnumber- How many
groupslist- The groups
Example output
{
"count": 1,
"groups": [
{
"affiliate_count": 3,
"id": "ag_eXampl3",
"title": "VIPs"
}
]
}List affiliate notes
List the private notes on one affiliate.
Inputs
- Affiliate
affiliate_idtextRequired - The affiliate. Pick one, or give its id from an earlier step.
Outputs
countnumber- How many
noteslist- The notes
Example output
{
"count": 1,
"notes": [
{
"created_at": "2026-10-01T09:00:00+0000",
"created_by": {
"firstname": "Alex",
"id": "adminuser",
"lastname": "Admin"
},
"id": 12,
"message": "Met at the conference."
}
]
}List affiliates
List affiliates, 25 to a page, optionally by email, referral code, group or parent. Pass 'next_page' as 'Page' for more.
Inputs
- Email
emailtext - Only the affiliate with this email.
- Referral code
referral_codetext - Only this referral code's.
- In affiliate group
affiliate_group_idtext - The affiliate group. Pick one, or give its id from an earlier step.
- Affiliate
parent_idtext - Only this affiliate's. Pick one, or give its id from an earlier step.
- Page
pagenumber - Which page of 25 to get, starting at 1. The result's 'next_page' is the next one.At least 1.
Outputs
affiliateslist- The affiliates
countnumber- How many are on this page
has_moretrue/false- Whether another page follows
next_pagenumber- The number to give as 'Page' for more, empty on the last
pagenumber- The page number returned
Example output
{
"affiliates": [
{
"address": null,
"affiliate_group_id": null,
"company": {
"description": null,
"name": "Jane Co"
},
"created_at": "2026-10-01T09:00:00+0000",
"custom_fields": {},
"email": "jane@example.com",
"firstname": "Jane",
"id": "janejameson",
"lastname": "Jameson",
"meta_data": {},
"parent_id": null,
"promoted_at": null,
"promotion_method": null
}
],
"count": 1,
"has_more": false,
"next_page": null,
"page": 1
}List affiliates in program
List the affiliates in a program, 25 to a page, with their referral links and coupons.
Inputs
- Program
program_idtextRequired - The program. Pick one, or give its id from an earlier step.
- Email
emailtext - Only the affiliate with this email.
- In affiliate group
affiliate_group_idtext - The affiliate group. Pick one, or give its id from an earlier step.
- Page
pagenumber - Which page of 25 to get, starting at 1. The result's 'next_page' is the next one.At least 1.
Outputs
affiliateslist- The affiliates
countnumber- How many are on this page
has_moretrue/false- Whether another page follows
next_pagenumber- The number to give as 'Page' for more, empty on the last
pagenumber- The page number returned
Example output
{
"affiliates": [
{
"affiliate_group_id": null,
"applied_at": "2026-10-01T09:00:00+0000",
"approved": true,
"coupon": "JANE10",
"created_at": "2026-10-01T09:00:00+0000",
"email": "jane@example.com",
"firstname": "Jane",
"id": "janejameson",
"lastname": "Jameson",
"parent_id": null,
"referral_link": {
"asset_id": "ref",
"link": "https://example.com/?ref=janejameson",
"source_id": "janejameson"
}
}
],
"count": 1,
"has_more": false,
"next_page": null,
"page": 1
}List balances
List every affiliate who is owed money, with the amount per currency. Tapfiliate allows this ten times a minute.
Inputs
None.
Outputs
balanceslist- The balances
countnumber- How many
Example output
{
"balances": [
{
"affiliate_id": "janejameson",
"balances": {
"USD": 5
}
}
],
"count": 1
}List commissions
List commissions, 25 to a page, by affiliate, status or whether they are paid. Pass 'next_page' as 'Page' for more.
Inputs
- Affiliate
affiliate_idtext - Only this affiliate's. Pick one, or give its id from an earlier step.
- Status
statustext - Only commissions in this state.One of:
approved,pending,disapproved. - Paid
paidtext - Only paid, or only unpaid, commissions.One of:
1(Paid),0(Not paid). - Page
pagenumber - Which page of 25 to get, starting at 1. The result's 'next_page' is the next one.At least 1.
Outputs
commissionslist- The commissions
countnumber- How many are on this page
has_moretrue/false- Whether another page follows
next_pagenumber- The number to give as 'Page' for more, empty on the last
pagenumber- The page number returned
Example output
{
"commissions": [
{
"affiliate": {
"firstname": "Jane",
"id": "janejameson",
"lastname": "Jameson"
},
"amount": 10,
"approved": null,
"comment": null,
"commission_name": "default",
"commission_type": "default",
"conversion": {
"id": 7
},
"conversion_sub_amount": 100,
"created_at": "2026-10-02T09:00:00+0000",
"currency": "USD",
"final": null,
"id": 1,
"kind": "regular"
}
],
"count": 1,
"has_more": false,
"next_page": null,
"page": 1
}List conversions
List conversions (sales), 25 to a page, by program, affiliate, external id or date. Pass 'next_page' as 'Page' for more.
Inputs
- Program
program_idtext - Only this program's. Pick one, or give its id from an earlier step.
- Affiliate
affiliate_idtext - Only this affiliate's. Pick one, or give its id from an earlier step.
- External ID
external_idtext - Only the conversion with this id from your own system.
- Only pending
pendingtrue/false - Only conversions with commissions waiting for approval.
- From date
date_fromdate - Only those created on or after this day (UTC).
- To date
date_todate - Only those created on or before this day (UTC).
- Page
pagenumber - Which page of 25 to get, starting at 1. The result's 'next_page' is the next one.At least 1.
Outputs
conversionslist- The conversions
countnumber- How many are on this page
has_moretrue/false- Whether another page follows
next_pagenumber- The number to give as 'Page' for more, empty on the last
pagenumber- The page number returned
Example output
{
"conversions": [
{
"affiliate": {
"firstname": "Jane",
"id": "janejameson",
"lastname": "Jameson"
},
"amount": 100,
"click": null,
"commissions": [
{
"affiliate": {
"firstname": "Jane",
"id": "janejameson",
"lastname": "Jameson"
},
"amount": 10,
"approved": null,
"comment": null,
"commission_name": "default",
"commission_type": "default",
"conversion": {
"id": 7
},
"conversion_sub_amount": 100,
"created_at": "2026-10-02T09:00:00+0000",
"currency": "USD",
"final": null,
"id": 1,
"kind": "regular"
}
],
"created_at": "2026-10-02T09:00:00+0000",
"customer": {
"customer_id": "user-42",
"id": "cu_0Th3r",
"status": "new"
},
"external_id": "order-1001",
"id": 7,
"meta_data": {},
"program": {
"currency": "USD",
"id": "my-program",
"title": "My program"
},
"tracking_source": "coupon-api",
"warnings": null
}
],
"count": 1,
"has_more": false,
"next_page": null,
"page": 1
}List customers
List customers, 25 to a page, by program, affiliate, your own customer id or date. Pass 'next_page' as 'Page' for more.
Inputs
- Program
program_idtext - Only this program's. Pick one, or give its id from an earlier step.
- Affiliate
affiliate_idtext - Only this affiliate's. Pick one, or give its id from an earlier step.
- Your customer ID
customer_idtext - Only the customer with this id from your own system.
- From date
date_fromdate - Only those created on or after this day (UTC).
- To date
date_todate - Only those created on or before this day (UTC).
- Page
pagenumber - Which page of 25 to get, starting at 1. The result's 'next_page' is the next one.At least 1.
Outputs
countnumber- How many are on this page
customerslist- The customers
has_moretrue/false- Whether another page follows
next_pagenumber- The number to give as 'Page' for more, empty on the last
pagenumber- The page number returned
Example output
{
"count": 1,
"customers": [
{
"affiliate": {
"firstname": "Jane",
"id": "janejameson",
"lastname": "Jameson"
},
"click": null,
"created_at": "2026-10-02T09:00:00+0000",
"customer_id": "user-42",
"id": "cu_0Th3r",
"meta_data": {},
"program": {
"currency": "USD",
"id": "my-program",
"title": "My program"
},
"status": "new"
}
],
"has_more": false,
"next_page": null,
"page": 1
}List payments
List the payments made to affiliates.
Inputs
None.
Outputs
countnumber- How many
paymentslist- The payments
Example output
{
"count": 1,
"payments": [
{
"affiliate": {
"firstname": "Jane",
"id": "janejameson",
"lastname": "Jameson"
},
"amount": 25,
"created_at": "2026-10-03T09:00:00+0000",
"currency": "USD",
"id": "pa_eXampl3"
}
]
}List programs
List every affiliate program in the account.
Inputs
None.
Outputs
countnumber- How many
programslist- The programs
Example output
{
"count": 1,
"programs": [
{
"contact_email": null,
"cookie_time": 30,
"currency": "USD",
"currency_symbol": "$",
"default_landing_page_url": "https://example.com",
"id": "my-program",
"recurring": false,
"recurring_cap": null,
"recurring_period_days": null,
"status": "active",
"title": "My program"
}
]
}Put affiliate in group
Put an affiliate in an affiliate group, replacing any group they were in.
Inputs
- Affiliate
affiliate_idtextRequired - The affiliate. Pick one, or give its id from an earlier step.
- Affiliate group
group_idtextRequired - The affiliate group. Pick one, or give its id from an earlier step.
Outputs
affiliate_idtext- The affiliate
group_idtext- The group they are now in
resultobject- What Tapfiliate answered
Example output
{
"affiliate_id": "janejameson",
"group_id": "ag_eXampl3",
"result": {}
}Rename affiliate group
Change an affiliate group's name.
Inputs
- Affiliate group
group_idtextRequired - The affiliate group. Pick one, or give its id from an earlier step.
- New name
titletextRequired - The group's new name.
Outputs
groupobject- The group
Example output
{
"group": {
"affiliate_count": 3,
"id": "ag_eXampl3",
"title": "Top partners"
}
}Update conversion
Change a conversion's amount, external id or metadata. Only the fields given change.
Inputs
- Conversion ID
conversion_idtextRequired - The conversion's number, from 'List conversions' or 'Create conversion'.
- Amount
amountnumber - The corrected sale amount.At least 0.
- External ID
external_idtext - A new id from your own system.
- Recalculate commissions
recalculate_commissionstrue/false - Also recalculate the commissions when the amount changes.
- Metadata
meta_dataobject - Your own keys and values to keep on the record.
Outputs
conversionobject- The conversion
Example output
{
"conversion": {
"affiliate": {
"firstname": "Jane",
"id": "janejameson",
"lastname": "Jameson"
},
"amount": 120,
"click": null,
"commissions": [
{
"affiliate": {
"firstname": "Jane",
"id": "janejameson",
"lastname": "Jameson"
},
"amount": 10,
"approved": null,
"comment": null,
"commission_name": "default",
"commission_type": "default",
"conversion": {
"id": 7
},
"conversion_sub_amount": 100,
"created_at": "2026-10-02T09:00:00+0000",
"currency": "USD",
"final": null,
"id": 1,
"kind": "regular"
}
],
"created_at": "2026-10-02T09:00:00+0000",
"customer": {
"customer_id": "user-42",
"id": "cu_0Th3r",
"status": "new"
},
"external_id": "order-1001",
"id": 7,
"meta_data": {},
"program": {
"currency": "USD",
"id": "my-program",
"title": "My program"
},
"tracking_source": "coupon-api",
"warnings": null
}
}