Integrations
Post Affiliate Pro
28 actions for Post Affiliate Pro.
Chargeback Transaction#
Process a chargeback for a transaction in PostAffiliatePro.
Plans: Trial, Starter, Pro, Premium, Enterprise · Type: PapChargebackTransaction
Inputs#
| Field | Type | Required | Default | What it does |
|---|---|---|---|---|
| Transaction ID | Text | No | (empty) | The ID of the transaction to chargeback. |
| Fee | Text | No | (empty) | Chargeback fee amount. |
| Note | Text | No | (empty) | Note for the chargeback. |
Outputs#
| Output | Type |
|---|---|
| Data | Object |
Use as an agent tool#
Tool name: pap_chargeback_transaction
Process a chargeback for a transaction
Create Affiliate#
Create a new affiliate account in PostAffiliatePro.
Plans: Trial, Starter, Pro, Premium, Enterprise · Type: PapCreateAffiliate
Inputs#
| Field | Type | Required | Default | What it does |
|---|---|---|---|---|
| Username | Text | No | (empty) | Username for the new affiliate account. |
| Full Name | Text | No | (empty) | Full name of the affiliate. |
| Password | Text | No | (empty) | Password for the new affiliate account. |
| Notification Email | Text | No | (empty) | Email address for affiliate notifications. |
| Referral ID | Text | No | (empty) | Referral ID for the affiliate. |
| Parent ID | Text | No | (empty) | Parent affiliate ID for multi-tier setups. |
Outputs#
| Output | Type |
|---|---|
| Data | Object |
Use as an agent tool#
Tool name: pap_create_affiliate
Create a new affiliate account
Create Recurring Commission#
Create a recurring commission for an order in PostAffiliatePro.
Plans: Trial, Starter, Pro, Premium, Enterprise · Type: PapCreateRecurringCommission
Inputs#
| Field | Type | Required | Default | What it does |
|---|---|---|---|---|
| Order ID | Text | No | (empty) | The order ID for the recurring commission. |
| Total Cost | Text | No | 0 | Recurring transaction amount. |
Outputs#
| Output | Type |
|---|---|
| Data | Object |
Use as an agent tool#
Tool name: pap_create_recurring_commission
Create a recurring commission for an order
Create Transaction#
Create a new transaction in PostAffiliatePro.
Plans: Trial, Starter, Pro, Premium, Enterprise · Type: PapCreateTransaction
Inputs#
| Field | Type | Required | Default | What it does |
|---|---|---|---|---|
| Order ID | Text | No | (empty) | The order ID for the transaction. |
| Affiliate ID | Text | No | (empty) | The affiliate ID for the transaction. |
| Campaign ID | Text | No | (empty) | The campaign ID for the transaction. |
| Total Cost | Text | No | 0 | Total cost of the transaction. |
Outputs#
| Output | Type |
|---|---|
| Data | Object |
Use as an agent tool#
Tool name: pap_create_transaction
Create a new transaction/sale in PostAffiliatePro
Delete Affiliate#
Delete an affiliate account in PostAffiliatePro.
Plans: Trial, Starter, Pro, Premium, Enterprise · Type: PapDeleteAffiliate
Inputs#
| Field | Type | Required | Default | What it does |
|---|---|---|---|---|
| Affiliate ID | Text | No | (empty) | The ID of the affiliate to delete. |
Outputs#
| Output | Type |
|---|---|
| Data | Object |
Use as an agent tool#
Tool name: pap_delete_affiliate
Delete an affiliate account
Get Affiliate Details#
Get detailed information about a specific affiliate in PostAffiliatePro.
Plans: Trial, Starter, Pro, Premium, Enterprise · Type: PapGetAffiliateDetails
Inputs#
| Field | Type | Required | Default | What it does |
|---|---|---|---|---|
| Affiliate ID | Text | No | (empty) | The ID of the affiliate to retrieve. |
Outputs#
| Output | Type |
|---|---|
| Data | Object |
Use as an agent tool#
Tool name: pap_get_affiliate_details
Get detailed information about a specific affiliate
Get Affiliate General Link#
Get the general tracking link for an affiliate in PostAffiliatePro.
Plans: Trial, Starter, Pro, Premium, Enterprise · Type: PapGetAffiliateGeneralLink
Inputs#
| Field | Type | Required | Default | What it does |
|---|---|---|---|---|
| Affiliate ID | Text | No | (empty) | The ID of the affiliate to get the general link for. |
Outputs#
| Output | Type |
|---|---|
| Data | Object |
Use as an agent tool#
Tool name: pap_get_affiliate_general_link
Get the general/default tracking link for an affiliate
Get Affiliate Performance#
Get affiliate performance metrics from PostAffiliatePro.
Plans: Trial, Starter, Pro, Premium, Enterprise · Type: PapGetAffiliatePerformance
Inputs#
| Field | Type | Required | Default | What it does |
|---|---|---|---|---|
| Affiliate ID | Text | No | (empty) | Filter performance metrics by affiliate ID. |
| Date From | Text | No | (empty) | Start date for the performance period. |
| Date To | Text | No | (empty) | End date for the performance period. |
| Limit | Number | No | 100 | Maximum number of results to return (default: 100). |
| Offset | Number | No | 0 | Number of results to skip (default: 0). |
Outputs#
| Output | Type |
|---|---|
| Data | Object |
Use as an agent tool#
Tool name: pap_get_affiliate_performance
Get affiliate performance metrics and statistics
Get Banner Details#
Get detailed information about a specific banner in PostAffiliatePro.
Plans: Trial, Starter, Pro, Premium, Enterprise · Type: PapGetBannerDetails
Inputs#
| Field | Type | Required | Default | What it does |
|---|---|---|---|---|
| Banner ID | Text | No | (empty) | The ID of the banner to retrieve. |
Outputs#
| Output | Type |
|---|---|
| Data | Object |
Use as an agent tool#
Tool name: pap_get_banner_details
Get detailed information about a specific banner
Get Campaign Details#
Get detailed information about a specific campaign in PostAffiliatePro.
Plans: Trial, Starter, Pro, Premium, Enterprise · Type: PapGetCampaignDetails
Inputs#
| Field | Type | Required | Default | What it does |
|---|---|---|---|---|
| Campaign ID | Text | No | (empty) | The ID of the campaign to retrieve. |
Outputs#
| Output | Type |
|---|---|
| Data | Object |
Use as an agent tool#
Tool name: pap_get_campaign_details
Get detailed information about a specific campaign
Get Form Fields#
Get affiliate form field definitions from PostAffiliatePro.
Plans: Trial, Starter, Pro, Premium, Enterprise · Type: PapGetFormFields
Outputs#
| Output | Type |
|---|---|
| Data | Object |
Use as an agent tool#
Tool name: pap_get_form_fields
Get affiliate form field definitions to understand what data1-data25 fields represent
Get Settings#
Get system settings from PostAffiliatePro.
Plans: Trial, Starter, Pro, Premium, Enterprise · Type: PapGetSettings
Outputs#
| Output | Type |
|---|---|
| Data | Object |
Use as an agent tool#
Tool name: pap_get_settings
Get PostAffiliatePro system settings
Get Top Affiliates#
Get top performing affiliates report from PostAffiliatePro.
Plans: Trial, Starter, Pro, Premium, Enterprise · Type: PapGetTopAffiliates
Inputs#
| Field | Type | Required | Default | What it does |
|---|---|---|---|---|
| Period From | Text | No | (empty) | Start date for the report period. |
| Period To | Text | No | (empty) | End date for the report period. |
| Period | Text | No | none | Predefined period for the report. Options: today, yesterday, this_week, last_week, last_working_week, this_month, last_month, this_year, last_year, this_quarter, last_quarter, last_7_days and 4 more |
| Limit | Number | No | 10 | Maximum number of top affiliates to return (default: 10). |
| Sort By | Text | No | (empty) | Sort results by specified field. for example: ‘created_at’, ‘-created_at’, ’name’, etc. |
| Affiliate ID | Text | No | (empty) | Filter by specific affiliate ID. |
| Username | Text | No | (empty) | Filter by affiliate username. |
| First Name | Text | No | (empty) | Filter by affiliate first name. |
| Last Name | Text | No | (empty) | Filter by affiliate last name. |
| Status | Text | No | none | Filter by affiliate status. Options: approved, pending, declined, none |
| Created At | Text | No | (empty) | Filter by creation date. |
| Transaction Status | Text | No | — | Only count transactions in these statuses towards each affiliate’s totals. Select none to count all. Options: approved, pending, declined |
| Campaign ID | Text | No | (empty) | Filter transactions by campaign ID. |
| Banner ID | Text | No | (empty) | Filter transactions by banner ID. |
| Fields | Text | No | id, affiliate_first_name, affiliate_last_name, … | Comma-separated list of fields to include in the report. Options: id, affiliate_first_name, affiliate_last_name, affiliate_status, created_at, count, totalcost, commission, sales_count, sales_totalcost, sales_commission, avg_amount_of_order and 24 more |
Outputs#
| Output | Type |
|---|---|
| Data | Object |
Use as an agent tool#
Tool name: pap_get_top_affiliates
Get top performing affiliates report with ranking by various metrics
Get Traffic Overview#
Get traffic overview with analytics data from PostAffiliatePro.
Plans: Trial, Starter, Pro, Premium, Enterprise · Type: PapGetTrafficOverview
Inputs#
| Field | Type | Required | Default | What it does |
|---|---|---|---|---|
| Period | Text | No | none | Predefined period for the traffic overview. Options: today, yesterday, this_week, last_week, last_working_week, this_month, last_month, this_year, last_year, this_quarter, last_quarter, last_7_days and 4 more |
| Period From | Text | No | (empty) | Start date for the traffic overview period (YYYY-MM-DD). |
| Period To | Text | No | (empty) | End date for the traffic overview period (YYYY-MM-DD). |
| Affiliate ID | Text | No | (empty) | Filter traffic overview by affiliate ID. |
| Campaign ID | Text | No | (empty) | Filter traffic overview by campaign ID. |
Outputs#
| Output | Type |
|---|---|
| Data | Object |
Use as an agent tool#
Tool name: pap_get_traffic_overview
Get traffic overview with analytics data including clicks, transactions, and conversion rates. Use either ‘period’ (predefined shortcut such as ‘yesterday’ or ’last_7_days’) or the ‘period_from’ + ‘period_to’ date pair to scope the report - the legacy ‘date_from’ / ‘date_to’ params are not accepted by PostAffiliatePro and cause it to fall back to this-month.
Get Transaction Details#
Get detailed information about a specific transaction in PostAffiliatePro.
Plans: Trial, Starter, Pro, Premium, Enterprise · Type: PapGetTransactionDetails
Inputs#
| Field | Type | Required | Default | What it does |
|---|---|---|---|---|
| Transaction ID | Text | No | (empty) | The ID of the transaction to retrieve. |
Outputs#
| Output | Type |
|---|---|
| Data | Object |
Use as an agent tool#
Tool name: pap_get_transaction_details
Get detailed information about a specific transaction
Get Transaction Reports#
Get detailed transaction reports from PostAffiliatePro.
Plans: Trial, Starter, Pro, Premium, Enterprise · Type: PapGetTransactionReports
Inputs#
| Field | Type | Required | Default | What it does |
|---|---|---|---|---|
| Report Type | Text | No | summary | Type of transaction report to generate. |
| Date From | Text | No | (empty) | Start date for the report period. |
| Date To | Text | No | (empty) | End date for the report period. |
| Group By | Text | No | (empty) | Field to group the report results by. |
Outputs#
| Output | Type |
|---|---|
| Data | Object |
Use as an agent tool#
Tool name: pap_get_transaction_reports
Get detailed transaction reports with grouping and analytics
Get User Info#
Get current API user information from PostAffiliatePro.
Plans: Trial, Starter, Pro, Premium, Enterprise · Type: PapGetUserInfo
Outputs#
| Output | Type |
|---|---|
| Data | Object |
Use as an agent tool#
Tool name: pap_get_user_info
Get current API user information
List Affiliates#
List and search affiliates in PostAffiliatePro.
Plans: Trial, Starter, Pro, Premium, Enterprise · Type: PapListAffiliates
Inputs#
| Field | Type | Required | Default | What it does |
|---|---|---|---|---|
| Search Query | Text | No | (empty) | Search query to filter affiliates. |
| Sort | Text | No | (empty) | Sort order for the results. |
| Per Page | Number | No | 20 | Number of affiliates to return per page. |
| Fields | Text | No | (empty) | Comma-separated list of fields to include in the response (e.g. ‘first_name,last_name,notification_email,login_count’). Leave empty for the API’s default field set. |
Outputs#
| Output | Type |
|---|---|
| Data | Object |
Use as an agent tool#
Tool name: pap_list_affiliates
List and search affiliates in the system
List Banners#
List marketing banners in PostAffiliatePro.
Plans: Trial, Starter, Pro, Premium, Enterprise · Type: PapListBanners
Inputs#
| Field | Type | Required | Default | What it does |
|---|---|---|---|---|
| Search Query | Text | No | (empty) | Field-specific search query. |
| Sort | Text | No | (empty) | Sort field. |
| Per Page | Number | No | 20 | Results per page (1-100). |
Outputs#
| Output | Type |
|---|---|
| Data | Object |
Use as an agent tool#
Tool name: pap_list_banners
List marketing banners available in campaigns
List Campaigns#
List and search campaigns in PostAffiliatePro.
Plans: Trial, Starter, Pro, Premium, Enterprise · Type: PapListCampaigns
Inputs#
| Field | Type | Required | Default | What it does |
|---|---|---|---|---|
| Search Query | Text | No | (empty) | Field-specific search query. |
| Sort | Text | No | (empty) | Sort field. |
| Per Page | Number | No | 20 | Results per page (1-100). |
Outputs#
| Output | Type |
|---|---|
| Data | Object |
Use as an agent tool#
Tool name: pap_list_campaigns
List and search affiliate marketing campaigns
List Clicks#
List and search clicks tracked by PostAffiliatePro.
Plans: Trial, Starter, Pro, Premium, Enterprise · Type: PapListClicks
Inputs#
| Field | Type | Required | Default | What it does |
|---|---|---|---|---|
| Search Query | Text | No | (empty) | Field-specific search query using field:value format. Searchable fields: type (raw/unique), affiliate_id, campaign_id, banner_id, country_code, referrer_url, ip, datetime. Example: ’type:unique affiliate_id:A123 datetime:>2024-01-01’. |
| Sort | Text | No | (empty) | Sort field (e.g. ‘datetime’, ‘-datetime’ for descending). |
| Per Page | Number | No | 20 | Results per page (1-100). |
| Last ID | Text | No | (empty) | Pagination cursor for ID-based pagination (from previous response). |
| Last Value | Text | No | (empty) | Pagination cursor for value-based pagination (from previous response). |
| Fields | Text | No | (empty) | Comma-separated list of fields to include in the response. Available: id, affiliate_id, banner_id, campaign_id, country_code, type, created_at, visitor_id, ip, channel_id, data1, data2, affiliate_username, affiliate_first_name, affiliate_last_name, banner_name, campaign_name, channel_name, channel_code, referrer_url, destination_url, user_agent. Leave empty for the API’s default field set. |
Outputs#
| Output | Type |
|---|---|
| Data | Object |
Use as an agent tool#
Tool name: pap_list_clicks
List and search clicks tracked by PostAffiliatePro
List Direct Links#
List direct links in PostAffiliatePro.
Plans: Trial, Starter, Pro, Premium, Enterprise · Type: PapListDirectLinks
Inputs#
| Field | Type | Required | Default | What it does |
|---|---|---|---|---|
| Search Query | Text | No | (empty) | Field-specific search query. |
| Sort | Text | No | (empty) | Sort field. |
| Per Page | Number | No | 20 | Results per page (1-100). |
Outputs#
| Output | Type |
|---|---|
| Data | Object |
Use as an agent tool#
Tool name: pap_list_direct_links
List direct/deep links for affiliates
Refund by Order#
Process a refund for all transactions with a specific order ID in PostAffiliatePro.
Plans: Trial, Starter, Pro, Premium, Enterprise · Type: PapRefundByOrder
Inputs#
| Field | Type | Required | Default | What it does |
|---|---|---|---|---|
| Order ID | Text | No | (empty) | The order ID to refund all transactions for. |
| Fee | Text | No | (empty) | Refund fee amount. |
| Note | Text | No | (empty) | Note for the refund. |
Outputs#
| Output | Type |
|---|---|
| Data | Object |
Use as an agent tool#
Tool name: pap_refund_by_order
Process a refund for all transactions with a specific order ID
Refund Transaction#
Process a refund for a transaction in PostAffiliatePro.
Plans: Trial, Starter, Pro, Premium, Enterprise · Type: PapRefundTransaction
Inputs#
| Field | Type | Required | Default | What it does |
|---|---|---|---|---|
| Transaction ID | Text | No | (empty) | The ID of the transaction to refund. |
| Fee | Text | No | (empty) | Refund fee amount. |
| Note | Text | No | (empty) | Note for the refund. |
Outputs#
| Output | Type |
|---|---|
| Data | Object |
Use as an agent tool#
Tool name: pap_refund_transaction
Process a refund for a transaction
Search Transactions#
Search and filter transactions in PostAffiliatePro.
Plans: Trial, Starter, Pro, Premium, Enterprise · Type: PapSearchTransactions
Inputs#
| Field | Type | Required | Default | What it does |
|---|---|---|---|---|
| Search Query | Text | No | (empty) | Search query to filter transactions. |
| Period | Text | No | (empty) | Time period filter for transactions. |
| Created At From | Text | No | (empty) | Filter transactions created from this date. |
| Created At To | Text | No | (empty) | Filter transactions created up to this date. |
| Sort | Text | No | (empty) | Sort order for the results. |
| Per Page | Number | No | 20 | Number of transactions per page (default: 20). |
| Last ID | Text | No | (empty) | Pagination cursor. Copy the last_id value from the pagination object of the previous response. Leave empty for the first page. |
| Last Value | Text | No | (empty) | Pagination cursor. Copy the last_value value from the pagination object of the previous response. Used together with last_id. Leave empty for the first page. |
Outputs#
| Output | Type |
|---|---|
| Data | Object |
Use as an agent tool#
Tool name: pap_search_transactions
Search and filter transactions with advanced options
Update Affiliate#
Update an affiliate’s information in PostAffiliatePro.
Plans: Trial, Starter, Pro, Premium, Enterprise · Type: PapUpdateAffiliate
Inputs#
| Field | Type | Required | Default | What it does |
|---|---|---|---|---|
| Affiliate ID | Text | No | (empty) | The ID of the affiliate to update. |
| Update Data | Text | No | {} | JSON object with fields to update. |
Outputs#
| Output | Type |
|---|---|
| Data | Object |
Use as an agent tool#
Tool name: pap_update_affiliate
Update an affiliate’s information
Update Transaction#
Update a transaction’s information in PostAffiliatePro.
Plans: Trial, Starter, Pro, Premium, Enterprise · Type: PapUpdateTransaction
Inputs#
| Field | Type | Required | Default | What it does |
|---|---|---|---|---|
| Transaction ID | Text | No | (empty) | The ID of the transaction to update. |
| Update Data | Text | No | {} | JSON object with fields to update. |
Outputs#
| Output | Type |
|---|---|
| Data | Object |
Use as an agent tool#
Tool name: pap_update_transaction
Update a transaction’s information
Update Transaction Status#
Update a transaction’s status in PostAffiliatePro.
Plans: Trial, Starter, Pro, Premium, Enterprise · Type: PapUpdateTransactionStatus
Inputs#
| Field | Type | Required | Default | What it does |
|---|---|---|---|---|
| Transaction ID | Text | No | (empty) | The ID of the transaction to update. |
| Status | Text | No | (empty) | New status (approved, declined, pending). |
| Reason | Text | No | (empty) | Reason for the status change. |
Outputs#
| Output | Type |
|---|---|
| Data | Object |
Use as an agent tool#
Tool name: pap_update_transaction_status
Update transaction status (approve, decline, pending)