/tapfiliate | Type: Application | PCID required: Yes
Tools
tapfiliate_add_affiliate_to_program
Add affiliate to program Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
program_id | string | Yes | — | The program ID |
affiliate | object | Yes | — | The affiliate value |
approved | boolean | No | — | Whether the affiliate is approved for the program |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"program_id": {
"type": "string",
"description": "The program ID"
},
"affiliate": {
"type": "object",
"description": "The affiliate value",
"properties": {
"id": {
"type": "string",
"description": "The affiliate ID to add"
}
},
"required": [
"id"
]
},
"approved": {
"type": "boolean",
"description": "Whether the affiliate is approved for the program"
}
},
"required": [
"PCID",
"program_id",
"affiliate"
]
}
tapfiliate_add_conversion_commissions
Add commissions to conversion Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
conversion_id | integer | Yes | — | The conversion ID |
comment | string | No | — | Comment for the commission |
commission_type | string | No | — | Commission type to apply |
conversion_sub_amount | number | Yes | — | Sub-amount for commission calculation |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"conversion_id": {
"type": "integer",
"description": "The conversion ID"
},
"comment": {
"type": "string",
"description": "Comment for the commission"
},
"commission_type": {
"type": "string",
"description": "Commission type to apply"
},
"conversion_sub_amount": {
"type": "number",
"description": "Sub-amount for commission calculation"
}
},
"required": [
"PCID",
"conversion_id",
"conversion_sub_amount"
]
}
tapfiliate_approve_affiliate_for_program
Approve affiliate for program Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
program_id | string | Yes | — | The program ID |
affiliate_id | string | Yes | — | The affiliate ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"program_id": {
"type": "string",
"description": "The program ID"
},
"affiliate_id": {
"type": "string",
"description": "The affiliate ID"
}
},
"required": [
"PCID",
"program_id",
"affiliate_id"
]
}
tapfiliate_approve_commission
Approve commission Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
commission_id | integer | Yes | — | The commission ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"commission_id": {
"type": "integer",
"description": "The commission ID"
}
},
"required": [
"PCID",
"commission_id"
]
}
tapfiliate_create_affiliate
Create affiliate Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
address | object | No | — | Address information |
company | object | No | — | Company information |
email | string | Yes | — | Affiliate’s email address |
firstname | string | Yes | — | Affiliate’s first name |
lastname | string | Yes | — | Affiliate’s last name |
meta_data | object | No | — | Custom metadata key-value pairs |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"address": {
"type": "object",
"description": "Address information",
"properties": {
"address": {
"type": "string",
"description": "The address value"
},
"postal_code": {
"type": "string",
"description": "Postal Code"
},
"city": {
"type": "string",
"description": "The city value"
},
"state": {
"type": "string",
"description": "The state value"
},
"country": {
"type": "string",
"description": "The country value"
}
}
},
"company": {
"type": "object",
"description": "Company information",
"properties": {
"name": {
"type": "string",
"description": "The name value"
},
"description": {
"type": "string",
"description": "The description value"
}
}
},
"email": {
"type": "string",
"description": "Affiliate's email address"
},
"firstname": {
"type": "string",
"description": "Affiliate's first name"
},
"lastname": {
"type": "string",
"description": "Affiliate's last name"
},
"meta_data": {
"type": "object",
"description": "Custom metadata key-value pairs"
}
},
"required": [
"PCID",
"email",
"firstname",
"lastname"
]
}
tapfiliate_create_affiliate_group
Create affiliate group Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
title | string | Yes | — | Group title |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"title": {
"type": "string",
"description": "Group title"
}
},
"required": [
"PCID",
"title"
]
}
tapfiliate_create_affiliate_prospect
Create affiliate prospect Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
email | string | Yes | — | Prospect email address |
firstname | string | No | — | Prospect first name |
lastname | string | No | — | Prospect last name |
program | object | No | — | Program to associate with |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"email": {
"type": "string",
"description": "Prospect email address"
},
"firstname": {
"type": "string",
"description": "Prospect first name"
},
"lastname": {
"type": "string",
"description": "Prospect last name"
},
"program": {
"type": "object",
"description": "Program to associate with",
"properties": {
"id": {
"type": "string",
"description": "The id value"
}
}
}
},
"required": [
"PCID",
"email"
]
}
tapfiliate_create_click
Record click Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
asset_id | string | No | — | Asset ID |
ip | string | No | — | IP address |
landing_page | string | No | — | Landing page URL |
meta_data | object | No | — | Custom metadata |
referral_code | string | Yes | — | Referral code for the click |
referrer | string | No | — | Referrer URL |
source_id | string | No | — | Source ID |
user_agent | string | No | — | User agent string |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"asset_id": {
"type": "string",
"description": "Asset ID"
},
"ip": {
"type": "string",
"description": "IP address"
},
"landing_page": {
"type": "string",
"description": "Landing page URL"
},
"meta_data": {
"type": "object",
"description": "Custom metadata"
},
"referral_code": {
"type": "string",
"description": "Referral code for the click"
},
"referrer": {
"type": "string",
"description": "Referrer URL"
},
"source_id": {
"type": "string",
"description": "Source ID"
},
"user_agent": {
"type": "string",
"description": "User agent string"
}
},
"required": [
"PCID",
"referral_code"
]
}
tapfiliate_create_conversion
Create conversion Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
override_max_cookie_time | boolean | No | — | Override the maximum cookie time for attribution |
amount | number | No | — | Conversion amount |
asset_id | string | No | — | Asset ID |
click_id | string | No | — | Click ID for attribution |
commission_type | string | No | — | Commission type to apply |
commissions | object[] | No | — | Array of commission overrides |
coupon | string | No | — | Coupon code for attribution |
currency | string | No | — | Currency code (e.g., USD, EUR) |
customer_id | string | No | — | Customer ID to associate with the conversion |
external_id | string | No | — | External identifier for the conversion (e.g., order ID) |
ip | string | No | — | IP address |
meta_data | object | No | — | Custom metadata key-value pairs |
program_group | string | No | — | Program group identifier |
referral_code | string | No | — | Referral code for attribution |
source_id | string | No | — | Source ID |
tracking_id | string | No | — | Tracking ID for attribution |
user_agent | string | No | — | User agent string |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"override_max_cookie_time": {
"type": "boolean",
"description": "Override the maximum cookie time for attribution"
},
"amount": {
"type": "number",
"description": "Conversion amount"
},
"asset_id": {
"type": "string",
"description": "Asset ID"
},
"click_id": {
"type": "string",
"description": "Click ID for attribution"
},
"commission_type": {
"type": "string",
"description": "Commission type to apply"
},
"commissions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"commission_type": {
"type": "string",
"description": "Commission Type"
},
"amount": {
"type": "number",
"description": "The amount value"
}
}
},
"description": "Array of commission overrides"
},
"coupon": {
"type": "string",
"description": "Coupon code for attribution"
},
"currency": {
"type": "string",
"description": "Currency code (e.g., USD, EUR)"
},
"customer_id": {
"type": "string",
"description": "Customer ID to associate with the conversion"
},
"external_id": {
"type": "string",
"description": "External identifier for the conversion (e.g., order ID)"
},
"ip": {
"type": "string",
"description": "IP address"
},
"meta_data": {
"type": "object",
"description": "Custom metadata key-value pairs"
},
"program_group": {
"type": "string",
"description": "Program group identifier"
},
"referral_code": {
"type": "string",
"description": "Referral code for attribution"
},
"source_id": {
"type": "string",
"description": "Source ID"
},
"tracking_id": {
"type": "string",
"description": "Tracking ID for attribution"
},
"user_agent": {
"type": "string",
"description": "User agent string"
}
},
"required": [
"PCID"
]
}
tapfiliate_create_customer
Create customer Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
override_max_cookie_time | boolean | No | — | Override the maximum cookie time for attribution |
asset_id | string | No | — | Asset ID |
click_id | string | No | — | Click ID for attribution |
coupon | string | No | — | Coupon code for attribution |
customer_id | string | Yes | — | Unique customer identifier |
ip | string | No | — | IP address |
meta_data | object | No | — | Custom metadata key-value pairs |
referral_code | string | No | — | Referral code for attribution |
source_id | string | No | — | Source ID |
status | string | No | — | Customer status (e.g., trial, paying) |
tracking_id | string | No | — | Tracking ID for attribution |
user_agent | string | No | — | User agent string |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"override_max_cookie_time": {
"type": "boolean",
"description": "Override the maximum cookie time for attribution"
},
"asset_id": {
"type": "string",
"description": "Asset ID"
},
"click_id": {
"type": "string",
"description": "Click ID for attribution"
},
"coupon": {
"type": "string",
"description": "Coupon code for attribution"
},
"customer_id": {
"type": "string",
"description": "Unique customer identifier"
},
"ip": {
"type": "string",
"description": "IP address"
},
"meta_data": {
"type": "object",
"description": "Custom metadata key-value pairs"
},
"referral_code": {
"type": "string",
"description": "Referral code for attribution"
},
"source_id": {
"type": "string",
"description": "Source ID"
},
"status": {
"type": "string",
"description": "Customer status (e.g., trial, paying)"
},
"tracking_id": {
"type": "string",
"description": "Tracking ID for attribution"
},
"user_agent": {
"type": "string",
"description": "User agent string"
}
},
"required": [
"PCID",
"customer_id"
]
}
tapfiliate_create_payment
Create payment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
affiliate_id | string | Yes | — | The affiliate to pay |
commission_ids | integer[] | No | — | List of commission IDs to include in this payment |
currency | string | No | — | Payment currency code |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"affiliate_id": {
"type": "string",
"description": "The affiliate to pay"
},
"commission_ids": {
"type": "array",
"items": {
"type": "integer"
},
"description": "List of commission IDs to include in this payment"
},
"currency": {
"type": "string",
"description": "Payment currency code"
}
},
"required": [
"PCID",
"affiliate_id"
]
}
tapfiliate_delete_affiliate
Delete affiliate Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
affiliate_id | string | Yes | — | The affiliate ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"affiliate_id": {
"type": "string",
"description": "The affiliate ID"
}
},
"required": [
"PCID",
"affiliate_id"
]
}
tapfiliate_delete_affiliate_prospect
Delete affiliate prospect Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
prospect_id | string | Yes | — | The prospect ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"prospect_id": {
"type": "string",
"description": "The prospect ID"
}
},
"required": [
"PCID",
"prospect_id"
]
}
tapfiliate_delete_conversion
Delete conversion Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
conversion_id | integer | Yes | — | The conversion ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"conversion_id": {
"type": "integer",
"description": "The conversion ID"
}
},
"required": [
"PCID",
"conversion_id"
]
}
tapfiliate_delete_customer
Delete customer Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
customer_id | string | Yes | — | The customer ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"customer_id": {
"type": "string",
"description": "The customer ID"
}
},
"required": [
"PCID",
"customer_id"
]
}
tapfiliate_delete_payment
Cancel payment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
payment_id | integer | Yes | — | The payment ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"payment_id": {
"type": "integer",
"description": "The payment ID"
}
},
"required": [
"PCID",
"payment_id"
]
}
tapfiliate_disapprove_affiliate_for_program
Disapprove affiliate for program Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
program_id | string | Yes | — | The program ID |
affiliate_id | string | Yes | — | The affiliate ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"program_id": {
"type": "string",
"description": "The program ID"
},
"affiliate_id": {
"type": "string",
"description": "The affiliate ID"
}
},
"required": [
"PCID",
"program_id",
"affiliate_id"
]
}
tapfiliate_disapprove_commission
Disapprove commission Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
commission_id | integer | Yes | — | The commission ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"commission_id": {
"type": "integer",
"description": "The commission ID"
}
},
"required": [
"PCID",
"commission_id"
]
}
tapfiliate_get_affiliate
Get affiliate Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
affiliate_id | string | Yes | — | The affiliate ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"affiliate_id": {
"type": "string",
"description": "The affiliate ID"
}
},
"required": [
"PCID",
"affiliate_id"
]
}
tapfiliate_get_affiliate_balances
Get affiliate balances Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
affiliate_id | string | Yes | — | The affiliate ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"affiliate_id": {
"type": "string",
"description": "The affiliate ID"
}
},
"required": [
"PCID",
"affiliate_id"
]
}
tapfiliate_get_affiliate_metadata
Get affiliate metadata Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
affiliate_id | string | Yes | — | The affiliate ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"affiliate_id": {
"type": "string",
"description": "The affiliate ID"
}
},
"required": [
"PCID",
"affiliate_id"
]
}
tapfiliate_get_affiliate_prospect
Get affiliate prospect Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
prospect_id | string | Yes | — | The prospect ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"prospect_id": {
"type": "string",
"description": "The prospect ID"
}
},
"required": [
"PCID",
"prospect_id"
]
}
tapfiliate_get_click
Get click Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
click_id | string | Yes | — | The click ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"click_id": {
"type": "string",
"description": "The click ID"
}
},
"required": [
"PCID",
"click_id"
]
}
tapfiliate_get_commission
Get commission Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
commission_id | integer | Yes | — | The commission ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"commission_id": {
"type": "integer",
"description": "The commission ID"
}
},
"required": [
"PCID",
"commission_id"
]
}
tapfiliate_get_conversion
Get conversion Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
conversion_id | integer | Yes | — | The conversion ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"conversion_id": {
"type": "integer",
"description": "The conversion ID"
}
},
"required": [
"PCID",
"conversion_id"
]
}
tapfiliate_get_conversion_metadata
Get conversion metadata Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
conversion_id | integer | Yes | — | The conversion ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"conversion_id": {
"type": "integer",
"description": "The conversion ID"
}
},
"required": [
"PCID",
"conversion_id"
]
}
tapfiliate_get_customer
Get customer Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
customer_id | string | Yes | — | The customer ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"customer_id": {
"type": "string",
"description": "The customer ID"
}
},
"required": [
"PCID",
"customer_id"
]
}
tapfiliate_get_customer_metadata
Get customer metadata Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
customer_id | string | Yes | — | The customer ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"customer_id": {
"type": "string",
"description": "The customer ID"
}
},
"required": [
"PCID",
"customer_id"
]
}
tapfiliate_get_payment
Get payment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
payment_id | integer | Yes | — | The payment ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"payment_id": {
"type": "integer",
"description": "The payment ID"
}
},
"required": [
"PCID",
"payment_id"
]
}
tapfiliate_get_program
Get program Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
program_id | string | Yes | — | The program ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"program_id": {
"type": "string",
"description": "The program ID"
}
},
"required": [
"PCID",
"program_id"
]
}
tapfiliate_list_affiliate_groups
List affiliate groups Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | Page number for pagination |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"page": {
"type": "integer",
"description": "Page number for pagination"
}
},
"required": [
"PCID"
]
}
tapfiliate_list_affiliate_programs
List affiliate programs Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
affiliate_id | string | Yes | — | The affiliate ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"affiliate_id": {
"type": "string",
"description": "The affiliate ID"
}
},
"required": [
"PCID",
"affiliate_id"
]
}
tapfiliate_list_affiliate_prospects
List affiliate prospects Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | Page number for pagination |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"page": {
"type": "integer",
"description": "Page number for pagination"
}
},
"required": [
"PCID"
]
}
tapfiliate_list_affiliates
List affiliates Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | Page number for pagination |
click_id | string | No | — | Filter by click ID |
source_id | string | No | — | Filter by source ID |
email | string | No | — | Filter by email address |
referral_code | string | No | — | Filter by referral code |
parent_id | string | No | — | Filter by parent affiliate ID (MLM) |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"page": {
"type": "integer",
"description": "Page number for pagination"
},
"click_id": {
"type": "string",
"description": "Filter by click ID"
},
"source_id": {
"type": "string",
"description": "Filter by source ID"
},
"email": {
"type": "string",
"description": "Filter by email address"
},
"referral_code": {
"type": "string",
"description": "Filter by referral code"
},
"parent_id": {
"type": "string",
"description": "Filter by parent affiliate ID (MLM)"
}
},
"required": [
"PCID"
]
}
tapfiliate_list_clicks
List clicks Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | Page number for pagination |
program_id | string | No | — | Filter by program ID |
affiliate_id | string | No | — | Filter by affiliate ID |
asset_id | string | No | — | Filter by asset ID |
source_id | string | No | — | Filter by source ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"page": {
"type": "integer",
"description": "Page number for pagination"
},
"program_id": {
"type": "string",
"description": "Filter by program ID"
},
"affiliate_id": {
"type": "string",
"description": "Filter by affiliate ID"
},
"asset_id": {
"type": "string",
"description": "Filter by asset ID"
},
"source_id": {
"type": "string",
"description": "Filter by source ID"
}
},
"required": [
"PCID"
]
}
tapfiliate_list_commissions
List commissions Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | Page number for pagination |
commission_type | string | No | — | Filter by commission type |
affiliate_id | string | No | — | Filter by affiliate ID |
conversion_id | integer | No | — | Filter by conversion ID |
program_id | string | No | — | Filter by program ID |
pending | boolean | No | — | Filter by pending status |
date_from | string | No | — | Filter from date (YYYY-MM-DD) |
date_to | string | No | — | Filter to date (YYYY-MM-DD) |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"page": {
"type": "integer",
"description": "Page number for pagination"
},
"commission_type": {
"type": "string",
"description": "Filter by commission type"
},
"affiliate_id": {
"type": "string",
"description": "Filter by affiliate ID"
},
"conversion_id": {
"type": "integer",
"description": "Filter by conversion ID"
},
"program_id": {
"type": "string",
"description": "Filter by program ID"
},
"pending": {
"type": "boolean",
"description": "Filter by pending status"
},
"date_from": {
"type": "string",
"description": "Filter from date (YYYY-MM-DD)"
},
"date_to": {
"type": "string",
"description": "Filter to date (YYYY-MM-DD)"
}
},
"required": [
"PCID"
]
}
tapfiliate_list_conversions
List conversions Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | Page number for pagination |
program_id | string | No | — | Filter by program ID |
external_id | string | No | — | Filter by external ID |
affiliate_id | string | No | — | Filter by affiliate ID |
pending | boolean | No | — | Filter by pending status (true/false) |
date_from | string | No | — | Filter conversions from this date (YYYY-MM-DD) |
date_to | string | No | — | Filter conversions up to this date (YYYY-MM-DD) |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"page": {
"type": "integer",
"description": "Page number for pagination"
},
"program_id": {
"type": "string",
"description": "Filter by program ID"
},
"external_id": {
"type": "string",
"description": "Filter by external ID"
},
"affiliate_id": {
"type": "string",
"description": "Filter by affiliate ID"
},
"pending": {
"type": "boolean",
"description": "Filter by pending status (true/false)"
},
"date_from": {
"type": "string",
"description": "Filter conversions from this date (YYYY-MM-DD)"
},
"date_to": {
"type": "string",
"description": "Filter conversions up to this date (YYYY-MM-DD)"
}
},
"required": [
"PCID"
]
}
tapfiliate_list_customers
List customers Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | Page number for pagination |
program_id | string | No | — | Filter by program ID |
customer_id | string | No | — | Filter by customer ID |
affiliate_id | string | No | — | Filter by affiliate ID |
date_from | string | No | — | Filter from date (YYYY-MM-DD) |
date_to | string | No | — | Filter to date (YYYY-MM-DD) |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"page": {
"type": "integer",
"description": "Page number for pagination"
},
"program_id": {
"type": "string",
"description": "Filter by program ID"
},
"customer_id": {
"type": "string",
"description": "Filter by customer ID"
},
"affiliate_id": {
"type": "string",
"description": "Filter by affiliate ID"
},
"date_from": {
"type": "string",
"description": "Filter from date (YYYY-MM-DD)"
},
"date_to": {
"type": "string",
"description": "Filter to date (YYYY-MM-DD)"
}
},
"required": [
"PCID"
]
}
tapfiliate_list_payment_balances
List payment balances Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | Page number for pagination |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"page": {
"type": "integer",
"description": "Page number for pagination"
}
},
"required": [
"PCID"
]
}
tapfiliate_list_payments
List payments Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | Page number for pagination |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"page": {
"type": "integer",
"description": "Page number for pagination"
}
},
"required": [
"PCID"
]
}
tapfiliate_list_program_affiliates
List program affiliates Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
program_id | string | Yes | — | The program ID |
page | integer | No | — | Page number for pagination |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"program_id": {
"type": "string",
"description": "The program ID"
},
"page": {
"type": "integer",
"description": "Page number for pagination"
}
},
"required": [
"PCID",
"program_id"
]
}
tapfiliate_list_program_commission_types
List program commission types Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
program_id | string | Yes | — | The program ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"program_id": {
"type": "string",
"description": "The program ID"
}
},
"required": [
"PCID",
"program_id"
]
}
tapfiliate_list_programs
List programs Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | Page number for pagination (1-based, 25 items per page) |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"page": {
"type": "integer",
"description": "Page number for pagination (1-based, 25 items per page)"
}
},
"required": [
"PCID"
]
}
tapfiliate_replace_affiliate_metadata
Replace affiliate metadata Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
affiliate_id | string | Yes | — | The affiliate ID |
body | object | Yes | — | Metadata key-value pairs to set |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"affiliate_id": {
"type": "string",
"description": "The affiliate ID"
},
"body": {
"type": "object",
"description": "Metadata key-value pairs to set"
}
},
"required": [
"PCID",
"affiliate_id",
"body"
]
}
tapfiliate_replace_conversion_metadata
Replace conversion metadata Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
conversion_id | integer | Yes | — | The conversion ID |
body | object | Yes | — | Metadata key-value pairs to set |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"conversion_id": {
"type": "integer",
"description": "The conversion ID"
},
"body": {
"type": "object",
"description": "Metadata key-value pairs to set"
}
},
"required": [
"PCID",
"conversion_id",
"body"
]
}
tapfiliate_replace_customer_metadata
Replace customer metadata Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
customer_id | string | Yes | — | The customer ID |
body | object | Yes | — | Metadata key-value pairs to set |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"customer_id": {
"type": "string",
"description": "The customer ID"
},
"body": {
"type": "object",
"description": "Metadata key-value pairs to set"
}
},
"required": [
"PCID",
"customer_id",
"body"
]
}
tapfiliate_update_commission
Update commission Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
commission_id | integer | Yes | — | The commission ID |
amount | number | No | — | Updated commission amount |
comment | string | No | — | Commission comment |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"commission_id": {
"type": "integer",
"description": "The commission ID"
},
"amount": {
"type": "number",
"description": "Updated commission amount"
},
"comment": {
"type": "string",
"description": "Commission comment"
}
},
"required": [
"PCID",
"commission_id"
]
}
tapfiliate_update_conversion
Update conversion Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
conversion_id | integer | Yes | — | The conversion ID |
recalculate_commissions | boolean | No | — | Recalculate commissions after updating |
amount | number | No | — | Updated conversion amount |
external_id | string | No | — | Updated external ID |
meta_data | object | No | — | Updated metadata |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"conversion_id": {
"type": "integer",
"description": "The conversion ID"
},
"recalculate_commissions": {
"type": "boolean",
"description": "Recalculate commissions after updating"
},
"amount": {
"type": "number",
"description": "Updated conversion amount"
},
"external_id": {
"type": "string",
"description": "Updated external ID"
},
"meta_data": {
"type": "object",
"description": "Updated metadata"
}
},
"required": [
"PCID",
"conversion_id"
]
}
tapfiliate_update_customer
Update customer Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
customer_id | string | Yes | — | The customer ID |
meta_data | object | No | — | Updated metadata |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"customer_id": {
"type": "string",
"description": "The customer ID"
},
"meta_data": {
"type": "object",
"description": "Updated metadata"
}
},
"required": [
"PCID",
"customer_id"
]
}

