Sales ยท CONNECTIONManage FirstPromoter promoters, referrals, commissions, payouts and promo codes, read reports, track sign-ups and sales, and start workflows from FirstPromoter webhooks.
Explore 64 workflow actions for FirstPromoter, including account permissions and operation limits.
Choose an action in the workflow builder, connect an account, and map its inputs. These actions are available in the catalog; your account access and a successful test determine whether they work for your setup.
With this endpoint you can accept promoters.
A repeated request may repeat the external action. Review the previous result before retrying a write.
With this endpoint you can add promoters to a campaign.
A repeated request may repeat the external action. Review the previous result before retrying a write.
With this endpoint you can approve commissions.
A repeated request may repeat the external action. Review the previous result before retrying a write.
With this endpoint you can approve referrals.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Archive promo code by id.
A repeated request may repeat the external action. Review the previous result before retrying a write.
With this endpoint you can archive promoters.
A repeated request may repeat the external action. Review the previous result before retrying a write.
With this endpoint you can assign a parent promoter to your promoters.
A repeated request may repeat the external action. Review the previous result before retrying a write.
With this endpoint you can block promoters.
A repeated request may repeat the external action. Review the previous result before retrying a write.
With this endpoint you can create a commission.
A repeated request may repeat the external action. Review the previous result before retrying a write.
With this endpoint you can create a new promo code.
A repeated request may repeat the external action. Review the previous result before retrying a write.
With this endpoint you can create a promoter.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create a new referral HTTP Request POST https://api.firstpromoter.com/api/v2/company/referrals.
A repeated request may repeat the external action. Review the previous result before retrying a write.
With this endpoint you can delete commissions.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Deletes selected payouts HTTP Request DELETE https://api.firstpromoter.com/api/v2/company/payouts/destroy.
A repeated request may repeat the external action. Review the previous result before retrying a write.
With this endpoint you can delete referrals.
A repeated request may repeat the external action. Review the previous result before retrying a write.
With this endpoint you can deny commissions.
A repeated request may repeat the external action. Review the previous result before retrying a write.
With this endpoint you can disable referrals.
A repeated request may repeat the external action. Review the previous result before retrying a write.
With this endpoint you can enable referrals.
A repeated request may repeat the external action. Review the previous result before retrying a write.
With this endpoint you can generate payouts for commissions.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Show details of a specific batch process HTTP Request GET https://api.firstpromoter.com/api/v2/company/batch_processes/{id}.
This endpoint returns statistics about due payouts.
This endpoint returns statistics about payouts.
With this endpoint you can get the details of a specific promo code.
With this endpoint you can get the details of a promoter.
With this endpoint you can get the data used for charts.
With this endpoint you can get the referral links associated with this promoter campaign.
With this endpoint you can get the data used for charts.
With this endpoint you can get the overview report for a single promoter, grouped over time.
With this endpoint you can get the list of referral links for a single promoter (their default link plus any campaign or custom links).
With this endpoint you can get the traffic sources report for a single promoter, broken down by source and grouped over time.
With this endpoint you can get the report data for a single promoter, grouped by URL.
Get a specific referral HTTP Request GET https://api.firstpromoter.com/api/v2/company/referrals/{id}.
With this endpoint you can get the report data grouped by campaigns.
Get reports for overview HTTP Request GET https://api.firstpromoter.com/api/v2/company/reports/overview.
With this endpoint you can get the report data grouped by promoters.
With this endpoint you can get the report data grouped by traffic sources.
With this endpoint you can get the report data grouped by URLs.
With this endpoint you can import previous sales from Stripe.
A repeated request may repeat the external action. Review the previous result before retrying a write.
List batch processes that are in progress HTTP Request GET https://api.firstpromoter.com/api/v2/company/batch_processes.
With this endpoint you can list all rewards and commissions assigned to a promotion, promoter, campaign or entire account using the API.
With this endpoint you can list all payouts.
This endpoint returns all payouts but grouped by promoters.
With this endpoint you can list all promo codes.
With this endpoint you can list all promoter campaigns.
With this endpoint you can list all promoters.
Get available referrals HTTP Request GET https://api.firstpromoter.com/api/v2/company/referrals.
With this endpoint you can mark nonmonetary commissions as fulfilled.
A repeated request may repeat the external action. Review the previous result before retrying a write.
With this endpoint you can mark nonmonetary commissions as unfulfilled.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Marks selected payouts as paid HTTP Request POST https://api.firstpromoter.com/api/v2/company/payouts/mark_as_paid.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Marks selected payouts as unpaid HTTP Request POST https://api.firstpromoter.com/api/v2/company/payouts/mark_as_unpaid.
A repeated request may repeat the external action. Review the previous result before retrying a write.
With this endpoint you can move promoters from one campaign to another.
A repeated request may repeat the external action. Review the previous result before retrying a write.
With this endpoint you can move referrals to another promoter.
A repeated request may repeat the external action. Review the previous result before retrying a write.
With this endpoint you can reject promoters.
A repeated request may repeat the external action. Review the previous result before retrying a write.
With this endpoint you can restore promoters.
A repeated request may repeat the external action. Review the previous result before retrying a write.
With this endpoint you can search for promoter campaigns.
This call will mark the customer as cancelled and will decrease the MRR generated by them.
A repeated request may repeat the external action. Review the previous result before retrying a write.
The refund call is similar to the sale call.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Assign sales and commissions to your promoters.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Capture a lead when they sign-up or fill an optin form.
A repeated request may repeat the external action. Review the previous result before retrying a write.
With this endpoint you can update a commission.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update promo code by id.
A repeated request may repeat the external action. Review the previous result before retrying a write.
With this endpoint you can update a promoter.
A repeated request may repeat the external action. Review the previous result before retrying a write.
With this endpoint you can update a promoter campaign.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update a specific referral.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Use the account and permissions required for your process. Review the connection check before configuring a workflow action.
Select a listed operation and map its required inputs. Use test records and add a human approval before writes that need review.
Inspect step outputs and confirm the result in FirstPromoter. A saved workflow is not a completed provider action.
