# Table of Contents - [Get the draft content of the contract with user details parsed - FirstPromoter Docs](#get-the-draft-content-of-the-contract-with-user-details-parsed-firstpromoter-docs) - [Introduction - FirstPromoter Docs](#introduction-firstpromoter-docs) - [Sign a document with ip - FirstPromoter Docs](#sign-a-document-with-ip-firstpromoter-docs) - [Get affiliate email settings - FirstPromoter Docs](#get-affiliate-email-settings-firstpromoter-docs) - [Delete a payout method - FirstPromoter Docs](#delete-a-payout-method-firstpromoter-docs) - [Update affiliate email settings - FirstPromoter Docs](#update-affiliate-email-settings-firstpromoter-docs) - [Get a payout method - FirstPromoter Docs](#get-a-payout-method-firstpromoter-docs) - [Get all payout methods for current promoter - FirstPromoter Docs](#get-all-payout-methods-for-current-promoter-firstpromoter-docs) - [Create a payout method for the current promoter - FirstPromoter Docs](#create-a-payout-method-for-the-current-promoter-firstpromoter-docs) - [Update a payout method - FirstPromoter Docs](#update-a-payout-method-firstpromoter-docs) - [Export payouts - FirstPromoter Docs](#export-payouts-firstpromoter-docs) - [Get all payouts for current promoter - FirstPromoter Docs](#get-all-payouts-for-current-promoter-firstpromoter-docs) - [Get due payout stats for current promoter - FirstPromoter Docs](#get-due-payout-stats-for-current-promoter-firstpromoter-docs) - [Archive promo code by id - FirstPromoter Docs](#archive-promo-code-by-id-firstpromoter-docs) - [Create promo code - FirstPromoter Docs](#create-promo-code-firstpromoter-docs) - [Update promo code by id - FirstPromoter Docs](#update-promo-code-by-id-firstpromoter-docs) - [Update promotion ref token for the promoter campaign - FirstPromoter Docs](#update-promotion-ref-token-for-the-promoter-campaign-firstpromoter-docs) - [Archives current promoter - FirstPromoter Docs](#archives-current-promoter-firstpromoter-docs) - [Get chart data - FirstPromoter Docs](#get-chart-data-firstpromoter-docs) - [Get current promoter - FirstPromoter Docs](#get-current-promoter-firstpromoter-docs) - [Get current promoter sub affiliates - FirstPromoter Docs](#get-current-promoter-sub-affiliates-firstpromoter-docs) - [Get the promoter email - FirstPromoter Docs](#get-the-promoter-email-firstpromoter-docs) - [Destroys a referral link - FirstPromoter Docs](#destroys-a-referral-link-firstpromoter-docs) - [Set the user password - FirstPromoter Docs](#set-the-user-password-firstpromoter-docs) - [Creates a referral link for current promoter - FirstPromoter Docs](#creates-a-referral-link-for-current-promoter-firstpromoter-docs) - [Get current promoter referral links - FirstPromoter Docs](#get-current-promoter-referral-links-firstpromoter-docs) - [Updates a referral link for current promoter - FirstPromoter Docs](#updates-a-referral-link-for-current-promoter-firstpromoter-docs) - [Create referral for current promoter - FirstPromoter Docs](#create-referral-for-current-promoter-firstpromoter-docs) - [Delete referral - FirstPromoter Docs](#delete-referral-firstpromoter-docs) - [Export referrals - FirstPromoter Docs](#export-referrals-firstpromoter-docs) - [Update referral - FirstPromoter Docs](#update-referral-firstpromoter-docs) - [Get available referrals for current promoter - FirstPromoter Docs](#get-available-referrals-for-current-promoter-firstpromoter-docs) - [Tracking with fpr.js - FirstPromoter Docs](#tracking-with-fpr-js-firstpromoter-docs) - [How FirstPromoter works - FirstPromoter Docs](#how-firstpromoter-works-firstpromoter-docs) - [Tracking without fpr.js - FirstPromoter Docs](#tracking-without-fpr-js-firstpromoter-docs) - [Download reports - FirstPromoter Docs](#download-reports-firstpromoter-docs) - [Braintree - FirstPromoter Docs](#braintree-firstpromoter-docs) - [Proxy Setup (Optional) - FirstPromoter Docs](#proxy-setup-optional-firstpromoter-docs) - [API - FirstPromoter Docs](#api-firstpromoter-docs) - [Chargebee - FirstPromoter Docs](#chargebee-firstpromoter-docs) - [Paddle - FirstPromoter Docs](#paddle-firstpromoter-docs) - [Recurly - FirstPromoter Docs](#recurly-firstpromoter-docs) - [Stripe - FirstPromoter Docs](#stripe-firstpromoter-docs) - [Get campaigns reports for current promoter - FirstPromoter Docs](#get-campaigns-reports-for-current-promoter-firstpromoter-docs) - [API Integration - FirstPromoter Docs](#api-integration-firstpromoter-docs) - [Introduction - FirstPromoter Docs](#introduction-firstpromoter-docs) - [Django - FirstPromoter Docs](#django-firstpromoter-docs) - [Ruby on rails - FirstPromoter Docs](#ruby-on-rails-firstpromoter-docs) - [PHP - FirstPromoter Docs](#php-firstpromoter-docs) - [Paddle Checkout - FirstPromoter Docs](#paddle-checkout-firstpromoter-docs) - [Stripe Checkout - FirstPromoter Docs](#stripe-checkout-firstpromoter-docs) - [JavaScript Tracking - FirstPromoter Docs](#javascript-tracking-firstpromoter-docs) - [Google Tag Manager - FirstPromoter Docs](#google-tag-manager-firstpromoter-docs) - [Get sub ids report for current promoter - FirstPromoter Docs](#get-sub-ids-report-for-current-promoter-firstpromoter-docs) - [Calendly - FirstPromoter Docs](#calendly-firstpromoter-docs) - [ClickFunnels - FirstPromoter Docs](#clickfunnels-firstpromoter-docs) - [DropFunnels - FirstPromoter Docs](#dropfunnels-firstpromoter-docs) - [Drop-in Scripts - FirstPromoter Docs](#drop-in-scripts-firstpromoter-docs) - [Ghost - FirstPromoter Docs](#ghost-firstpromoter-docs) - [Highlevel - FirstPromoter Docs](#highlevel-firstpromoter-docs) - [Kartra - FirstPromoter Docs](#kartra-firstpromoter-docs) - [Samcart - FirstPromoter Docs](#samcart-firstpromoter-docs) - [Concepts & Key Terminologies - FirstPromoter Docs](#concepts-key-terminologies-firstpromoter-docs) - [Hosted Pages - FirstPromoter Docs](#hosted-pages-firstpromoter-docs) - [Kickpages - FirstPromoter Docs](#kickpages-firstpromoter-docs) - [ThriveCart - FirstPromoter Docs](#thrivecart-firstpromoter-docs) - [Thinkific - FirstPromoter Docs](#thinkific-firstpromoter-docs) - [Kajabi - FirstPromoter Docs](#kajabi-firstpromoter-docs) - [Pricing Table - FirstPromoter Docs](#pricing-table-firstpromoter-docs) - [Payment Links - FirstPromoter Docs](#payment-links-firstpromoter-docs) - [Quickstart - FirstPromoter Docs](#quickstart-firstpromoter-docs) - [FirstPromoter JavaScript Library (fpr.js) - FirstPromoter Docs](#firstpromoter-javascript-library-fpr-js-firstpromoter-docs) - [Overview - FirstPromoter Docs](#overview-firstpromoter-docs) - [Advanced use cases & examples - FirstPromoter Docs](#advanced-use-cases-examples-firstpromoter-docs) - [Fulfilment Pending - FirstPromoter Docs](#fulfilment-pending-firstpromoter-docs) - [New Customer - FirstPromoter Docs](#new-customer-firstpromoter-docs) - [Lead Signup - FirstPromoter Docs](#lead-signup-firstpromoter-docs) - [Promoter Accepted - FirstPromoter Docs](#promoter-accepted-firstpromoter-docs) - [Reward Created - FirstPromoter Docs](#reward-created-firstpromoter-docs) - [Page Not Found](#page-not-found) --- # Get the draft content of the contract with user details parsed - FirstPromoter Docs [Skip to main content](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/contract-documents/get-the-draft-content-of-the-contract-with-user-details-parsed#content-area) [FirstPromoter Docs home page![light logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/light.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=6ded212b82547bec37a22e90f72eeb71)![dark logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/dark.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=c393ff83772047b8a444f78a1e393e7f)](https://docs.firstpromoter.com/) v2 Search... ⌘K Search... Navigation [Documentation](https://docs.firstpromoter.com/introduction) [API Reference](https://docs.firstpromoter.com/api-reference-v2/api-admin/introduction) [Affiliate API Reference](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/introduction) Get the draft content of the contract cURL Copy curl --request POST \ --url https://api.firstpromoter.com/api/v2/affiliate/contract_documents/draft \ --header 'Account-ID: ' \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data ' { "contract_id": 123, "details": { "email": "", "profile": { "first_name": "" } } } ' 200 404 Copy { "content": "" } POST / contract\_documents / draft Try it Get the draft content of the contract cURL Copy curl --request POST \ --url https://api.firstpromoter.com/api/v2/affiliate/contract_documents/draft \ --header 'Account-ID: ' \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data ' { "contract_id": 123, "details": { "email": "", "profile": { "first_name": "" } } } ' 200 404 Copy { "content": "" } #### Authorizations [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/contract-documents/get-the-draft-content-of-the-contract-with-user-details-parsed#authorization-authorization) Authorization string header required Access token passed as a Bearer token in the Authorization header #### Headers [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/contract-documents/get-the-draft-content-of-the-contract-with-user-details-parsed#parameter-account-id) Account-ID string required Account identifier that specifies which account is making the request Example: `"acc_123456"` #### Body application/json [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/contract-documents/get-the-draft-content-of-the-contract-with-user-details-parsed#body-contract-id) contract\_id integer ID of the contract [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/contract-documents/get-the-draft-content-of-the-contract-with-user-details-parsed#body-details) details object User details to parse Show child attributes [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/contract-documents/get-the-draft-content-of-the-contract-with-user-details-parsed#body-details-email) details.email string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/contract-documents/get-the-draft-content-of-the-contract-with-user-details-parsed#body-details-profile) details.profile object Show child attributes [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/contract-documents/get-the-draft-content-of-the-contract-with-user-details-parsed#body-details-profile-first-name) details.profile.first\_name string #### Response 200 application/json Draft content [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/contract-documents/get-the-draft-content-of-the-contract-with-user-details-parsed#response-content) content string [Sign a document with ip](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/contract-documents/sign-a-document-with-ip) [Get affiliate email settings](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/email-settings/get-affiliate-email-settings) ⌘I --- # Introduction - FirstPromoter Docs [Skip to main content](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/introduction#content-area) [FirstPromoter Docs home page![light logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/light.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=6ded212b82547bec37a22e90f72eeb71)![dark logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/dark.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=c393ff83772047b8a444f78a1e393e7f)](https://docs.firstpromoter.com/) v2 Search... ⌘K Search... Navigation Affiliate API Documentation Introduction [Documentation](https://docs.firstpromoter.com/introduction) [API Reference](https://docs.firstpromoter.com/api-reference-v2/api-admin/introduction) [Affiliate API Reference](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/introduction) The Affiliates API provides comprehensive endpoints for the affiliates section. These endpoints are mainly used for displaying the contents displayed on the affiliate dashboard. [Authentication](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/authentication) ⌘I --- # Sign a document with ip - FirstPromoter Docs [Skip to main content](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/contract-documents/sign-a-document-with-ip#content-area) [FirstPromoter Docs home page![light logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/light.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=6ded212b82547bec37a22e90f72eeb71)![dark logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/dark.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=c393ff83772047b8a444f78a1e393e7f)](https://docs.firstpromoter.com/) v2 Search... ⌘K Search... Navigation [Documentation](https://docs.firstpromoter.com/introduction) [API Reference](https://docs.firstpromoter.com/api-reference-v2/api-admin/introduction) [Affiliate API Reference](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/introduction) Sign a document with id cURL Copy curl --request POST \ --url https://api.firstpromoter.com/api/v2/affiliate/contract_documents/{id}/sign \ --header 'Account-ID: ' \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data ' { "ip": "" } ' 200 400 403 404 Copy { "id": 123, "status": "signed", "signed_ip": "", "contract_version_id": 123, "signed_at": "2023-11-07T05:31:56Z", "promoter": { "id": 123, "email": "", "name": "", "profile": { "avatar": "" } }, "contract_version": { "added_at": "2023-11-07T05:31:56Z", "changes_made": "", "external_link": "", "content_hosted": true }, "contract": { "id": 123, "name": "" } } POST / contract\_documents / {id} / sign Try it Sign a document with id cURL Copy curl --request POST \ --url https://api.firstpromoter.com/api/v2/affiliate/contract_documents/{id}/sign \ --header 'Account-ID: ' \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data ' { "ip": "" } ' 200 400 403 404 Copy { "id": 123, "status": "signed", "signed_ip": "", "contract_version_id": 123, "signed_at": "2023-11-07T05:31:56Z", "promoter": { "id": 123, "email": "", "name": "", "profile": { "avatar": "" } }, "contract_version": { "added_at": "2023-11-07T05:31:56Z", "changes_made": "", "external_link": "", "content_hosted": true }, "contract": { "id": 123, "name": "" } } #### Authorizations [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/contract-documents/sign-a-document-with-ip#authorization-authorization) Authorization string header required Access token passed as a Bearer token in the Authorization header #### Headers [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/contract-documents/sign-a-document-with-ip#parameter-account-id) Account-ID string required Account identifier that specifies which account is making the request Example: `"acc_123456"` #### Path Parameters [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/contract-documents/sign-a-document-with-ip#parameter-id) id integer required Contract document ID #### Body application/json [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/contract-documents/sign-a-document-with-ip#body-ip) ip string IP address of the signer #### Response 200 application/json Signed document [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/contract-documents/sign-a-document-with-ip#response-id) id integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/contract-documents/sign-a-document-with-ip#response-status) status enum Available options: `signed` [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/contract-documents/sign-a-document-with-ip#response-signed-ip) signed\_ip string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/contract-documents/sign-a-document-with-ip#response-contract-version-id) contract\_version\_id integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/contract-documents/sign-a-document-with-ip#response-signed-at) signed\_at string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/contract-documents/sign-a-document-with-ip#response-promoter) promoter object Show child attributes [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/contract-documents/sign-a-document-with-ip#response-promoter-id) promoter.id integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/contract-documents/sign-a-document-with-ip#response-promoter-email) promoter.email string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/contract-documents/sign-a-document-with-ip#response-promoter-name) promoter.name string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/contract-documents/sign-a-document-with-ip#response-promoter-profile) promoter.profile object Show child attributes [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/contract-documents/sign-a-document-with-ip#response-promoter-profile-avatar) promoter.profile.avatar string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/contract-documents/sign-a-document-with-ip#response-contract-version) contract\_version object Show child attributes [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/contract-documents/sign-a-document-with-ip#response-contract-version-added-at) contract\_version.added\_at string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/contract-documents/sign-a-document-with-ip#response-contract-version-changes-made-one-of-0) contract\_version.changes\_made string | null [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/contract-documents/sign-a-document-with-ip#response-contract-version-external-link-one-of-0) contract\_version.external\_link string | null [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/contract-documents/sign-a-document-with-ip#response-contract-version-content-hosted) contract\_version.content\_hosted boolean [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/contract-documents/sign-a-document-with-ip#response-contract) contract object Show child attributes [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/contract-documents/sign-a-document-with-ip#response-contract-id) contract.id integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/contract-documents/sign-a-document-with-ip#response-contract-name) contract.name string [Get contract documents by id and returns it in the selected format htmlpdf](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/contract-documents/get-contract-documents-by-id-and-returns-it-in-the-selected-format-htmlpdf) [Get the draft content of the contract with user details parsed](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/contract-documents/get-the-draft-content-of-the-contract-with-user-details-parsed) ⌘I --- # Get affiliate email settings - FirstPromoter Docs [Skip to main content](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/email-settings/get-affiliate-email-settings#content-area) [FirstPromoter Docs home page![light logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/light.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=6ded212b82547bec37a22e90f72eeb71)![dark logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/dark.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=c393ff83772047b8a444f78a1e393e7f)](https://docs.firstpromoter.com/) v2 Search... ⌘K Search... Navigation [Documentation](https://docs.firstpromoter.com/introduction) [API Reference](https://docs.firstpromoter.com/api-reference-v2/api-admin/introduction) [Affiliate API Reference](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/introduction) Get affiliate email settings cURL Copy curl --request GET \ --url https://api.firstpromoter.com/api/v2/affiliate/email_settings \ --header 'Account-ID: ' \ --header 'Authorization: Bearer ' 200 401 403 Copy { "data": [\ {\ "id": 123,\ "company_domain": "",\ "emails_opt_drip": true,\ "emails_opt_new_commission": true,\ "emails_opt_new_referral": true,\ "emails_opt_payout": true,\ "company_name": "",\ "marketing_consent": true\ }\ ], "meta": { "email": "" } } GET / email\_settings Try it Get affiliate email settings cURL Copy curl --request GET \ --url https://api.firstpromoter.com/api/v2/affiliate/email_settings \ --header 'Account-ID: ' \ --header 'Authorization: Bearer ' 200 401 403 Copy { "data": [\ {\ "id": 123,\ "company_domain": "",\ "emails_opt_drip": true,\ "emails_opt_new_commission": true,\ "emails_opt_new_referral": true,\ "emails_opt_payout": true,\ "company_name": "",\ "marketing_consent": true\ }\ ], "meta": { "email": "" } } #### Authorizations [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/email-settings/get-affiliate-email-settings#authorization-authorization) Authorization string header required Access token passed as a Bearer token in the Authorization header #### Headers [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/email-settings/get-affiliate-email-settings#parameter-account-id) Account-ID string required Account identifier that specifies which account is making the request Example: `"acc_123456"` #### Query Parameters [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/email-settings/get-affiliate-email-settings#parameter-e) e string Encrypted email #### Response 200 application/json Email settings retrieved successfully [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/email-settings/get-affiliate-email-settings#response-data) data object\[\] Show child attributes [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/email-settings/get-affiliate-email-settings#response-data-items-id) data.id integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/email-settings/get-affiliate-email-settings#response-data-items-company-domain) data.company\_domain string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/email-settings/get-affiliate-email-settings#response-data-items-emails-opt-drip) data.emails\_opt\_drip boolean [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/email-settings/get-affiliate-email-settings#response-data-items-emails-opt-new-commission) data.emails\_opt\_new\_commission boolean [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/email-settings/get-affiliate-email-settings#response-data-items-emails-opt-new-referral) data.emails\_opt\_new\_referral boolean [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/email-settings/get-affiliate-email-settings#response-data-items-emails-opt-payout) data.emails\_opt\_payout boolean [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/email-settings/get-affiliate-email-settings#response-data-items-company-name) data.company\_name string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/email-settings/get-affiliate-email-settings#response-data-items-marketing-consent) data.marketing\_consent boolean [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/email-settings/get-affiliate-email-settings#response-meta) meta object Show child attributes [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/email-settings/get-affiliate-email-settings#response-meta-email) meta.email string [Get the draft content of the contract with user details parsed](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/contract-documents/get-the-draft-content-of-the-contract-with-user-details-parsed) [Update affiliate email settings](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/email-settings/update-affiliate-email-settings) ⌘I --- # Delete a payout method - FirstPromoter Docs [Skip to main content](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/delete-a-payout-method#content-area) [FirstPromoter Docs home page![light logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/light.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=6ded212b82547bec37a22e90f72eeb71)![dark logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/dark.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=c393ff83772047b8a444f78a1e393e7f)](https://docs.firstpromoter.com/) v2 Search... ⌘K Search... Navigation [Documentation](https://docs.firstpromoter.com/introduction) [API Reference](https://docs.firstpromoter.com/api-reference-v2/api-admin/introduction) [Affiliate API Reference](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/introduction) Delete a payout method cURL Copy curl --request DELETE \ --url https://api.firstpromoter.com/api/v2/affiliate/payout_methods/{id} \ --header 'Account-ID: ' \ --header 'Authorization: Bearer ' 401 403 404 409 Copy { "message": "", "code": "", "errors": {} } DELETE / payout\_methods / {id} Try it Delete a payout method cURL Copy curl --request DELETE \ --url https://api.firstpromoter.com/api/v2/affiliate/payout_methods/{id} \ --header 'Account-ID: ' \ --header 'Authorization: Bearer ' 401 403 404 409 Copy { "message": "", "code": "", "errors": {} } #### Authorizations [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/delete-a-payout-method#authorization-authorization) Authorization string header required Access token passed as a Bearer token in the Authorization header #### Headers [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/delete-a-payout-method#parameter-account-id) Account-ID string required Account identifier that specifies which account is making the request Example: `"acc_123456"` #### Path Parameters [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/delete-a-payout-method#parameter-id) id integer required Payout method ID #### Response 200 Payout method deleted successfully [Update a payout method](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/update-a-payout-method) [Get all payouts for current promoter](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/get-all-payouts-for-current-promoter) ⌘I --- # Update affiliate email settings - FirstPromoter Docs [Skip to main content](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/email-settings/update-affiliate-email-settings#content-area) [FirstPromoter Docs home page![light logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/light.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=6ded212b82547bec37a22e90f72eeb71)![dark logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/dark.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=c393ff83772047b8a444f78a1e393e7f)](https://docs.firstpromoter.com/) v2 Search... ⌘K Search... Navigation [Documentation](https://docs.firstpromoter.com/introduction) [API Reference](https://docs.firstpromoter.com/api-reference-v2/api-admin/introduction) [Affiliate API Reference](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/introduction) Update affiliate email settings cURL Copy curl --request PUT \ --url https://api.firstpromoter.com/api/v2/affiliate/email_settings/{id} \ --header 'Account-ID: ' \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data ' { "e": "", "marketing_consent": true, "emails_opt_drip": true, "emails_opt_new_commission": true, "emails_opt_new_referral": true, "emails_opt_payout": true } ' 200 401 403 404 Copy { "id": 123, "company_domain": "", "emails_opt_drip": true, "emails_opt_new_commission": true, "emails_opt_new_referral": true, "emails_opt_payout": true, "company_name": "", "marketing_consent": true } PUT / email\_settings / {id} Try it Update affiliate email settings cURL Copy curl --request PUT \ --url https://api.firstpromoter.com/api/v2/affiliate/email_settings/{id} \ --header 'Account-ID: ' \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data ' { "e": "", "marketing_consent": true, "emails_opt_drip": true, "emails_opt_new_commission": true, "emails_opt_new_referral": true, "emails_opt_payout": true } ' 200 401 403 404 Copy { "id": 123, "company_domain": "", "emails_opt_drip": true, "emails_opt_new_commission": true, "emails_opt_new_referral": true, "emails_opt_payout": true, "company_name": "", "marketing_consent": true } #### Authorizations [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/email-settings/update-affiliate-email-settings#authorization-authorization) Authorization string header required Access token passed as a Bearer token in the Authorization header #### Headers [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/email-settings/update-affiliate-email-settings#parameter-account-id) Account-ID string required Account identifier that specifies which account is making the request Example: `"acc_123456"` #### Path Parameters [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/email-settings/update-affiliate-email-settings#parameter-id) id integer required Promoter ID #### Body application/json [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/email-settings/update-affiliate-email-settings#body-e) e string Encrypted email [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/email-settings/update-affiliate-email-settings#body-marketing-consent) marketing\_consent boolean General company wide marketing consent [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/email-settings/update-affiliate-email-settings#body-emails-opt-drip) emails\_opt\_drip boolean Receive helpful emails regarding your referral/affiliate program [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/email-settings/update-affiliate-email-settings#body-emails-opt-new-commission) emails\_opt\_new\_commission boolean Receive notifications each time you get a new reward/commission [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/email-settings/update-affiliate-email-settings#body-emails-opt-new-referral) emails\_opt\_new\_referral boolean Receive notifications when a new user signs up [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/email-settings/update-affiliate-email-settings#body-emails-opt-payout) emails\_opt\_payout boolean Receive notifications when a payment is sent to you #### Response 200 application/json Email settings updated successfully [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/email-settings/update-affiliate-email-settings#response-id) id integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/email-settings/update-affiliate-email-settings#response-company-domain) company\_domain string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/email-settings/update-affiliate-email-settings#response-emails-opt-drip) emails\_opt\_drip boolean [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/email-settings/update-affiliate-email-settings#response-emails-opt-new-commission) emails\_opt\_new\_commission boolean [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/email-settings/update-affiliate-email-settings#response-emails-opt-new-referral) emails\_opt\_new\_referral boolean [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/email-settings/update-affiliate-email-settings#response-emails-opt-payout) emails\_opt\_payout boolean [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/email-settings/update-affiliate-email-settings#response-company-name) company\_name string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/email-settings/update-affiliate-email-settings#response-marketing-consent) marketing\_consent boolean [Get affiliate email settings](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/email-settings/get-affiliate-email-settings) [Get all payout methods for current promoter](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/get-all-payout-methods-for-current-promoter) ⌘I --- # Get a payout method - FirstPromoter Docs [Skip to main content](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/get-a-payout-method#content-area) [FirstPromoter Docs home page![light logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/light.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=6ded212b82547bec37a22e90f72eeb71)![dark logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/dark.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=c393ff83772047b8a444f78a1e393e7f)](https://docs.firstpromoter.com/) v2 Search... ⌘K Search... Navigation [Documentation](https://docs.firstpromoter.com/introduction) [API Reference](https://docs.firstpromoter.com/api-reference-v2/api-admin/introduction) [Affiliate API Reference](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/introduction) Get a payout method cURL Copy curl --request GET \ --url https://api.firstpromoter.com/api/v2/affiliate/payout_methods/{id} \ --header 'Account-ID: ' \ --header 'Authorization: Bearer ' 200 401 403 404 Copy { "id": 123, "method": "paypal", "date_added": "2023-11-07T05:31:56Z", "is_disabled": true, "meta": {}, "is_selected": true, "details": { "paypal_email": "", "wise_email": "", "wallet_address": "", "crypto_currency": "", "bank_country": "AD", "account_holder_name": "", "account_number": "", "routing_aba_number": "", "country": "", "state": "", "postal_code": "", "address": "", "city": "", "transit_number": "", "institution_number": "", "bsb_code": "", "sort_code": "", "iban": "", "swift_bic_code": "", "bank_name": "", "bank_city": "", "bank_address": "" }, "managed_payouts": true } GET / payout\_methods / {id} Try it Get a payout method cURL Copy curl --request GET \ --url https://api.firstpromoter.com/api/v2/affiliate/payout_methods/{id} \ --header 'Account-ID: ' \ --header 'Authorization: Bearer ' 200 401 403 404 Copy { "id": 123, "method": "paypal", "date_added": "2023-11-07T05:31:56Z", "is_disabled": true, "meta": {}, "is_selected": true, "details": { "paypal_email": "", "wise_email": "", "wallet_address": "", "crypto_currency": "", "bank_country": "AD", "account_holder_name": "", "account_number": "", "routing_aba_number": "", "country": "", "state": "", "postal_code": "", "address": "", "city": "", "transit_number": "", "institution_number": "", "bsb_code": "", "sort_code": "", "iban": "", "swift_bic_code": "", "bank_name": "", "bank_city": "", "bank_address": "" }, "managed_payouts": true } #### Authorizations [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/get-a-payout-method#authorization-authorization) Authorization string header required Access token passed as a Bearer token in the Authorization header #### Headers [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/get-a-payout-method#parameter-account-id) Account-ID string required Account identifier that specifies which account is making the request Example: `"acc_123456"` #### Path Parameters [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/get-a-payout-method#parameter-id) id integer required Payout method ID #### Response 200 application/json Payout method details [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/get-a-payout-method#response-id) id integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/get-a-payout-method#response-method) method enum Available options: `paypal`, `bank`, `wise`, `crypto`, `custom`, `dots` [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/get-a-payout-method#response-date-added) date\_added string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/get-a-payout-method#response-is-disabled) is\_disabled boolean [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/get-a-payout-method#response-meta) meta object [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/get-a-payout-method#response-is-selected) is\_selected boolean [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/get-a-payout-method#response-details) details object Show child attributes [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/get-a-payout-method#response-details-paypal-email) details.paypal\_email string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/get-a-payout-method#response-details-wise-email) details.wise\_email string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/get-a-payout-method#response-details-wallet-address) details.wallet\_address string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/get-a-payout-method#response-details-crypto-currency) details.crypto\_currency string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/get-a-payout-method#response-details-bank-country) details.bank\_country enum Available options: `AD`, `AE`, `AL`, `AT`, `AU`, `AZ`, `BA`, `BE`, `BG`, `BH`, `BR`, `BY`, `CA`, `CH`, `CI`, `CR`, `CV`, `CY`, `CZ`, `DE`, `DK`, `DO`, `EE`, `EG`, `ES`, `FI`, `FO`, `FR`, `GA`, `GB`, `GE`, `GI`, `GL`, `GR`, `HR`, `HU`, `IE`, `IL`, `IQ`, `IS`, `IT`, `JO`, `KW`, `KZ`, `LB`, `LI`, `LT`, `LU`, `LV`, `MC`, `MD`, `ME`, `MG`, `MK`, `MR`, `MT`, `MU`, `NL`, `NO`, `PK`, `PL`, `PS`, `PT`, `QA`, `RO`, `RS`, `SA`, `SC`, `SE`, `SI`, `SK`, `SM`, `SV`, `TN`, `TR`, `UA`, `US`, `VA`, `VG`, `XK` [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/get-a-payout-method#response-details-account-holder-name) details.account\_holder\_name string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/get-a-payout-method#response-details-account-number) details.account\_number string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/get-a-payout-method#response-details-routing-aba-number) details.routing\_aba\_number string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/get-a-payout-method#response-details-country) details.country string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/get-a-payout-method#response-details-state) details.state string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/get-a-payout-method#response-details-postal-code) details.postal\_code string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/get-a-payout-method#response-details-address) details.address string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/get-a-payout-method#response-details-city) details.city string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/get-a-payout-method#response-details-transit-number) details.transit\_number string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/get-a-payout-method#response-details-institution-number) details.institution\_number string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/get-a-payout-method#response-details-bsb-code) details.bsb\_code string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/get-a-payout-method#response-details-sort-code) details.sort\_code string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/get-a-payout-method#response-details-iban) details.iban string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/get-a-payout-method#response-details-swift-bic-code) details.swift\_bic\_code string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/get-a-payout-method#response-details-bank-name) details.bank\_name string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/get-a-payout-method#response-details-bank-city) details.bank\_city string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/get-a-payout-method#response-details-bank-address) details.bank\_address string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/get-a-payout-method#response-managed-payouts) managed\_payouts boolean [Create a payout method for the current promoter](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/create-a-payout-method-for-the-current-promoter) [Update a payout method](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/update-a-payout-method) ⌘I --- # Get all payout methods for current promoter - FirstPromoter Docs [Skip to main content](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/get-all-payout-methods-for-current-promoter#content-area) [FirstPromoter Docs home page![light logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/light.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=6ded212b82547bec37a22e90f72eeb71)![dark logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/dark.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=c393ff83772047b8a444f78a1e393e7f)](https://docs.firstpromoter.com/) v2 Search... ⌘K Search... Navigation [Documentation](https://docs.firstpromoter.com/introduction) [API Reference](https://docs.firstpromoter.com/api-reference-v2/api-admin/introduction) [Affiliate API Reference](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/introduction) Get all payout methods cURL Copy curl --request GET \ --url https://api.firstpromoter.com/api/v2/affiliate/payout_methods \ --header 'Account-ID: ' \ --header 'Authorization: Bearer ' 200 401 403 Copy { "data": [\ {\ "id": 123,\ "method": "paypal",\ "date_added": "2023-11-07T05:31:56Z",\ "is_disabled": true,\ "meta": {},\ "is_selected": true,\ "details": {\ "paypal_email": "",\ "wise_email": "",\ "wallet_address": "",\ "crypto_currency": "",\ "bank_country": "AD",\ "account_holder_name": "",\ "account_number": "",\ "routing_aba_number": "",\ "country": "",\ "state": "",\ "postal_code": "",\ "address": "",\ "city": "",\ "transit_number": "",\ "institution_number": "",\ "bsb_code": "",\ "sort_code": "",\ "iban": "",\ "swift_bic_code": "",\ "bank_name": "",\ "bank_city": "",\ "bank_address": ""\ },\ "managed_payouts": true\ }\ ], "meta": { "selected_payout_methods": [\ ""\ ], "payout_method_options": {} } } GET / payout\_methods Try it Get all payout methods cURL Copy curl --request GET \ --url https://api.firstpromoter.com/api/v2/affiliate/payout_methods \ --header 'Account-ID: ' \ --header 'Authorization: Bearer ' 200 401 403 Copy { "data": [\ {\ "id": 123,\ "method": "paypal",\ "date_added": "2023-11-07T05:31:56Z",\ "is_disabled": true,\ "meta": {},\ "is_selected": true,\ "details": {\ "paypal_email": "",\ "wise_email": "",\ "wallet_address": "",\ "crypto_currency": "",\ "bank_country": "AD",\ "account_holder_name": "",\ "account_number": "",\ "routing_aba_number": "",\ "country": "",\ "state": "",\ "postal_code": "",\ "address": "",\ "city": "",\ "transit_number": "",\ "institution_number": "",\ "bsb_code": "",\ "sort_code": "",\ "iban": "",\ "swift_bic_code": "",\ "bank_name": "",\ "bank_city": "",\ "bank_address": ""\ },\ "managed_payouts": true\ }\ ], "meta": { "selected_payout_methods": [\ ""\ ], "payout_method_options": {} } } #### Authorizations [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/get-all-payout-methods-for-current-promoter#authorization-authorization) Authorization string header required Access token passed as a Bearer token in the Authorization header #### Headers [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/get-all-payout-methods-for-current-promoter#parameter-account-id) Account-ID string required Account identifier that specifies which account is making the request Example: `"acc_123456"` #### Response 200 application/json List of payout methods [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/get-all-payout-methods-for-current-promoter#response-data) data object\[\] Show child attributes [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/get-all-payout-methods-for-current-promoter#response-data-items-id) data.id integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/get-all-payout-methods-for-current-promoter#response-data-items-method) data.method enum Available options: `paypal`, `bank`, `wise`, `crypto`, `custom`, `dots` [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/get-all-payout-methods-for-current-promoter#response-data-items-date-added) data.date\_added string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/get-all-payout-methods-for-current-promoter#response-data-items-is-disabled) data.is\_disabled boolean [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/get-all-payout-methods-for-current-promoter#response-data-items-meta) data.meta object [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/get-all-payout-methods-for-current-promoter#response-data-items-is-selected) data.is\_selected boolean [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/get-all-payout-methods-for-current-promoter#response-data-items-details) data.details object Show child attributes [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/get-all-payout-methods-for-current-promoter#response-data-items-details-paypal-email) data.details.paypal\_email string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/get-all-payout-methods-for-current-promoter#response-data-items-details-wise-email) data.details.wise\_email string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/get-all-payout-methods-for-current-promoter#response-data-items-details-wallet-address) data.details.wallet\_address string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/get-all-payout-methods-for-current-promoter#response-data-items-details-crypto-currency) data.details.crypto\_currency string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/get-all-payout-methods-for-current-promoter#response-data-items-details-bank-country) data.details.bank\_country enum Available options: `AD`, `AE`, `AL`, `AT`, `AU`, `AZ`, `BA`, `BE`, `BG`, `BH`, `BR`, `BY`, `CA`, `CH`, `CI`, `CR`, `CV`, `CY`, `CZ`, `DE`, `DK`, `DO`, `EE`, `EG`, `ES`, `FI`, `FO`, `FR`, `GA`, `GB`, `GE`, `GI`, `GL`, `GR`, `HR`, `HU`, `IE`, `IL`, `IQ`, `IS`, `IT`, `JO`, `KW`, `KZ`, `LB`, `LI`, `LT`, `LU`, `LV`, `MC`, `MD`, `ME`, `MG`, `MK`, `MR`, `MT`, `MU`, `NL`, `NO`, `PK`, `PL`, `PS`, `PT`, `QA`, `RO`, `RS`, `SA`, `SC`, `SE`, `SI`, `SK`, `SM`, `SV`, `TN`, `TR`, `UA`, `US`, `VA`, `VG`, `XK` [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/get-all-payout-methods-for-current-promoter#response-data-items-details-account-holder-name) data.details.account\_holder\_name string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/get-all-payout-methods-for-current-promoter#response-data-items-details-account-number) data.details.account\_number string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/get-all-payout-methods-for-current-promoter#response-data-items-details-routing-aba-number) data.details.routing\_aba\_number string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/get-all-payout-methods-for-current-promoter#response-data-items-details-country) data.details.country string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/get-all-payout-methods-for-current-promoter#response-data-items-details-state) data.details.state string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/get-all-payout-methods-for-current-promoter#response-data-items-details-postal-code) data.details.postal\_code string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/get-all-payout-methods-for-current-promoter#response-data-items-details-address) data.details.address string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/get-all-payout-methods-for-current-promoter#response-data-items-details-city) data.details.city string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/get-all-payout-methods-for-current-promoter#response-data-items-details-transit-number) data.details.transit\_number string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/get-all-payout-methods-for-current-promoter#response-data-items-details-institution-number) data.details.institution\_number string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/get-all-payout-methods-for-current-promoter#response-data-items-details-bsb-code) data.details.bsb\_code string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/get-all-payout-methods-for-current-promoter#response-data-items-details-sort-code) data.details.sort\_code string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/get-all-payout-methods-for-current-promoter#response-data-items-details-iban) data.details.iban string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/get-all-payout-methods-for-current-promoter#response-data-items-details-swift-bic-code) data.details.swift\_bic\_code string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/get-all-payout-methods-for-current-promoter#response-data-items-details-bank-name) data.details.bank\_name string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/get-all-payout-methods-for-current-promoter#response-data-items-details-bank-city) data.details.bank\_city string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/get-all-payout-methods-for-current-promoter#response-data-items-details-bank-address) data.details.bank\_address string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/get-all-payout-methods-for-current-promoter#response-data-items-managed-payouts) data.managed\_payouts boolean [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/get-all-payout-methods-for-current-promoter#response-meta) meta object Show child attributes [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/get-all-payout-methods-for-current-promoter#response-meta-selected-payout-methods) meta.selected\_payout\_methods string\[\] [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/get-all-payout-methods-for-current-promoter#response-meta-payout-method-options) meta.payout\_method\_options object [Update affiliate email settings](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/email-settings/update-affiliate-email-settings) [Create a payout method for the current promoter](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/create-a-payout-method-for-the-current-promoter) ⌘I --- # Create a payout method for the current promoter - FirstPromoter Docs [Skip to main content](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/create-a-payout-method-for-the-current-promoter#content-area) [FirstPromoter Docs home page![light logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/light.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=6ded212b82547bec37a22e90f72eeb71)![dark logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/dark.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=c393ff83772047b8a444f78a1e393e7f)](https://docs.firstpromoter.com/) v2 Search... ⌘K Search... Navigation [Documentation](https://docs.firstpromoter.com/introduction) [API Reference](https://docs.firstpromoter.com/api-reference-v2/api-admin/introduction) [Affiliate API Reference](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/introduction) Create a payout method cURL Copy curl --request POST \ --url https://api.firstpromoter.com/api/v2/affiliate/payout_methods \ --header 'Account-ID: ' \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data ' { "method": "paypal", "details": { "paypal_email": "", "wise_email": "", "wallet_address": "", "crypto_currency": "", "bank_country": "AD", "account_holder_name": "", "account_number": "", "routing_aba_number": "", "country": "", "state": "", "postal_code": "", "address": "", "city": "", "transit_number": "", "institution_number": "", "bsb_code": "", "sort_code": "", "iban": "", "swift_bic_code": "", "bank_name": "", "bank_city": "", "bank_address": "" }, "is_disabled": true, "is_selected": true } ' 200 400 401 403 422 Copy { "id": 123, "method": "paypal", "date_added": "2023-11-07T05:31:56Z", "is_disabled": true, "meta": {}, "is_selected": true, "details": { "paypal_email": "", "wise_email": "", "wallet_address": "", "crypto_currency": "", "bank_country": "AD", "account_holder_name": "", "account_number": "", "routing_aba_number": "", "country": "", "state": "", "postal_code": "", "address": "", "city": "", "transit_number": "", "institution_number": "", "bsb_code": "", "sort_code": "", "iban": "", "swift_bic_code": "", "bank_name": "", "bank_city": "", "bank_address": "" }, "managed_payouts": true } POST / payout\_methods Try it Create a payout method cURL Copy curl --request POST \ --url https://api.firstpromoter.com/api/v2/affiliate/payout_methods \ --header 'Account-ID: ' \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data ' { "method": "paypal", "details": { "paypal_email": "", "wise_email": "", "wallet_address": "", "crypto_currency": "", "bank_country": "AD", "account_holder_name": "", "account_number": "", "routing_aba_number": "", "country": "", "state": "", "postal_code": "", "address": "", "city": "", "transit_number": "", "institution_number": "", "bsb_code": "", "sort_code": "", "iban": "", "swift_bic_code": "", "bank_name": "", "bank_city": "", "bank_address": "" }, "is_disabled": true, "is_selected": true } ' 200 400 401 403 422 Copy { "id": 123, "method": "paypal", "date_added": "2023-11-07T05:31:56Z", "is_disabled": true, "meta": {}, "is_selected": true, "details": { "paypal_email": "", "wise_email": "", "wallet_address": "", "crypto_currency": "", "bank_country": "AD", "account_holder_name": "", "account_number": "", "routing_aba_number": "", "country": "", "state": "", "postal_code": "", "address": "", "city": "", "transit_number": "", "institution_number": "", "bsb_code": "", "sort_code": "", "iban": "", "swift_bic_code": "", "bank_name": "", "bank_city": "", "bank_address": "" }, "managed_payouts": true } #### Authorizations [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/create-a-payout-method-for-the-current-promoter#authorization-authorization) Authorization string header required Access token passed as a Bearer token in the Authorization header #### Headers [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/create-a-payout-method-for-the-current-promoter#parameter-account-id) Account-ID string required Account identifier that specifies which account is making the request Example: `"acc_123456"` #### Body application/json [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/create-a-payout-method-for-the-current-promoter#body-method) method enum required Available options: `paypal`, `bank`, `wise`, `crypto`, `custom`, `dots` [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/create-a-payout-method-for-the-current-promoter#body-details) details object required Show child attributes [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/create-a-payout-method-for-the-current-promoter#body-details-paypal-email) details.paypal\_email string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/create-a-payout-method-for-the-current-promoter#body-details-wise-email) details.wise\_email string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/create-a-payout-method-for-the-current-promoter#body-details-wallet-address) details.wallet\_address string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/create-a-payout-method-for-the-current-promoter#body-details-crypto-currency) details.crypto\_currency string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/create-a-payout-method-for-the-current-promoter#body-details-bank-country) details.bank\_country enum Available options: `AD`, `AE`, `AL`, `AT`, `AU`, `AZ`, `BA`, `BE`, `BG`, `BH`, `BR`, `BY`, `CA`, `CH`, `CI`, `CR`, `CV`, `CY`, `CZ`, `DE`, `DK`, `DO`, `EE`, `EG`, `ES`, `FI`, `FO`, `FR`, `GA`, `GB`, `GE`, `GI`, `GL`, `GR`, `HR`, `HU`, `IE`, `IL`, `IQ`, `IS`, `IT`, `JO`, `KW`, `KZ`, `LB`, `LI`, `LT`, `LU`, `LV`, `MC`, `MD`, `ME`, `MG`, `MK`, `MR`, `MT`, `MU`, `NL`, `NO`, `PK`, `PL`, `PS`, `PT`, `QA`, `RO`, `RS`, `SA`, `SC`, `SE`, `SI`, `SK`, `SM`, `SV`, `TN`, `TR`, `UA`, `US`, `VA`, `VG`, `XK` [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/create-a-payout-method-for-the-current-promoter#body-details-account-holder-name) details.account\_holder\_name string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/create-a-payout-method-for-the-current-promoter#body-details-account-number) details.account\_number string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/create-a-payout-method-for-the-current-promoter#body-details-routing-aba-number) details.routing\_aba\_number string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/create-a-payout-method-for-the-current-promoter#body-details-country) details.country string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/create-a-payout-method-for-the-current-promoter#body-details-state) details.state string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/create-a-payout-method-for-the-current-promoter#body-details-postal-code) details.postal\_code string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/create-a-payout-method-for-the-current-promoter#body-details-address) details.address string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/create-a-payout-method-for-the-current-promoter#body-details-city) details.city string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/create-a-payout-method-for-the-current-promoter#body-details-transit-number) details.transit\_number string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/create-a-payout-method-for-the-current-promoter#body-details-institution-number) details.institution\_number string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/create-a-payout-method-for-the-current-promoter#body-details-bsb-code) details.bsb\_code string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/create-a-payout-method-for-the-current-promoter#body-details-sort-code) details.sort\_code string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/create-a-payout-method-for-the-current-promoter#body-details-iban) details.iban string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/create-a-payout-method-for-the-current-promoter#body-details-swift-bic-code) details.swift\_bic\_code string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/create-a-payout-method-for-the-current-promoter#body-details-bank-name) details.bank\_name string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/create-a-payout-method-for-the-current-promoter#body-details-bank-city) details.bank\_city string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/create-a-payout-method-for-the-current-promoter#body-details-bank-address) details.bank\_address string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/create-a-payout-method-for-the-current-promoter#body-is-disabled) is\_disabled boolean [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/create-a-payout-method-for-the-current-promoter#body-is-selected) is\_selected boolean #### Response 200 application/json Created payout method [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/create-a-payout-method-for-the-current-promoter#response-id) id integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/create-a-payout-method-for-the-current-promoter#response-method) method enum Available options: `paypal`, `bank`, `wise`, `crypto`, `custom`, `dots` [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/create-a-payout-method-for-the-current-promoter#response-date-added) date\_added string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/create-a-payout-method-for-the-current-promoter#response-is-disabled) is\_disabled boolean [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/create-a-payout-method-for-the-current-promoter#response-meta) meta object [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/create-a-payout-method-for-the-current-promoter#response-is-selected) is\_selected boolean [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/create-a-payout-method-for-the-current-promoter#response-details) details object Show child attributes [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/create-a-payout-method-for-the-current-promoter#response-details-paypal-email) details.paypal\_email string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/create-a-payout-method-for-the-current-promoter#response-details-wise-email) details.wise\_email string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/create-a-payout-method-for-the-current-promoter#response-details-wallet-address) details.wallet\_address string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/create-a-payout-method-for-the-current-promoter#response-details-crypto-currency) details.crypto\_currency string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/create-a-payout-method-for-the-current-promoter#response-details-bank-country) details.bank\_country enum Available options: `AD`, `AE`, `AL`, `AT`, `AU`, `AZ`, `BA`, `BE`, `BG`, `BH`, `BR`, `BY`, `CA`, `CH`, `CI`, `CR`, `CV`, `CY`, `CZ`, `DE`, `DK`, `DO`, `EE`, `EG`, `ES`, `FI`, `FO`, `FR`, `GA`, `GB`, `GE`, `GI`, `GL`, `GR`, `HR`, `HU`, `IE`, `IL`, `IQ`, `IS`, `IT`, `JO`, `KW`, `KZ`, `LB`, `LI`, `LT`, `LU`, `LV`, `MC`, `MD`, `ME`, `MG`, `MK`, `MR`, `MT`, `MU`, `NL`, `NO`, `PK`, `PL`, `PS`, `PT`, `QA`, `RO`, `RS`, `SA`, `SC`, `SE`, `SI`, `SK`, `SM`, `SV`, `TN`, `TR`, `UA`, `US`, `VA`, `VG`, `XK` [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/create-a-payout-method-for-the-current-promoter#response-details-account-holder-name) details.account\_holder\_name string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/create-a-payout-method-for-the-current-promoter#response-details-account-number) details.account\_number string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/create-a-payout-method-for-the-current-promoter#response-details-routing-aba-number) details.routing\_aba\_number string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/create-a-payout-method-for-the-current-promoter#response-details-country) details.country string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/create-a-payout-method-for-the-current-promoter#response-details-state) details.state string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/create-a-payout-method-for-the-current-promoter#response-details-postal-code) details.postal\_code string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/create-a-payout-method-for-the-current-promoter#response-details-address) details.address string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/create-a-payout-method-for-the-current-promoter#response-details-city) details.city string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/create-a-payout-method-for-the-current-promoter#response-details-transit-number) details.transit\_number string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/create-a-payout-method-for-the-current-promoter#response-details-institution-number) details.institution\_number string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/create-a-payout-method-for-the-current-promoter#response-details-bsb-code) details.bsb\_code string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/create-a-payout-method-for-the-current-promoter#response-details-sort-code) details.sort\_code string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/create-a-payout-method-for-the-current-promoter#response-details-iban) details.iban string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/create-a-payout-method-for-the-current-promoter#response-details-swift-bic-code) details.swift\_bic\_code string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/create-a-payout-method-for-the-current-promoter#response-details-bank-name) details.bank\_name string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/create-a-payout-method-for-the-current-promoter#response-details-bank-city) details.bank\_city string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/create-a-payout-method-for-the-current-promoter#response-details-bank-address) details.bank\_address string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/create-a-payout-method-for-the-current-promoter#response-managed-payouts) managed\_payouts boolean [Get all payout methods for current promoter](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/get-all-payout-methods-for-current-promoter) [Get a payout method](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/get-a-payout-method) ⌘I --- # Update a payout method - FirstPromoter Docs [Skip to main content](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/update-a-payout-method#content-area) [FirstPromoter Docs home page![light logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/light.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=6ded212b82547bec37a22e90f72eeb71)![dark logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/dark.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=c393ff83772047b8a444f78a1e393e7f)](https://docs.firstpromoter.com/) v2 Search... ⌘K Search... Navigation [Documentation](https://docs.firstpromoter.com/introduction) [API Reference](https://docs.firstpromoter.com/api-reference-v2/api-admin/introduction) [Affiliate API Reference](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/introduction) Update a payout method cURL Copy curl --request PUT \ --url https://api.firstpromoter.com/api/v2/affiliate/payout_methods/{id} \ --header 'Account-ID: ' \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data ' { "details": { "paypal_email": "", "wise_email": "", "wallet_address": "", "crypto_currency": "", "bank_country": "AD", "account_holder_name": "", "account_number": "", "routing_aba_number": "", "country": "", "state": "", "postal_code": "", "address": "", "city": "", "transit_number": "", "institution_number": "", "bsb_code": "", "sort_code": "", "iban": "", "swift_bic_code": "", "bank_name": "", "bank_city": "", "bank_address": "" }, "method": "paypal", "is_disabled": true, "is_selected": true } ' 200 400 401 403 404 422 Copy { "id": 123, "method": "paypal", "date_added": "2023-11-07T05:31:56Z", "is_disabled": true, "meta": {}, "is_selected": true, "details": { "paypal_email": "", "wise_email": "", "wallet_address": "", "crypto_currency": "", "bank_country": "AD", "account_holder_name": "", "account_number": "", "routing_aba_number": "", "country": "", "state": "", "postal_code": "", "address": "", "city": "", "transit_number": "", "institution_number": "", "bsb_code": "", "sort_code": "", "iban": "", "swift_bic_code": "", "bank_name": "", "bank_city": "", "bank_address": "" }, "managed_payouts": true } PUT / payout\_methods / {id} Try it Update a payout method cURL Copy curl --request PUT \ --url https://api.firstpromoter.com/api/v2/affiliate/payout_methods/{id} \ --header 'Account-ID: ' \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data ' { "details": { "paypal_email": "", "wise_email": "", "wallet_address": "", "crypto_currency": "", "bank_country": "AD", "account_holder_name": "", "account_number": "", "routing_aba_number": "", "country": "", "state": "", "postal_code": "", "address": "", "city": "", "transit_number": "", "institution_number": "", "bsb_code": "", "sort_code": "", "iban": "", "swift_bic_code": "", "bank_name": "", "bank_city": "", "bank_address": "" }, "method": "paypal", "is_disabled": true, "is_selected": true } ' 200 400 401 403 404 422 Copy { "id": 123, "method": "paypal", "date_added": "2023-11-07T05:31:56Z", "is_disabled": true, "meta": {}, "is_selected": true, "details": { "paypal_email": "", "wise_email": "", "wallet_address": "", "crypto_currency": "", "bank_country": "AD", "account_holder_name": "", "account_number": "", "routing_aba_number": "", "country": "", "state": "", "postal_code": "", "address": "", "city": "", "transit_number": "", "institution_number": "", "bsb_code": "", "sort_code": "", "iban": "", "swift_bic_code": "", "bank_name": "", "bank_city": "", "bank_address": "" }, "managed_payouts": true } #### Authorizations [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/update-a-payout-method#authorization-authorization) Authorization string header required Access token passed as a Bearer token in the Authorization header #### Headers [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/update-a-payout-method#parameter-account-id) Account-ID string required Account identifier that specifies which account is making the request Example: `"acc_123456"` #### Path Parameters [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/update-a-payout-method#parameter-id) id integer required Payout method ID #### Body application/json [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/update-a-payout-method#body-details) details object required Show child attributes [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/update-a-payout-method#body-details-paypal-email) details.paypal\_email string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/update-a-payout-method#body-details-wise-email) details.wise\_email string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/update-a-payout-method#body-details-wallet-address) details.wallet\_address string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/update-a-payout-method#body-details-crypto-currency) details.crypto\_currency string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/update-a-payout-method#body-details-bank-country) details.bank\_country enum Available options: `AD`, `AE`, `AL`, `AT`, `AU`, `AZ`, `BA`, `BE`, `BG`, `BH`, `BR`, `BY`, `CA`, `CH`, `CI`, `CR`, `CV`, `CY`, `CZ`, `DE`, `DK`, `DO`, `EE`, `EG`, `ES`, `FI`, `FO`, `FR`, `GA`, `GB`, `GE`, `GI`, `GL`, `GR`, `HR`, `HU`, `IE`, `IL`, `IQ`, `IS`, `IT`, `JO`, `KW`, `KZ`, `LB`, `LI`, `LT`, `LU`, `LV`, `MC`, `MD`, `ME`, `MG`, `MK`, `MR`, `MT`, `MU`, `NL`, `NO`, `PK`, `PL`, `PS`, `PT`, `QA`, `RO`, `RS`, `SA`, `SC`, `SE`, `SI`, `SK`, `SM`, `SV`, `TN`, `TR`, `UA`, `US`, `VA`, `VG`, `XK` [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/update-a-payout-method#body-details-account-holder-name) details.account\_holder\_name string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/update-a-payout-method#body-details-account-number) details.account\_number string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/update-a-payout-method#body-details-routing-aba-number) details.routing\_aba\_number string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/update-a-payout-method#body-details-country) details.country string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/update-a-payout-method#body-details-state) details.state string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/update-a-payout-method#body-details-postal-code) details.postal\_code string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/update-a-payout-method#body-details-address) details.address string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/update-a-payout-method#body-details-city) details.city string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/update-a-payout-method#body-details-transit-number) details.transit\_number string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/update-a-payout-method#body-details-institution-number) details.institution\_number string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/update-a-payout-method#body-details-bsb-code) details.bsb\_code string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/update-a-payout-method#body-details-sort-code) details.sort\_code string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/update-a-payout-method#body-details-iban) details.iban string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/update-a-payout-method#body-details-swift-bic-code) details.swift\_bic\_code string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/update-a-payout-method#body-details-bank-name) details.bank\_name string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/update-a-payout-method#body-details-bank-city) details.bank\_city string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/update-a-payout-method#body-details-bank-address) details.bank\_address string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/update-a-payout-method#body-method) method enum Available options: `paypal`, `bank`, `wise`, `crypto`, `custom`, `dots` [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/update-a-payout-method#body-is-disabled) is\_disabled boolean [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/update-a-payout-method#body-is-selected) is\_selected boolean #### Response 200 application/json Updated payout method [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/update-a-payout-method#response-id) id integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/update-a-payout-method#response-method) method enum Available options: `paypal`, `bank`, `wise`, `crypto`, `custom`, `dots` [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/update-a-payout-method#response-date-added) date\_added string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/update-a-payout-method#response-is-disabled) is\_disabled boolean [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/update-a-payout-method#response-meta) meta object [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/update-a-payout-method#response-is-selected) is\_selected boolean [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/update-a-payout-method#response-details) details object Show child attributes [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/update-a-payout-method#response-details-paypal-email) details.paypal\_email string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/update-a-payout-method#response-details-wise-email) details.wise\_email string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/update-a-payout-method#response-details-wallet-address) details.wallet\_address string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/update-a-payout-method#response-details-crypto-currency) details.crypto\_currency string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/update-a-payout-method#response-details-bank-country) details.bank\_country enum Available options: `AD`, `AE`, `AL`, `AT`, `AU`, `AZ`, `BA`, `BE`, `BG`, `BH`, `BR`, `BY`, `CA`, `CH`, `CI`, `CR`, `CV`, `CY`, `CZ`, `DE`, `DK`, `DO`, `EE`, `EG`, `ES`, `FI`, `FO`, `FR`, `GA`, `GB`, `GE`, `GI`, `GL`, `GR`, `HR`, `HU`, `IE`, `IL`, `IQ`, `IS`, `IT`, `JO`, `KW`, `KZ`, `LB`, `LI`, `LT`, `LU`, `LV`, `MC`, `MD`, `ME`, `MG`, `MK`, `MR`, `MT`, `MU`, `NL`, `NO`, `PK`, `PL`, `PS`, `PT`, `QA`, `RO`, `RS`, `SA`, `SC`, `SE`, `SI`, `SK`, `SM`, `SV`, `TN`, `TR`, `UA`, `US`, `VA`, `VG`, `XK` [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/update-a-payout-method#response-details-account-holder-name) details.account\_holder\_name string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/update-a-payout-method#response-details-account-number) details.account\_number string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/update-a-payout-method#response-details-routing-aba-number) details.routing\_aba\_number string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/update-a-payout-method#response-details-country) details.country string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/update-a-payout-method#response-details-state) details.state string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/update-a-payout-method#response-details-postal-code) details.postal\_code string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/update-a-payout-method#response-details-address) details.address string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/update-a-payout-method#response-details-city) details.city string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/update-a-payout-method#response-details-transit-number) details.transit\_number string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/update-a-payout-method#response-details-institution-number) details.institution\_number string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/update-a-payout-method#response-details-bsb-code) details.bsb\_code string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/update-a-payout-method#response-details-sort-code) details.sort\_code string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/update-a-payout-method#response-details-iban) details.iban string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/update-a-payout-method#response-details-swift-bic-code) details.swift\_bic\_code string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/update-a-payout-method#response-details-bank-name) details.bank\_name string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/update-a-payout-method#response-details-bank-city) details.bank\_city string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/update-a-payout-method#response-details-bank-address) details.bank\_address string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/update-a-payout-method#response-managed-payouts) managed\_payouts boolean [Get a payout method](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/get-a-payout-method) [Delete a payout method](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/delete-a-payout-method) ⌘I --- # Export payouts - FirstPromoter Docs [Skip to main content](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/export-payouts#content-area) [FirstPromoter Docs home page![light logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/light.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=6ded212b82547bec37a22e90f72eeb71)![dark logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/dark.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=c393ff83772047b8a444f78a1e393e7f)](https://docs.firstpromoter.com/) v2 Search... ⌘K Search... Navigation [Documentation](https://docs.firstpromoter.com/introduction) [API Reference](https://docs.firstpromoter.com/api-reference-v2/api-admin/introduction) [Affiliate API Reference](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/introduction) Export payouts cURL Copy curl --request GET \ --url https://api.firstpromoter.com/api/v2/affiliate/affiliate/v1/payouts/export \ --header 'Account-ID: ' \ --header 'Authorization: Bearer ' 200 202 401 403 422 Copy "" GET / affiliate / v1 / payouts / export Try it Export payouts cURL Copy curl --request GET \ --url https://api.firstpromoter.com/api/v2/affiliate/affiliate/v1/payouts/export \ --header 'Account-ID: ' \ --header 'Authorization: Bearer ' 200 202 401 403 422 Copy "" #### Authorizations [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/export-payouts#authorization-authorization) Authorization string header required Access token passed as a Bearer token in the Authorization header #### Headers [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/export-payouts#parameter-account-id) Account-ID string required Account identifier that specifies which account is making the request Example: `"acc_123456"` #### Query Parameters [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/export-payouts#parameter-q) q string Search params [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/export-payouts#parameter-filters) filters object Filter parameters Show child attributes [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/export-payouts#parameter-status) filters.status enum Available options: `pending`, `completed`, `failed`, `processing`, `cancelled` [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/export-payouts#parameter-campaign-id-one-of-0) filters.campaign\_id integerinteger\[\] [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/export-payouts#parameter-payments-batch-id-one-of-0) filters.payments\_batch\_id integerinteger\[\] [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/export-payouts#parameter-due-period) filters.due\_period enum Available options: `next`, `overdue`, `custom` [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/export-payouts#parameter-period-start) filters.period\_start string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/export-payouts#parameter-period-end) filters.period\_end string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/export-payouts#parameter-payout-method) filters.payout\_method enum Available options: `paypal`, `bank`, `wise`, `crypto`, `custom`, `dots`, `not_set` [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/export-payouts#parameter-group-ref) filters.group\_ref string #### Response 200 text/csv Payouts exported successfully The response is of type `string`. [Get due payout stats for current promoter](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/get-due-payout-stats-for-current-promoter) [Create promo code](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promo-codes/create-promo-code) ⌘I --- # Get all payouts for current promoter - FirstPromoter Docs [Skip to main content](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/get-all-payouts-for-current-promoter#content-area) [FirstPromoter Docs home page![light logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/light.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=6ded212b82547bec37a22e90f72eeb71)![dark logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/dark.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=c393ff83772047b8a444f78a1e393e7f)](https://docs.firstpromoter.com/) v2 Search... ⌘K Search... Navigation [Documentation](https://docs.firstpromoter.com/introduction) [API Reference](https://docs.firstpromoter.com/api-reference-v2/api-admin/introduction) [Affiliate API Reference](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/introduction) Get all payouts cURL Copy curl --request GET \ --url https://api.firstpromoter.com/api/v2/affiliate/affiliate/v1/payouts \ --header 'Account-ID: ' \ --header 'Authorization: Bearer ' 200 401 403 Copy { "data": [\ {\ "id": 123,\ "status": "pending",\ "amount": 123,\ "payments_batch_id": 123,\ "tax_rate": 123,\ "unit": "",\ "period_start": "2023-12-25",\ "period_end": "2023-12-25",\ "paid_at": "2023-11-07T05:31:56Z",\ "processing_started_at": "2023-11-07T05:31:56Z",\ "failed_at": "2023-11-07T05:31:56Z",\ "error": "",\ "total_incl_tax": 123,\ "created_at": "2023-11-07T05:31:56Z",\ "payout_method": {},\ "promoter": {\ "id": 123,\ "email": "",\ "name": ""\ },\ "campaign": {\ "id": 123,\ "name": "",\ "color": ""\ }\ }\ ], "meta": { "net_payout_days": 123, "payout_cycle": "", "min_payment": 123, "min_paying_customers": 123, "terms_description": "", "selected_payout_methods": [\ ""\ ], "payout_method_options": {}, "managed_payouts": true } } GET / affiliate / v1 / payouts Try it Get all payouts cURL Copy curl --request GET \ --url https://api.firstpromoter.com/api/v2/affiliate/affiliate/v1/payouts \ --header 'Account-ID: ' \ --header 'Authorization: Bearer ' 200 401 403 Copy { "data": [\ {\ "id": 123,\ "status": "pending",\ "amount": 123,\ "payments_batch_id": 123,\ "tax_rate": 123,\ "unit": "",\ "period_start": "2023-12-25",\ "period_end": "2023-12-25",\ "paid_at": "2023-11-07T05:31:56Z",\ "processing_started_at": "2023-11-07T05:31:56Z",\ "failed_at": "2023-11-07T05:31:56Z",\ "error": "",\ "total_incl_tax": 123,\ "created_at": "2023-11-07T05:31:56Z",\ "payout_method": {},\ "promoter": {\ "id": 123,\ "email": "",\ "name": ""\ },\ "campaign": {\ "id": 123,\ "name": "",\ "color": ""\ }\ }\ ], "meta": { "net_payout_days": 123, "payout_cycle": "", "min_payment": 123, "min_paying_customers": 123, "terms_description": "", "selected_payout_methods": [\ ""\ ], "payout_method_options": {}, "managed_payouts": true } } #### Authorizations [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/get-all-payouts-for-current-promoter#authorization-authorization) Authorization string header required Access token passed as a Bearer token in the Authorization header #### Headers [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/get-all-payouts-for-current-promoter#parameter-account-id) Account-ID string required Account identifier that specifies which account is making the request Example: `"acc_123456"` #### Query Parameters [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/get-all-payouts-for-current-promoter#parameter-q) q string Search params. Searches by 'promoter.profile.first\_name`,`promoter.profile.last\_name`,`promoter.user.email\` [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/get-all-payouts-for-current-promoter#parameter-filters-status) filters\[status\] enum Status filter Available options: `pending`, `completed`, `failed`, `processing`, `cancelled` [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/get-all-payouts-for-current-promoter#parameter-one-of-0) filters\[campaign\_id\] integerinteger\[\] Campaign ids filter [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/get-all-payouts-for-current-promoter#parameter-one-of-0) filters\[payments\_batch\_id\] integerinteger\[\] Payment batches ids filter [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/get-all-payouts-for-current-promoter#parameter-filters-due-period) filters\[due\_period\] enum Due period filter Available options: `next`, `overdue`, `custom` [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/get-all-payouts-for-current-promoter#parameter-filters-period-start) filters\[period\_start\] string Period start filter. Send "not\_set" for returning the ones with period\_start == null [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/get-all-payouts-for-current-promoter#parameter-filters-period-end) filters\[period\_end\] string Period end filter. Send "not\_set" for returning the ones with period\_end == null [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/get-all-payouts-for-current-promoter#parameter-filters-payout-method) filters\[payout\_method\] enum Payout method filter Available options: `paypal`, `bank`, `wise`, `crypto`, `custom`, `dots`, `not_set` [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/get-all-payouts-for-current-promoter#parameter-filters-group-ref) filters\[group\_ref\] string Group ref filter #### Response 200 application/json List of payouts [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/get-all-payouts-for-current-promoter#response-data) data object\[\] Show child attributes [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/get-all-payouts-for-current-promoter#response-data-items-id) data.id integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/get-all-payouts-for-current-promoter#response-data-items-status) data.status enum Available options: `pending`, `completed`, `failed`, `processing`, `cancelled` [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/get-all-payouts-for-current-promoter#response-data-items-amount) data.amount number [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/get-all-payouts-for-current-promoter#response-data-items-payments-batch-id) data.payments\_batch\_id integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/get-all-payouts-for-current-promoter#response-data-items-tax-rate) data.tax\_rate number [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/get-all-payouts-for-current-promoter#response-data-items-unit) data.unit string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/get-all-payouts-for-current-promoter#response-data-items-period-start) data.period\_start string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/get-all-payouts-for-current-promoter#response-data-items-period-end) data.period\_end string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/get-all-payouts-for-current-promoter#response-data-items-paid-at) data.paid\_at string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/get-all-payouts-for-current-promoter#response-data-items-processing-started-at) data.processing\_started\_at string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/get-all-payouts-for-current-promoter#response-data-items-failed-at) data.failed\_at string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/get-all-payouts-for-current-promoter#response-data-items-error) data.error string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/get-all-payouts-for-current-promoter#response-data-items-total-incl-tax) data.total\_incl\_tax number [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/get-all-payouts-for-current-promoter#response-data-items-created-at) data.created\_at string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/get-all-payouts-for-current-promoter#response-data-items-payout-method) data.payout\_method object [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/get-all-payouts-for-current-promoter#response-data-items-promoter) data.promoter object Show child attributes [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/get-all-payouts-for-current-promoter#response-data-items-promoter-id) data.promoter.id integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/get-all-payouts-for-current-promoter#response-data-items-promoter-email) data.promoter.email string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/get-all-payouts-for-current-promoter#response-data-items-promoter-name) data.promoter.name string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/get-all-payouts-for-current-promoter#response-data-items-campaign) data.campaign object Show child attributes [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/get-all-payouts-for-current-promoter#response-data-items-campaign-id) data.campaign.id integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/get-all-payouts-for-current-promoter#response-data-items-campaign-name) data.campaign.name string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/get-all-payouts-for-current-promoter#response-data-items-campaign-color) data.campaign.color string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/get-all-payouts-for-current-promoter#response-meta) meta object Show child attributes [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/get-all-payouts-for-current-promoter#response-meta-net-payout-days) meta.net\_payout\_days integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/get-all-payouts-for-current-promoter#response-meta-payout-cycle) meta.payout\_cycle string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/get-all-payouts-for-current-promoter#response-meta-min-payment) meta.min\_payment number [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/get-all-payouts-for-current-promoter#response-meta-min-paying-customers) meta.min\_paying\_customers integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/get-all-payouts-for-current-promoter#response-meta-terms-description) meta.terms\_description string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/get-all-payouts-for-current-promoter#response-meta-selected-payout-methods) meta.selected\_payout\_methods string\[\] [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/get-all-payouts-for-current-promoter#response-meta-payout-method-options) meta.payout\_method\_options object [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/get-all-payouts-for-current-promoter#response-meta-managed-payouts) meta.managed\_payouts boolean [Delete a payout method](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payout-methods/delete-a-payout-method) [Get due payout stats for current promoter](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/get-due-payout-stats-for-current-promoter) ⌘I --- # Get due payout stats for current promoter - FirstPromoter Docs [Skip to main content](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/get-due-payout-stats-for-current-promoter#content-area) [FirstPromoter Docs home page![light logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/light.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=6ded212b82547bec37a22e90f72eeb71)![dark logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/dark.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=c393ff83772047b8a444f78a1e393e7f)](https://docs.firstpromoter.com/) v2 Search... ⌘K Search... Navigation [Documentation](https://docs.firstpromoter.com/introduction) [API Reference](https://docs.firstpromoter.com/api-reference-v2/api-admin/introduction) [Affiliate API Reference](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/introduction) Get due payout stats cURL Copy curl --request GET \ --url https://api.firstpromoter.com/api/v2/affiliate/affiliate/v1/payouts/due_stats \ --header 'Account-ID: ' \ --header 'Authorization: Bearer ' 200 401 403 Copy { "meta": { "net_payout_days": 123, "payout_cycle": "", "min_payment": 123, "min_paying_customers": 123, "terms_description": "", "selected_payout_methods": [\ ""\ ], "payout_method_options": {}, "managed_payouts": true }, "data": { "next": { "promoters_count": 123, "amounts": {}, "total_incl_tax": 123, "due_date": "2023-12-25", "period_end": "2023-12-25" }, "overdue": { "promoters_count": 123, "amounts": {}, "total_incl_tax": 123, "due_date": "2023-12-25", "period_end": "2023-12-25" }, "custom": { "promoters_count": 123, "amounts": {}, "total_incl_tax": 123, "due_date": "2023-12-25", "period_end": "2023-12-25" } } } GET / affiliate / v1 / payouts / due\_stats Try it Get due payout stats cURL Copy curl --request GET \ --url https://api.firstpromoter.com/api/v2/affiliate/affiliate/v1/payouts/due_stats \ --header 'Account-ID: ' \ --header 'Authorization: Bearer ' 200 401 403 Copy { "meta": { "net_payout_days": 123, "payout_cycle": "", "min_payment": 123, "min_paying_customers": 123, "terms_description": "", "selected_payout_methods": [\ ""\ ], "payout_method_options": {}, "managed_payouts": true }, "data": { "next": { "promoters_count": 123, "amounts": {}, "total_incl_tax": 123, "due_date": "2023-12-25", "period_end": "2023-12-25" }, "overdue": { "promoters_count": 123, "amounts": {}, "total_incl_tax": 123, "due_date": "2023-12-25", "period_end": "2023-12-25" }, "custom": { "promoters_count": 123, "amounts": {}, "total_incl_tax": 123, "due_date": "2023-12-25", "period_end": "2023-12-25" } } } #### Authorizations [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/get-due-payout-stats-for-current-promoter#authorization-authorization) Authorization string header required Access token passed as a Bearer token in the Authorization header #### Headers [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/get-due-payout-stats-for-current-promoter#parameter-account-id) Account-ID string required Account identifier that specifies which account is making the request Example: `"acc_123456"` #### Response 200 application/json Payout stats [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/get-due-payout-stats-for-current-promoter#response-meta) meta object Show child attributes [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/get-due-payout-stats-for-current-promoter#response-meta-net-payout-days) meta.net\_payout\_days integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/get-due-payout-stats-for-current-promoter#response-meta-payout-cycle) meta.payout\_cycle string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/get-due-payout-stats-for-current-promoter#response-meta-min-payment) meta.min\_payment number [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/get-due-payout-stats-for-current-promoter#response-meta-min-paying-customers) meta.min\_paying\_customers integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/get-due-payout-stats-for-current-promoter#response-meta-terms-description) meta.terms\_description string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/get-due-payout-stats-for-current-promoter#response-meta-selected-payout-methods) meta.selected\_payout\_methods string\[\] [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/get-due-payout-stats-for-current-promoter#response-meta-payout-method-options) meta.payout\_method\_options object [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/get-due-payout-stats-for-current-promoter#response-meta-managed-payouts) meta.managed\_payouts boolean [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/get-due-payout-stats-for-current-promoter#response-data) data object Show child attributes [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/get-due-payout-stats-for-current-promoter#response-data-next) data.next object Show child attributes [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/get-due-payout-stats-for-current-promoter#response-data-next-promoters-count) data.next.promoters\_count integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/get-due-payout-stats-for-current-promoter#response-data-next-amounts) data.next.amounts object Show child attributes [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/get-due-payout-stats-for-current-promoter#response-data-next-amounts-additional-properties) data.next.amounts.{key} number [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/get-due-payout-stats-for-current-promoter#response-data-next-total-incl-tax) data.next.total\_incl\_tax number [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/get-due-payout-stats-for-current-promoter#response-data-next-due-date) data.next.due\_date string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/get-due-payout-stats-for-current-promoter#response-data-next-period-end) data.next.period\_end string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/get-due-payout-stats-for-current-promoter#response-data-overdue) data.overdue object Show child attributes [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/get-due-payout-stats-for-current-promoter#response-data-overdue-promoters-count) data.overdue.promoters\_count integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/get-due-payout-stats-for-current-promoter#response-data-overdue-amounts) data.overdue.amounts object Show child attributes [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/get-due-payout-stats-for-current-promoter#response-data-overdue-amounts-additional-properties) data.overdue.amounts.{key} number [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/get-due-payout-stats-for-current-promoter#response-data-overdue-total-incl-tax) data.overdue.total\_incl\_tax number [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/get-due-payout-stats-for-current-promoter#response-data-overdue-due-date) data.overdue.due\_date string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/get-due-payout-stats-for-current-promoter#response-data-overdue-period-end) data.overdue.period\_end string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/get-due-payout-stats-for-current-promoter#response-data-custom) data.custom object Show child attributes [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/get-due-payout-stats-for-current-promoter#response-data-custom-promoters-count) data.custom.promoters\_count integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/get-due-payout-stats-for-current-promoter#response-data-custom-amounts) data.custom.amounts object Show child attributes [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/get-due-payout-stats-for-current-promoter#response-data-custom-amounts-additional-properties) data.custom.amounts.{key} number [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/get-due-payout-stats-for-current-promoter#response-data-custom-total-incl-tax) data.custom.total\_incl\_tax number [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/get-due-payout-stats-for-current-promoter#response-data-custom-due-date) data.custom.due\_date string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/get-due-payout-stats-for-current-promoter#response-data-custom-period-end) data.custom.period\_end string [Get all payouts for current promoter](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/get-all-payouts-for-current-promoter) [Export payouts](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/export-payouts) ⌘I --- # Archive promo code by id - FirstPromoter Docs [Skip to main content](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promo-codes/archive-promo-code-by-id#content-area) [FirstPromoter Docs home page![light logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/light.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=6ded212b82547bec37a22e90f72eeb71)![dark logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/dark.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=c393ff83772047b8a444f78a1e393e7f)](https://docs.firstpromoter.com/) v2 Search... ⌘K Search... Navigation [Documentation](https://docs.firstpromoter.com/introduction) [API Reference](https://docs.firstpromoter.com/api-reference-v2/api-admin/introduction) [Affiliate API Reference](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/introduction) Archive promo code by id cURL Copy curl --request DELETE \ --url https://api.firstpromoter.com/api/v2/affiliate/promo_codes/{id} \ --header 'Account-ID: ' \ --header 'Authorization: Bearer ' 403 Copy { "message": "", "code": "", "errors": {} } DELETE / promo\_codes / {id} Try it Archive promo code by id cURL Copy curl --request DELETE \ --url https://api.firstpromoter.com/api/v2/affiliate/promo_codes/{id} \ --header 'Account-ID: ' \ --header 'Authorization: Bearer ' 403 Copy { "message": "", "code": "", "errors": {} } #### Authorizations [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promo-codes/archive-promo-code-by-id#authorization-authorization) Authorization string header required Access token passed as a Bearer token in the Authorization header #### Headers [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promo-codes/archive-promo-code-by-id#parameter-account-id) Account-ID string required Account identifier that specifies which account is making the request Example: `"acc_123456"` #### Path Parameters [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promo-codes/archive-promo-code-by-id#parameter-id) id integer required #### Response 200 Promo code archived successfully [Update promo code by id](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promo-codes/update-promo-code-by-id) [Update promotion ref token for the promoter campaign](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoter-campaigns/update-promotion-ref_token-for-the-promoter_campaign) ⌘I --- # Create promo code - FirstPromoter Docs [Skip to main content](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promo-codes/create-promo-code#content-area) [FirstPromoter Docs home page![light logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/light.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=6ded212b82547bec37a22e90f72eeb71)![dark logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/dark.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=c393ff83772047b8a444f78a1e393e7f)](https://docs.firstpromoter.com/) v2 Search... ⌘K Search... Navigation [Documentation](https://docs.firstpromoter.com/introduction) [API Reference](https://docs.firstpromoter.com/api-reference-v2/api-admin/introduction) [Affiliate API Reference](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/introduction) Create promo code cURL Copy curl --request POST \ --url https://api.firstpromoter.com/api/v2/affiliate/promo_codes \ --header 'Account-ID: ' \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data ' { "code": "", "reward_id": 123, "promoter_campaign_id": 123, "description": "", "metadata": {}, "details": {} } ' 200 400 401 403 Copy { "id": 123, "code": "", "reward": { "id": 123, "name": "" }, "ext_id": "", "description": "", "company_id": 123, "promoter_campaign_id": 123, "metadata": {}, "details": {}, "archived_at": "2023-11-07T05:31:56Z" } POST / promo\_codes Try it Create promo code cURL Copy curl --request POST \ --url https://api.firstpromoter.com/api/v2/affiliate/promo_codes \ --header 'Account-ID: ' \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data ' { "code": "", "reward_id": 123, "promoter_campaign_id": 123, "description": "", "metadata": {}, "details": {} } ' 200 400 401 403 Copy { "id": 123, "code": "", "reward": { "id": 123, "name": "" }, "ext_id": "", "description": "", "company_id": 123, "promoter_campaign_id": 123, "metadata": {}, "details": {}, "archived_at": "2023-11-07T05:31:56Z" } #### Authorizations [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promo-codes/create-promo-code#authorization-authorization) Authorization string header required Access token passed as a Bearer token in the Authorization header #### Headers [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promo-codes/create-promo-code#parameter-account-id) Account-ID string required Account identifier that specifies which account is making the request Example: `"acc_123456"` #### Body application/json [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promo-codes/create-promo-code#body-code) code string required Code of the promo code [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promo-codes/create-promo-code#body-reward-id) reward\_id integer required ID of the reward [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promo-codes/create-promo-code#body-promoter-campaign-id) promoter\_campaign\_id integer required ID of the promoter campaign [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promo-codes/create-promo-code#body-description) description string Description of the promo code [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promo-codes/create-promo-code#body-metadata) metadata object Metadata of the promo code [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promo-codes/create-promo-code#body-details) details object Details of the promo code #### Response 200 application/json Promo code created successfully [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promo-codes/create-promo-code#response-id) id integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promo-codes/create-promo-code#response-code) code string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promo-codes/create-promo-code#response-reward) reward object Show child attributes [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promo-codes/create-promo-code#response-reward-id) reward.id integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promo-codes/create-promo-code#response-reward-name) reward.name string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promo-codes/create-promo-code#response-ext-id) ext\_id string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promo-codes/create-promo-code#response-description) description string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promo-codes/create-promo-code#response-company-id) company\_id integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promo-codes/create-promo-code#response-promoter-campaign-id) promoter\_campaign\_id integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promo-codes/create-promo-code#response-metadata) metadata object [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promo-codes/create-promo-code#response-details) details object [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promo-codes/create-promo-code#response-archived-at) archived\_at string [Export payouts](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/payouts/export-payouts) [Update promo code by id](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promo-codes/update-promo-code-by-id) ⌘I --- # Update promo code by id - FirstPromoter Docs [Skip to main content](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promo-codes/update-promo-code-by-id#content-area) [FirstPromoter Docs home page![light logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/light.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=6ded212b82547bec37a22e90f72eeb71)![dark logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/dark.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=c393ff83772047b8a444f78a1e393e7f)](https://docs.firstpromoter.com/) v2 Search... ⌘K Search... Navigation [Documentation](https://docs.firstpromoter.com/introduction) [API Reference](https://docs.firstpromoter.com/api-reference-v2/api-admin/introduction) [Affiliate API Reference](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/introduction) Update promo code by id cURL Copy curl --request PUT \ --url https://api.firstpromoter.com/api/v2/affiliate/promo_codes/{id} \ --header 'Account-ID: ' \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data ' { "code": "", "description": "", "reward_id": 123, "promoter_campaign_id": 123, "metadata": {}, "details": {} } ' 200 403 Copy { "id": 123, "code": "", "reward": { "id": 123, "name": "" }, "ext_id": "", "description": "", "company_id": 123, "promoter_campaign_id": 123, "metadata": {}, "details": {}, "archived_at": "2023-11-07T05:31:56Z" } PUT / promo\_codes / {id} Try it Update promo code by id cURL Copy curl --request PUT \ --url https://api.firstpromoter.com/api/v2/affiliate/promo_codes/{id} \ --header 'Account-ID: ' \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data ' { "code": "", "description": "", "reward_id": 123, "promoter_campaign_id": 123, "metadata": {}, "details": {} } ' 200 403 Copy { "id": 123, "code": "", "reward": { "id": 123, "name": "" }, "ext_id": "", "description": "", "company_id": 123, "promoter_campaign_id": 123, "metadata": {}, "details": {}, "archived_at": "2023-11-07T05:31:56Z" } #### Authorizations [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promo-codes/update-promo-code-by-id#authorization-authorization) Authorization string header required Access token passed as a Bearer token in the Authorization header #### Headers [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promo-codes/update-promo-code-by-id#parameter-account-id) Account-ID string required Account identifier that specifies which account is making the request Example: `"acc_123456"` #### Path Parameters [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promo-codes/update-promo-code-by-id#parameter-id) id integer required #### Body application/json [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promo-codes/update-promo-code-by-id#body-code) code string Code of the promo code [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promo-codes/update-promo-code-by-id#body-description) description string Description of the promo code [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promo-codes/update-promo-code-by-id#body-reward-id) reward\_id integer ID of the reward [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promo-codes/update-promo-code-by-id#body-promoter-campaign-id) promoter\_campaign\_id integer ID of the promoter campaign [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promo-codes/update-promo-code-by-id#body-metadata) metadata object Metadata of the promo code [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promo-codes/update-promo-code-by-id#body-details) details object Details of the promo code #### Response 200 application/json Promo code updated successfully [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promo-codes/update-promo-code-by-id#response-id) id integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promo-codes/update-promo-code-by-id#response-code) code string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promo-codes/update-promo-code-by-id#response-reward) reward object Show child attributes [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promo-codes/update-promo-code-by-id#response-reward-id) reward.id integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promo-codes/update-promo-code-by-id#response-reward-name) reward.name string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promo-codes/update-promo-code-by-id#response-ext-id) ext\_id string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promo-codes/update-promo-code-by-id#response-description) description string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promo-codes/update-promo-code-by-id#response-company-id) company\_id integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promo-codes/update-promo-code-by-id#response-promoter-campaign-id) promoter\_campaign\_id integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promo-codes/update-promo-code-by-id#response-metadata) metadata object [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promo-codes/update-promo-code-by-id#response-details) details object [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promo-codes/update-promo-code-by-id#response-archived-at) archived\_at string [Create promo code](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promo-codes/create-promo-code) [Archive promo code by id](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promo-codes/archive-promo-code-by-id) ⌘I --- # Update promotion ref token for the promoter campaign - FirstPromoter Docs [Skip to main content](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoter-campaigns/update-promotion-ref_token-for-the-promoter_campaign#content-area) [FirstPromoter Docs home page![light logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/light.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=6ded212b82547bec37a22e90f72eeb71)![dark logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/dark.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=c393ff83772047b8a444f78a1e393e7f)](https://docs.firstpromoter.com/) v2 Search... ⌘K Search... Navigation [Documentation](https://docs.firstpromoter.com/introduction) [API Reference](https://docs.firstpromoter.com/api-reference-v2/api-admin/introduction) [Affiliate API Reference](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/introduction) Update promotion ref\_token for the promoter\_campaign cURL Copy curl --request PUT \ --url https://api.firstpromoter.com/api/v2/affiliate/promoter_campaigns/{id} \ --header 'Account-ID: ' \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data ' { "ref_token": "" } ' 200 403 404 422 Copy { "id": 123, "campaign_id": 123, "created_at": "2023-11-07T05:31:56Z", "campaign": { "id": 123, "name": "", "color": "" }, "state": "accepted", "promoter_id": 123, "stats": { "clicks_count": 123, "referrals_count": 123, "sales_count": 123, "customers_count": 123, "revenue_amount": 123 }, "coupon": {}, "display_coupon": {}, "ref_token": "", "ref_link": "", "has_monetary_rewards": true, "rewards_for_promoters": [\ {\ "apply_on": "",\ "product_ids": [\ ""\ ],\ "reward_id": 123,\ "reward": {\ "name": "",\ "promoter_reward_type": "",\ "hide_reward": true,\ "tier_level": 123,\ "coupon": {}\ },\ "products": {}\ }\ ], "rewards_for_referrals": [\ {}\ ], "promo_codes": [\ {}\ ], "recruitment_link_url": "" } PUT / promoter\_campaigns / {id} Try it Update promotion ref\_token for the promoter\_campaign cURL Copy curl --request PUT \ --url https://api.firstpromoter.com/api/v2/affiliate/promoter_campaigns/{id} \ --header 'Account-ID: ' \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data ' { "ref_token": "" } ' 200 403 404 422 Copy { "id": 123, "campaign_id": 123, "created_at": "2023-11-07T05:31:56Z", "campaign": { "id": 123, "name": "", "color": "" }, "state": "accepted", "promoter_id": 123, "stats": { "clicks_count": 123, "referrals_count": 123, "sales_count": 123, "customers_count": 123, "revenue_amount": 123 }, "coupon": {}, "display_coupon": {}, "ref_token": "", "ref_link": "", "has_monetary_rewards": true, "rewards_for_promoters": [\ {\ "apply_on": "",\ "product_ids": [\ ""\ ],\ "reward_id": 123,\ "reward": {\ "name": "",\ "promoter_reward_type": "",\ "hide_reward": true,\ "tier_level": 123,\ "coupon": {}\ },\ "products": {}\ }\ ], "rewards_for_referrals": [\ {}\ ], "promo_codes": [\ {}\ ], "recruitment_link_url": "" } #### Authorizations [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoter-campaigns/update-promotion-ref_token-for-the-promoter_campaign#authorization-authorization) Authorization string header required Access token passed as a Bearer token in the Authorization header #### Headers [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoter-campaigns/update-promotion-ref_token-for-the-promoter_campaign#parameter-account-id) Account-ID string required Account identifier that specifies which account is making the request Example: `"acc_123456"` #### Path Parameters [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoter-campaigns/update-promotion-ref_token-for-the-promoter_campaign#parameter-id) id integer required The id of the promoter\_campaign to be updated #### Body application/json [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoter-campaigns/update-promotion-ref_token-for-the-promoter_campaign#body-ref-token) ref\_token string required The ref\_token of the promoter\_campaign's promotion #### Response 200 application/json Promoter campaign updated successfully [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoter-campaigns/update-promotion-ref_token-for-the-promoter_campaign#response-id) id integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoter-campaigns/update-promotion-ref_token-for-the-promoter_campaign#response-campaign-id) campaign\_id integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoter-campaigns/update-promotion-ref_token-for-the-promoter_campaign#response-created-at) created\_at string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoter-campaigns/update-promotion-ref_token-for-the-promoter_campaign#response-campaign) campaign object Show child attributes [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoter-campaigns/update-promotion-ref_token-for-the-promoter_campaign#response-campaign-id) campaign.id integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoter-campaigns/update-promotion-ref_token-for-the-promoter_campaign#response-campaign-name) campaign.name string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoter-campaigns/update-promotion-ref_token-for-the-promoter_campaign#response-campaign-color) campaign.color string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoter-campaigns/update-promotion-ref_token-for-the-promoter_campaign#response-state) state string Example: `"accepted"` [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoter-campaigns/update-promotion-ref_token-for-the-promoter_campaign#response-promoter-id) promoter\_id integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoter-campaigns/update-promotion-ref_token-for-the-promoter_campaign#response-stats) stats object Show child attributes [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoter-campaigns/update-promotion-ref_token-for-the-promoter_campaign#response-stats-clicks-count) stats.clicks\_count integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoter-campaigns/update-promotion-ref_token-for-the-promoter_campaign#response-stats-referrals-count) stats.referrals\_count integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoter-campaigns/update-promotion-ref_token-for-the-promoter_campaign#response-stats-sales-count) stats.sales\_count integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoter-campaigns/update-promotion-ref_token-for-the-promoter_campaign#response-stats-customers-count) stats.customers\_count integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoter-campaigns/update-promotion-ref_token-for-the-promoter_campaign#response-stats-revenue-amount) stats.revenue\_amount number [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoter-campaigns/update-promotion-ref_token-for-the-promoter_campaign#response-coupon) coupon object [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoter-campaigns/update-promotion-ref_token-for-the-promoter_campaign#response-display-coupon) display\_coupon object [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoter-campaigns/update-promotion-ref_token-for-the-promoter_campaign#response-ref-token) ref\_token string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoter-campaigns/update-promotion-ref_token-for-the-promoter_campaign#response-ref-link) ref\_link string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoter-campaigns/update-promotion-ref_token-for-the-promoter_campaign#response-has-monetary-rewards) has\_monetary\_rewards boolean [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoter-campaigns/update-promotion-ref_token-for-the-promoter_campaign#response-rewards-for-promoters) rewards\_for\_promoters object\[\] Show child attributes [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoter-campaigns/update-promotion-ref_token-for-the-promoter_campaign#response-rewards-for-promoters-items-apply-on) rewards\_for\_promoters.apply\_on string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoter-campaigns/update-promotion-ref_token-for-the-promoter_campaign#response-rewards-for-promoters-items-product-ids) rewards\_for\_promoters.product\_ids string\[\] [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoter-campaigns/update-promotion-ref_token-for-the-promoter_campaign#response-rewards-for-promoters-items-reward-id) rewards\_for\_promoters.reward\_id integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoter-campaigns/update-promotion-ref_token-for-the-promoter_campaign#response-rewards-for-promoters-items-reward) rewards\_for\_promoters.reward object Show child attributes [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoter-campaigns/update-promotion-ref_token-for-the-promoter_campaign#response-rewards-for-promoters-items-reward-name) rewards\_for\_promoters.reward.name string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoter-campaigns/update-promotion-ref_token-for-the-promoter_campaign#response-rewards-for-promoters-items-reward-promoter-reward-type) rewards\_for\_promoters.reward.promoter\_reward\_type string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoter-campaigns/update-promotion-ref_token-for-the-promoter_campaign#response-rewards-for-promoters-items-reward-hide-reward) rewards\_for\_promoters.reward.hide\_reward boolean [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoter-campaigns/update-promotion-ref_token-for-the-promoter_campaign#response-rewards-for-promoters-items-reward-tier-level) rewards\_for\_promoters.reward.tier\_level integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoter-campaigns/update-promotion-ref_token-for-the-promoter_campaign#response-rewards-for-promoters-items-reward-coupon) rewards\_for\_promoters.reward.coupon object [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoter-campaigns/update-promotion-ref_token-for-the-promoter_campaign#response-rewards-for-promoters-items-products) rewards\_for\_promoters.products object [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoter-campaigns/update-promotion-ref_token-for-the-promoter_campaign#response-rewards-for-referrals) rewards\_for\_referrals object\[\] [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoter-campaigns/update-promotion-ref_token-for-the-promoter_campaign#response-promo-codes) promo\_codes object\[\] [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoter-campaigns/update-promotion-ref_token-for-the-promoter_campaign#response-recruitment-link-url) recruitment\_link\_url string [Archive promo code by id](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promo-codes/archive-promo-code-by-id) [Get current promoter](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/get-current-promoter) ⌘I --- # Archives current promoter - FirstPromoter Docs [Skip to main content](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/archives-current-promoter#content-area) [FirstPromoter Docs home page![light logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/light.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=6ded212b82547bec37a22e90f72eeb71)![dark logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/dark.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=c393ff83772047b8a444f78a1e393e7f)](https://docs.firstpromoter.com/) v2 Search... ⌘K Search... Navigation [Documentation](https://docs.firstpromoter.com/introduction) [API Reference](https://docs.firstpromoter.com/api-reference-v2/api-admin/introduction) [Affiliate API Reference](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/introduction) Archives current promoter cURL Copy curl --request POST \ --url https://api.firstpromoter.com/api/v2/affiliate/promoters/archive \ --header 'Account-ID: ' \ --header 'Authorization: Bearer ' POST / promoters / archive Try it Archives current promoter cURL Copy curl --request POST \ --url https://api.firstpromoter.com/api/v2/affiliate/promoters/archive \ --header 'Account-ID: ' \ --header 'Authorization: Bearer ' #### Authorizations [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/archives-current-promoter#authorization-authorization) Authorization string header required Access token passed as a Bearer token in the Authorization header #### Headers [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/archives-current-promoter#parameter-account-id) Account-ID string required Account identifier that specifies which account is making the request Example: `"acc_123456"` #### Response 200 Successful response [Set the user password](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/set-the-user-password) [Get current promoter referral links](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referral-links/get-current-promoter-referral-links) ⌘I --- # Get chart data - FirstPromoter Docs [Skip to main content](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/get-chart-data#content-area) [FirstPromoter Docs home page![light logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/light.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=6ded212b82547bec37a22e90f72eeb71)![dark logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/dark.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=c393ff83772047b8a444f78a1e393e7f)](https://docs.firstpromoter.com/) v2 Search... ⌘K Search... Navigation [Documentation](https://docs.firstpromoter.com/introduction) [API Reference](https://docs.firstpromoter.com/api-reference-v2/api-admin/introduction) [Affiliate API Reference](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/introduction) Get chart data cURL Copy curl --request GET \ --url https://api.firstpromoter.com/api/v2/affiliate/promoters/chart_data \ --header 'Account-ID: ' \ --header 'Authorization: Bearer ' GET / promoters / chart\_data Try it Get chart data cURL Copy curl --request GET \ --url https://api.firstpromoter.com/api/v2/affiliate/promoters/chart_data \ --header 'Account-ID: ' \ --header 'Authorization: Bearer ' #### Authorizations [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/get-chart-data#authorization-authorization) Authorization string header required Access token passed as a Bearer token in the Authorization header #### Headers [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/get-chart-data#parameter-account-id) Account-ID string required Account identifier that specifies which account is making the request Example: `"acc_123456"` #### Query Parameters [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/get-chart-data#parameter-promoter-campaign-id) promoter\_campaign\_id integer If provided, the given promoter campaign will be used in chart. Otherwise all the current\_promoter campaigns will be used. [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/get-chart-data#parameter-period-from) period\_from string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/get-chart-data#parameter-period-to) period\_to string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/get-chart-data#parameter-selection) selection enum Available options: `revenue`, `commissions`, `clicks`, `referrals`, `customers`, `cancellations` #### Response 401 Unauthorized [Get current promoter sub affiliates](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/get-current-promoter-sub-affiliates) [Get the promoter email](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/get-the-promoter-email) ⌘I --- # Get current promoter - FirstPromoter Docs [Skip to main content](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/get-current-promoter#content-area) [FirstPromoter Docs home page![light logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/light.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=6ded212b82547bec37a22e90f72eeb71)![dark logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/dark.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=c393ff83772047b8a444f78a1e393e7f)](https://docs.firstpromoter.com/) v2 Search... ⌘K Search... Navigation [Documentation](https://docs.firstpromoter.com/introduction) [API Reference](https://docs.firstpromoter.com/api-reference-v2/api-admin/introduction) [Affiliate API Reference](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/introduction) Get current promoter cURL Copy curl --request GET \ --url https://api.firstpromoter.com/api/v2/affiliate/promoters/current \ --header 'Account-ID: ' \ --header 'Authorization: Bearer ' 200 403 Copy { "id": 123, "email": "", "name": "", "stats": { "clicks_count": 123, "referrals_count": 123, "sales_count": 123, "customers_count": 123, "revenue_amount": 123, "active_customers_count": 123 }, "balances": {}, "custom_fields": {}, "first_event_at": "2023-11-07T05:31:56Z", "invoice_details_status": "", "joined_at": "2023-11-07T05:31:56Z", "selected_payout_method": "", "pending_contract_documents": [\ ""\ ], "profile": { "id": 123, "first_name": "", "last_name": "", "website": "", "company_name": "", "phone_number": "", "vat_id": "", "country": "", "address": "", "avatar": "", "instagram_url": "", "youtube_url": "", "linkedin_url": "", "facebook_url": "", "twitter_url": "", "twitch_url": "", "tiktok_url": "" }, "promoter_campaigns": [\ {\ "id": 123,\ "campaign_id": 123,\ "created_at": "2023-11-07T05:31:56Z",\ "campaign": {\ "id": 123,\ "name": "",\ "color": ""\ },\ "state": "",\ "promoter_id": 123,\ "stats": {\ "clicks_count": 123,\ "referrals_count": 123,\ "sales_count": 123,\ "customers_count": 123,\ "revenue_amount": 123\ },\ "ref_token": "",\ "ref_link": "",\ "has_monetary_rewards": true\ }\ ], "is_confirmed": true } GET / promoters / current Try it Get current promoter cURL Copy curl --request GET \ --url https://api.firstpromoter.com/api/v2/affiliate/promoters/current \ --header 'Account-ID: ' \ --header 'Authorization: Bearer ' 200 403 Copy { "id": 123, "email": "", "name": "", "stats": { "clicks_count": 123, "referrals_count": 123, "sales_count": 123, "customers_count": 123, "revenue_amount": 123, "active_customers_count": 123 }, "balances": {}, "custom_fields": {}, "first_event_at": "2023-11-07T05:31:56Z", "invoice_details_status": "", "joined_at": "2023-11-07T05:31:56Z", "selected_payout_method": "", "pending_contract_documents": [\ ""\ ], "profile": { "id": 123, "first_name": "", "last_name": "", "website": "", "company_name": "", "phone_number": "", "vat_id": "", "country": "", "address": "", "avatar": "", "instagram_url": "", "youtube_url": "", "linkedin_url": "", "facebook_url": "", "twitter_url": "", "twitch_url": "", "tiktok_url": "" }, "promoter_campaigns": [\ {\ "id": 123,\ "campaign_id": 123,\ "created_at": "2023-11-07T05:31:56Z",\ "campaign": {\ "id": 123,\ "name": "",\ "color": ""\ },\ "state": "",\ "promoter_id": 123,\ "stats": {\ "clicks_count": 123,\ "referrals_count": 123,\ "sales_count": 123,\ "customers_count": 123,\ "revenue_amount": 123\ },\ "ref_token": "",\ "ref_link": "",\ "has_monetary_rewards": true\ }\ ], "is_confirmed": true } #### Authorizations [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/get-current-promoter#authorization-authorization) Authorization string header required Access token passed as a Bearer token in the Authorization header #### Headers [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/get-current-promoter#parameter-account-id) Account-ID string required Account identifier that specifies which account is making the request Example: `"acc_123456"` #### Response 200 application/json Successful response [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/get-current-promoter#response-id) id integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/get-current-promoter#response-email) email string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/get-current-promoter#response-name) name string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/get-current-promoter#response-stats) stats object Show child attributes [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/get-current-promoter#response-stats-clicks-count) stats.clicks\_count integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/get-current-promoter#response-stats-referrals-count) stats.referrals\_count integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/get-current-promoter#response-stats-sales-count) stats.sales\_count integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/get-current-promoter#response-stats-customers-count) stats.customers\_count integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/get-current-promoter#response-stats-revenue-amount) stats.revenue\_amount number [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/get-current-promoter#response-stats-active-customers-count) stats.active\_customers\_count integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/get-current-promoter#response-balances) balances object [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/get-current-promoter#response-custom-fields) custom\_fields object [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/get-current-promoter#response-first-event-at) first\_event\_at string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/get-current-promoter#response-invoice-details-status) invoice\_details\_status string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/get-current-promoter#response-joined-at) joined\_at string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/get-current-promoter#response-selected-payout-method) selected\_payout\_method string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/get-current-promoter#response-pending-contract-documents) pending\_contract\_documents string\[\] [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/get-current-promoter#response-profile) profile object Show child attributes [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/get-current-promoter#response-profile-id) profile.id integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/get-current-promoter#response-profile-first-name) profile.first\_name string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/get-current-promoter#response-profile-last-name) profile.last\_name string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/get-current-promoter#response-profile-website) profile.website string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/get-current-promoter#response-profile-company-name) profile.company\_name string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/get-current-promoter#response-profile-phone-number) profile.phone\_number string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/get-current-promoter#response-profile-vat-id) profile.vat\_id string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/get-current-promoter#response-profile-country) profile.country string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/get-current-promoter#response-profile-address) profile.address string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/get-current-promoter#response-profile-avatar) profile.avatar string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/get-current-promoter#response-profile-instagram-url) profile.instagram\_url string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/get-current-promoter#response-profile-youtube-url) profile.youtube\_url string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/get-current-promoter#response-profile-linkedin-url) profile.linkedin\_url string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/get-current-promoter#response-profile-facebook-url) profile.facebook\_url string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/get-current-promoter#response-profile-twitter-url) profile.twitter\_url string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/get-current-promoter#response-profile-twitch-url) profile.twitch\_url string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/get-current-promoter#response-profile-tiktok-url) profile.tiktok\_url string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/get-current-promoter#response-promoter-campaigns) promoter\_campaigns object\[\] Show child attributes [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/get-current-promoter#response-promoter-campaigns-items-id) promoter\_campaigns.id integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/get-current-promoter#response-promoter-campaigns-items-campaign-id) promoter\_campaigns.campaign\_id integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/get-current-promoter#response-promoter-campaigns-items-created-at) promoter\_campaigns.created\_at string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/get-current-promoter#response-promoter-campaigns-items-campaign) promoter\_campaigns.campaign object Show child attributes [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/get-current-promoter#response-promoter-campaigns-items-campaign-id) promoter\_campaigns.campaign.id integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/get-current-promoter#response-promoter-campaigns-items-campaign-name) promoter\_campaigns.campaign.name string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/get-current-promoter#response-promoter-campaigns-items-campaign-color) promoter\_campaigns.campaign.color string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/get-current-promoter#response-promoter-campaigns-items-state) promoter\_campaigns.state string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/get-current-promoter#response-promoter-campaigns-items-promoter-id) promoter\_campaigns.promoter\_id integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/get-current-promoter#response-promoter-campaigns-items-stats) promoter\_campaigns.stats object Show child attributes [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/get-current-promoter#response-promoter-campaigns-items-stats-clicks-count) promoter\_campaigns.stats.clicks\_count integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/get-current-promoter#response-promoter-campaigns-items-stats-referrals-count) promoter\_campaigns.stats.referrals\_count integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/get-current-promoter#response-promoter-campaigns-items-stats-sales-count) promoter\_campaigns.stats.sales\_count integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/get-current-promoter#response-promoter-campaigns-items-stats-customers-count) promoter\_campaigns.stats.customers\_count integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/get-current-promoter#response-promoter-campaigns-items-stats-revenue-amount) promoter\_campaigns.stats.revenue\_amount number [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/get-current-promoter#response-promoter-campaigns-items-ref-token) promoter\_campaigns.ref\_token string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/get-current-promoter#response-promoter-campaigns-items-ref-link) promoter\_campaigns.ref\_link string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/get-current-promoter#response-promoter-campaigns-items-has-monetary-rewards) promoter\_campaigns.has\_monetary\_rewards boolean [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/get-current-promoter#response-is-confirmed) is\_confirmed boolean [Update promotion ref token for the promoter campaign](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoter-campaigns/update-promotion-ref_token-for-the-promoter_campaign) [Get current promoter sub affiliates](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/get-current-promoter-sub-affiliates) ⌘I --- # Get current promoter sub affiliates - FirstPromoter Docs [Skip to main content](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/get-current-promoter-sub-affiliates#content-area) [FirstPromoter Docs home page![light logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/light.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=6ded212b82547bec37a22e90f72eeb71)![dark logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/dark.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=c393ff83772047b8a444f78a1e393e7f)](https://docs.firstpromoter.com/) v2 Search... ⌘K Search... Navigation [Documentation](https://docs.firstpromoter.com/introduction) [API Reference](https://docs.firstpromoter.com/api-reference-v2/api-admin/introduction) [Affiliate API Reference](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/introduction) Get current promoter sub affiliates cURL Copy curl --request GET \ --url https://api.firstpromoter.com/api/v2/affiliate/promoters/sub_affiliates \ --header 'Account-ID: ' \ --header 'Authorization: Bearer ' 200 Copy [\ {\ "id": 123,\ "name": "",\ "email": "",\ "stats": {\ "clicks_count": 123,\ "referrals_count": 123,\ "sales_count": 123,\ "customers_count": 123,\ "revenue_amount": 123,\ "active_customers_count": 123\ },\ "joined_at": "2023-11-07T05:31:56Z"\ }\ ] GET / promoters / sub\_affiliates Try it Get current promoter sub affiliates cURL Copy curl --request GET \ --url https://api.firstpromoter.com/api/v2/affiliate/promoters/sub_affiliates \ --header 'Account-ID: ' \ --header 'Authorization: Bearer ' 200 Copy [\ {\ "id": 123,\ "name": "",\ "email": "",\ "stats": {\ "clicks_count": 123,\ "referrals_count": 123,\ "sales_count": 123,\ "customers_count": 123,\ "revenue_amount": 123,\ "active_customers_count": 123\ },\ "joined_at": "2023-11-07T05:31:56Z"\ }\ ] #### Authorizations [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/get-current-promoter-sub-affiliates#authorization-authorization) Authorization string header required Access token passed as a Bearer token in the Authorization header #### Headers [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/get-current-promoter-sub-affiliates#parameter-account-id) Account-ID string required Account identifier that specifies which account is making the request Example: `"acc_123456"` #### Response 200 application/json Successful response [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/get-current-promoter-sub-affiliates#response-items-id) id integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/get-current-promoter-sub-affiliates#response-items-name) name string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/get-current-promoter-sub-affiliates#response-items-email) email string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/get-current-promoter-sub-affiliates#response-items-stats) stats object Show child attributes [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/get-current-promoter-sub-affiliates#response-items-stats-clicks-count) stats.clicks\_count integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/get-current-promoter-sub-affiliates#response-items-stats-referrals-count) stats.referrals\_count integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/get-current-promoter-sub-affiliates#response-items-stats-sales-count) stats.sales\_count integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/get-current-promoter-sub-affiliates#response-items-stats-customers-count) stats.customers\_count integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/get-current-promoter-sub-affiliates#response-items-stats-revenue-amount) stats.revenue\_amount number [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/get-current-promoter-sub-affiliates#response-items-stats-active-customers-count) stats.active\_customers\_count integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/get-current-promoter-sub-affiliates#response-items-joined-at) joined\_at string [Get current promoter](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/get-current-promoter) [Get chart data](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/get-chart-data) ⌘I --- # Get the promoter email - FirstPromoter Docs [Skip to main content](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/get-the-promoter-email#content-area) [FirstPromoter Docs home page![light logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/light.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=6ded212b82547bec37a22e90f72eeb71)![dark logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/dark.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=c393ff83772047b8a444f78a1e393e7f)](https://docs.firstpromoter.com/) v2 Search... ⌘K Search... Navigation [Documentation](https://docs.firstpromoter.com/introduction) [API Reference](https://docs.firstpromoter.com/api-reference-v2/api-admin/introduction) [Affiliate API Reference](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/introduction) Get the promoter email cURL Copy curl --request GET \ --url https://api.firstpromoter.com/api/v2/affiliate/promoters/email_from_encrypted_id \ --header 'Account-ID: ' \ --header 'Authorization: Bearer ' 200 Copy { "email": "" } GET / promoters / email\_from\_encrypted\_id Try it Get the promoter email cURL Copy curl --request GET \ --url https://api.firstpromoter.com/api/v2/affiliate/promoters/email_from_encrypted_id \ --header 'Account-ID: ' \ --header 'Authorization: Bearer ' 200 Copy { "email": "" } #### Authorizations [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/get-the-promoter-email#authorization-authorization) Authorization string header required Access token passed as a Bearer token in the Authorization header #### Headers [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/get-the-promoter-email#parameter-account-id) Account-ID string required Account identifier that specifies which account is making the request Example: `"acc_123456"` #### Query Parameters [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/get-the-promoter-email#parameter-id) id string required The encrypted id #### Response 200 application/json Successful response [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/get-the-promoter-email#response-email) email string [Get chart data](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/get-chart-data) [Set the user password](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/set-the-user-password) ⌘I --- # Destroys a referral link - FirstPromoter Docs [Skip to main content](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referral-links/destroys-a-referral-link#content-area) [FirstPromoter Docs home page![light logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/light.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=6ded212b82547bec37a22e90f72eeb71)![dark logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/dark.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=c393ff83772047b8a444f78a1e393e7f)](https://docs.firstpromoter.com/) v2 Search... ⌘K Search... Navigation [Documentation](https://docs.firstpromoter.com/introduction) [API Reference](https://docs.firstpromoter.com/api-reference-v2/api-admin/introduction) [Affiliate API Reference](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/introduction) Destroys a referral link cURL Copy curl --request DELETE \ --url https://api.firstpromoter.com/api/v2/affiliate/referral_links/{id} \ --header 'Account-ID: ' \ --header 'Authorization: Bearer ' 403 Copy { "message": "", "code": "" } DELETE / referral\_links / {id} Try it Destroys a referral link cURL Copy curl --request DELETE \ --url https://api.firstpromoter.com/api/v2/affiliate/referral_links/{id} \ --header 'Account-ID: ' \ --header 'Authorization: Bearer ' 403 Copy { "message": "", "code": "" } #### Authorizations [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referral-links/destroys-a-referral-link#authorization-authorization) Authorization string header required Access token passed as a Bearer token in the Authorization header #### Headers [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referral-links/destroys-a-referral-link#parameter-account-id) Account-ID string required Account identifier that specifies which account is making the request Example: `"acc_123456"` #### Path Parameters [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referral-links/destroys-a-referral-link#parameter-id) id integer required The id of the referral\_link to be destroyed #### Response 200 Referral link deleted successfully [Updates a referral link for current promoter](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referral-links/updates-a-referral-link-for-current-promoter) [Get available referrals for current promoter](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referrals/get-available-referrals-for-current-promoter) ⌘I --- # Set the user password - FirstPromoter Docs [Skip to main content](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/set-the-user-password#content-area) [FirstPromoter Docs home page![light logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/light.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=6ded212b82547bec37a22e90f72eeb71)![dark logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/dark.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=c393ff83772047b8a444f78a1e393e7f)](https://docs.firstpromoter.com/) v2 Search... ⌘K Search... Navigation [Documentation](https://docs.firstpromoter.com/introduction) [API Reference](https://docs.firstpromoter.com/api-reference-v2/api-admin/introduction) [Affiliate API Reference](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/introduction) Set the user password cURL Copy curl --request PUT \ --url https://api.firstpromoter.com/api/v2/affiliate/promoters/set_password \ --header 'Account-ID: ' \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data ' { "id": "", "user": { "new_password": "", "new_password_confirmation": "" } } ' 200 Copy { "id": 123, "email": "", "name": "", "stats": { "clicks_count": 123, "referrals_count": 123, "sales_count": 123, "customers_count": 123, "revenue_amount": 123, "active_customers_count": 123 }, "balances": {}, "custom_fields": {}, "first_event_at": "2023-11-07T05:31:56Z", "invoice_details_status": "", "joined_at": "2023-11-07T05:31:56Z", "selected_payout_method": "", "pending_contract_documents": [\ ""\ ], "profile": { "id": 123, "first_name": "", "last_name": "", "website": "", "company_name": "", "phone_number": "", "vat_id": "", "country": "", "address": "", "avatar": "", "instagram_url": "", "youtube_url": "", "linkedin_url": "", "facebook_url": "", "twitter_url": "", "twitch_url": "", "tiktok_url": "" }, "promoter_campaigns": [\ {\ "id": 123,\ "campaign_id": 123,\ "created_at": "2023-11-07T05:31:56Z",\ "campaign": {\ "id": 123,\ "name": "",\ "color": ""\ },\ "state": "",\ "promoter_id": 123,\ "stats": {\ "clicks_count": 123,\ "referrals_count": 123,\ "sales_count": 123,\ "customers_count": 123,\ "revenue_amount": 123\ },\ "ref_token": "",\ "ref_link": "",\ "has_monetary_rewards": true\ }\ ], "is_confirmed": true } PUT / promoters / set\_password Try it Set the user password cURL Copy curl --request PUT \ --url https://api.firstpromoter.com/api/v2/affiliate/promoters/set_password \ --header 'Account-ID: ' \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data ' { "id": "", "user": { "new_password": "", "new_password_confirmation": "" } } ' 200 Copy { "id": 123, "email": "", "name": "", "stats": { "clicks_count": 123, "referrals_count": 123, "sales_count": 123, "customers_count": 123, "revenue_amount": 123, "active_customers_count": 123 }, "balances": {}, "custom_fields": {}, "first_event_at": "2023-11-07T05:31:56Z", "invoice_details_status": "", "joined_at": "2023-11-07T05:31:56Z", "selected_payout_method": "", "pending_contract_documents": [\ ""\ ], "profile": { "id": 123, "first_name": "", "last_name": "", "website": "", "company_name": "", "phone_number": "", "vat_id": "", "country": "", "address": "", "avatar": "", "instagram_url": "", "youtube_url": "", "linkedin_url": "", "facebook_url": "", "twitter_url": "", "twitch_url": "", "tiktok_url": "" }, "promoter_campaigns": [\ {\ "id": 123,\ "campaign_id": 123,\ "created_at": "2023-11-07T05:31:56Z",\ "campaign": {\ "id": 123,\ "name": "",\ "color": ""\ },\ "state": "",\ "promoter_id": 123,\ "stats": {\ "clicks_count": 123,\ "referrals_count": 123,\ "sales_count": 123,\ "customers_count": 123,\ "revenue_amount": 123\ },\ "ref_token": "",\ "ref_link": "",\ "has_monetary_rewards": true\ }\ ], "is_confirmed": true } #### Authorizations [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/set-the-user-password#authorization-authorization) Authorization string header required Access token passed as a Bearer token in the Authorization header #### Headers [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/set-the-user-password#parameter-account-id) Account-ID string required Account identifier that specifies which account is making the request Example: `"acc_123456"` #### Body application/json [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/set-the-user-password#body-id) id string required The encrypted id [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/set-the-user-password#body-user) user object required Show child attributes [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/set-the-user-password#body-user-new-password) user.new\_password string required [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/set-the-user-password#body-user-new-password-confirmation) user.new\_password\_confirmation string required #### Response 200 application/json Successful response [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/set-the-user-password#response-id) id integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/set-the-user-password#response-email) email string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/set-the-user-password#response-name) name string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/set-the-user-password#response-stats) stats object Show child attributes [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/set-the-user-password#response-stats-clicks-count) stats.clicks\_count integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/set-the-user-password#response-stats-referrals-count) stats.referrals\_count integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/set-the-user-password#response-stats-sales-count) stats.sales\_count integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/set-the-user-password#response-stats-customers-count) stats.customers\_count integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/set-the-user-password#response-stats-revenue-amount) stats.revenue\_amount number [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/set-the-user-password#response-stats-active-customers-count) stats.active\_customers\_count integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/set-the-user-password#response-balances) balances object [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/set-the-user-password#response-custom-fields) custom\_fields object [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/set-the-user-password#response-first-event-at) first\_event\_at string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/set-the-user-password#response-invoice-details-status) invoice\_details\_status string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/set-the-user-password#response-joined-at) joined\_at string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/set-the-user-password#response-selected-payout-method) selected\_payout\_method string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/set-the-user-password#response-pending-contract-documents) pending\_contract\_documents string\[\] [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/set-the-user-password#response-profile) profile object Show child attributes [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/set-the-user-password#response-profile-id) profile.id integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/set-the-user-password#response-profile-first-name) profile.first\_name string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/set-the-user-password#response-profile-last-name) profile.last\_name string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/set-the-user-password#response-profile-website) profile.website string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/set-the-user-password#response-profile-company-name) profile.company\_name string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/set-the-user-password#response-profile-phone-number) profile.phone\_number string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/set-the-user-password#response-profile-vat-id) profile.vat\_id string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/set-the-user-password#response-profile-country) profile.country string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/set-the-user-password#response-profile-address) profile.address string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/set-the-user-password#response-profile-avatar) profile.avatar string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/set-the-user-password#response-profile-instagram-url) profile.instagram\_url string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/set-the-user-password#response-profile-youtube-url) profile.youtube\_url string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/set-the-user-password#response-profile-linkedin-url) profile.linkedin\_url string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/set-the-user-password#response-profile-facebook-url) profile.facebook\_url string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/set-the-user-password#response-profile-twitter-url) profile.twitter\_url string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/set-the-user-password#response-profile-twitch-url) profile.twitch\_url string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/set-the-user-password#response-profile-tiktok-url) profile.tiktok\_url string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/set-the-user-password#response-promoter-campaigns) promoter\_campaigns object\[\] Show child attributes [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/set-the-user-password#response-promoter-campaigns-items-id) promoter\_campaigns.id integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/set-the-user-password#response-promoter-campaigns-items-campaign-id) promoter\_campaigns.campaign\_id integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/set-the-user-password#response-promoter-campaigns-items-created-at) promoter\_campaigns.created\_at string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/set-the-user-password#response-promoter-campaigns-items-campaign) promoter\_campaigns.campaign object Show child attributes [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/set-the-user-password#response-promoter-campaigns-items-campaign-id) promoter\_campaigns.campaign.id integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/set-the-user-password#response-promoter-campaigns-items-campaign-name) promoter\_campaigns.campaign.name string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/set-the-user-password#response-promoter-campaigns-items-campaign-color) promoter\_campaigns.campaign.color string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/set-the-user-password#response-promoter-campaigns-items-state) promoter\_campaigns.state string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/set-the-user-password#response-promoter-campaigns-items-promoter-id) promoter\_campaigns.promoter\_id integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/set-the-user-password#response-promoter-campaigns-items-stats) promoter\_campaigns.stats object Show child attributes [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/set-the-user-password#response-promoter-campaigns-items-stats-clicks-count) promoter\_campaigns.stats.clicks\_count integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/set-the-user-password#response-promoter-campaigns-items-stats-referrals-count) promoter\_campaigns.stats.referrals\_count integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/set-the-user-password#response-promoter-campaigns-items-stats-sales-count) promoter\_campaigns.stats.sales\_count integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/set-the-user-password#response-promoter-campaigns-items-stats-customers-count) promoter\_campaigns.stats.customers\_count integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/set-the-user-password#response-promoter-campaigns-items-stats-revenue-amount) promoter\_campaigns.stats.revenue\_amount number [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/set-the-user-password#response-promoter-campaigns-items-ref-token) promoter\_campaigns.ref\_token string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/set-the-user-password#response-promoter-campaigns-items-ref-link) promoter\_campaigns.ref\_link string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/set-the-user-password#response-promoter-campaigns-items-has-monetary-rewards) promoter\_campaigns.has\_monetary\_rewards boolean [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/set-the-user-password#response-is-confirmed) is\_confirmed boolean [Get the promoter email](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/get-the-promoter-email) [Archives current promoter](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/archives-current-promoter) ⌘I --- # Creates a referral link for current promoter - FirstPromoter Docs [Skip to main content](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referral-links/creates-a-referral-link-for-current-promoter#content-area) [FirstPromoter Docs home page![light logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/light.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=6ded212b82547bec37a22e90f72eeb71)![dark logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/dark.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=c393ff83772047b8a444f78a1e393e7f)](https://docs.firstpromoter.com/) v2 Search... ⌘K Search... Navigation [Documentation](https://docs.firstpromoter.com/introduction) [API Reference](https://docs.firstpromoter.com/api-reference-v2/api-admin/introduction) [Affiliate API Reference](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/introduction) Creates a referral link cURL Copy curl --request POST \ --url https://api.firstpromoter.com/api/v2/affiliate/referral_links \ --header 'Account-ID: ' \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data ' { "promoter_campaign_id": 123, "sub_id": "", "name": "", "url": "" } ' 200 403 422 Copy { "id": 123, "name": "", "url": "", "is_default": true, "source": "campaign", "sub_id": "", "campaign": { "id": 123, "name": "", "color": "" } } POST / referral\_links Try it Creates a referral link cURL Copy curl --request POST \ --url https://api.firstpromoter.com/api/v2/affiliate/referral_links \ --header 'Account-ID: ' \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data ' { "promoter_campaign_id": 123, "sub_id": "", "name": "", "url": "" } ' 200 403 422 Copy { "id": 123, "name": "", "url": "", "is_default": true, "source": "campaign", "sub_id": "", "campaign": { "id": 123, "name": "", "color": "" } } #### Authorizations [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referral-links/creates-a-referral-link-for-current-promoter#authorization-authorization) Authorization string header required Access token passed as a Bearer token in the Authorization header #### Headers [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referral-links/creates-a-referral-link-for-current-promoter#parameter-account-id) Account-ID string required Account identifier that specifies which account is making the request Example: `"acc_123456"` #### Body application/json [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referral-links/creates-a-referral-link-for-current-promoter#body-promoter-campaign-id) promoter\_campaign\_id integer required Promoter campaign of the link [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referral-links/creates-a-referral-link-for-current-promoter#body-sub-id) sub\_id string Sub id [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referral-links/creates-a-referral-link-for-current-promoter#body-name) name string Name [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referral-links/creates-a-referral-link-for-current-promoter#body-url) url string Url #### Response 200 application/json Created referral link [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referral-links/creates-a-referral-link-for-current-promoter#response-id-one-of-0) id integer | null [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referral-links/creates-a-referral-link-for-current-promoter#response-name) name string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referral-links/creates-a-referral-link-for-current-promoter#response-url) url string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referral-links/creates-a-referral-link-for-current-promoter#response-is-default-one-of-0) is\_default boolean | null [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referral-links/creates-a-referral-link-for-current-promoter#response-source) source enum Available options: `campaign`, `promoter` [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referral-links/creates-a-referral-link-for-current-promoter#response-sub-id-one-of-0) sub\_id string | null [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referral-links/creates-a-referral-link-for-current-promoter#response-campaign) campaign object Show child attributes [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referral-links/creates-a-referral-link-for-current-promoter#response-campaign-id) campaign.id integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referral-links/creates-a-referral-link-for-current-promoter#response-campaign-name) campaign.name string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referral-links/creates-a-referral-link-for-current-promoter#response-campaign-color-one-of-0) campaign.color string | null [Get current promoter referral links](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referral-links/get-current-promoter-referral-links) [Updates a referral link for current promoter](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referral-links/updates-a-referral-link-for-current-promoter) ⌘I --- # Get current promoter referral links - FirstPromoter Docs [Skip to main content](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referral-links/get-current-promoter-referral-links#content-area) [FirstPromoter Docs home page![light logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/light.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=6ded212b82547bec37a22e90f72eeb71)![dark logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/dark.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=c393ff83772047b8a444f78a1e393e7f)](https://docs.firstpromoter.com/) v2 Search... ⌘K Search... Navigation [Documentation](https://docs.firstpromoter.com/introduction) [API Reference](https://docs.firstpromoter.com/api-reference-v2/api-admin/introduction) [Affiliate API Reference](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/introduction) Get current promoter referral links cURL Copy curl --request GET \ --url https://api.firstpromoter.com/api/v2/affiliate/referral_links \ --header 'Account-ID: ' \ --header 'Authorization: Bearer ' 200 403 Copy [\ {\ "id": 123,\ "name": "",\ "url": "",\ "is_default": true,\ "source": "campaign",\ "sub_id": "",\ "campaign": {\ "id": 123,\ "name": "",\ "color": ""\ }\ }\ ] GET / referral\_links Try it Get current promoter referral links cURL Copy curl --request GET \ --url https://api.firstpromoter.com/api/v2/affiliate/referral_links \ --header 'Account-ID: ' \ --header 'Authorization: Bearer ' 200 403 Copy [\ {\ "id": 123,\ "name": "",\ "url": "",\ "is_default": true,\ "source": "campaign",\ "sub_id": "",\ "campaign": {\ "id": 123,\ "name": "",\ "color": ""\ }\ }\ ] #### Authorizations [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referral-links/get-current-promoter-referral-links#authorization-authorization) Authorization string header required Access token passed as a Bearer token in the Authorization header #### Headers [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referral-links/get-current-promoter-referral-links#parameter-account-id) Account-ID string required Account identifier that specifies which account is making the request Example: `"acc_123456"` #### Query Parameters [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referral-links/get-current-promoter-referral-links#parameter-promoter-campaign-id) promoter\_campaign\_id integer If provided, it returns only the links related to the given campaign #### Response 200 application/json List of referral links [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referral-links/get-current-promoter-referral-links#response-items-id-one-of-0) id integer | null [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referral-links/get-current-promoter-referral-links#response-items-name) name string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referral-links/get-current-promoter-referral-links#response-items-url) url string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referral-links/get-current-promoter-referral-links#response-items-is-default-one-of-0) is\_default boolean | null [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referral-links/get-current-promoter-referral-links#response-items-source) source enum Available options: `campaign`, `promoter` [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referral-links/get-current-promoter-referral-links#response-items-sub-id-one-of-0) sub\_id string | null [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referral-links/get-current-promoter-referral-links#response-items-campaign) campaign object Show child attributes [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referral-links/get-current-promoter-referral-links#response-items-campaign-id) campaign.id integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referral-links/get-current-promoter-referral-links#response-items-campaign-name) campaign.name string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referral-links/get-current-promoter-referral-links#response-items-campaign-color-one-of-0) campaign.color string | null [Archives current promoter](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/promoters/archives-current-promoter) [Creates a referral link for current promoter](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referral-links/creates-a-referral-link-for-current-promoter) ⌘I --- # Updates a referral link for current promoter - FirstPromoter Docs [Skip to main content](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referral-links/updates-a-referral-link-for-current-promoter#content-area) [FirstPromoter Docs home page![light logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/light.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=6ded212b82547bec37a22e90f72eeb71)![dark logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/dark.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=c393ff83772047b8a444f78a1e393e7f)](https://docs.firstpromoter.com/) v2 Search... ⌘K Search... Navigation [Documentation](https://docs.firstpromoter.com/introduction) [API Reference](https://docs.firstpromoter.com/api-reference-v2/api-admin/introduction) [Affiliate API Reference](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/introduction) Updates a referral link cURL Copy curl --request PUT \ --url https://api.firstpromoter.com/api/v2/affiliate/referral_links/{id} \ --header 'Account-ID: ' \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data ' { "sub_id": "", "name": "" } ' 200 403 Copy { "id": 123, "name": "", "url": "", "is_default": true, "source": "campaign", "sub_id": "", "campaign": { "id": 123, "name": "", "color": "" } } PUT / referral\_links / {id} Try it Updates a referral link cURL Copy curl --request PUT \ --url https://api.firstpromoter.com/api/v2/affiliate/referral_links/{id} \ --header 'Account-ID: ' \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data ' { "sub_id": "", "name": "" } ' 200 403 Copy { "id": 123, "name": "", "url": "", "is_default": true, "source": "campaign", "sub_id": "", "campaign": { "id": 123, "name": "", "color": "" } } #### Authorizations [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referral-links/updates-a-referral-link-for-current-promoter#authorization-authorization) Authorization string header required Access token passed as a Bearer token in the Authorization header #### Headers [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referral-links/updates-a-referral-link-for-current-promoter#parameter-account-id) Account-ID string required Account identifier that specifies which account is making the request Example: `"acc_123456"` #### Path Parameters [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referral-links/updates-a-referral-link-for-current-promoter#parameter-id) id integer required ID of the referral link to update #### Body application/json [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referral-links/updates-a-referral-link-for-current-promoter#body-sub-id) sub\_id string Sub id [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referral-links/updates-a-referral-link-for-current-promoter#body-name) name string Name #### Response 200 application/json Updated referral link [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referral-links/updates-a-referral-link-for-current-promoter#response-id-one-of-0) id integer | null [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referral-links/updates-a-referral-link-for-current-promoter#response-name) name string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referral-links/updates-a-referral-link-for-current-promoter#response-url) url string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referral-links/updates-a-referral-link-for-current-promoter#response-is-default-one-of-0) is\_default boolean | null [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referral-links/updates-a-referral-link-for-current-promoter#response-source) source enum Available options: `campaign`, `promoter` [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referral-links/updates-a-referral-link-for-current-promoter#response-sub-id-one-of-0) sub\_id string | null [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referral-links/updates-a-referral-link-for-current-promoter#response-campaign) campaign object Show child attributes [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referral-links/updates-a-referral-link-for-current-promoter#response-campaign-id) campaign.id integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referral-links/updates-a-referral-link-for-current-promoter#response-campaign-name) campaign.name string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referral-links/updates-a-referral-link-for-current-promoter#response-campaign-color-one-of-0) campaign.color string | null [Creates a referral link for current promoter](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referral-links/creates-a-referral-link-for-current-promoter) [Destroys a referral link](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referral-links/destroys-a-referral-link) ⌘I --- # Create referral for current promoter - FirstPromoter Docs [Skip to main content](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referrals/create-referral-for-current-promoter#content-area) [FirstPromoter Docs home page![light logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/light.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=6ded212b82547bec37a22e90f72eeb71)![dark logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/dark.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=c393ff83772047b8a444f78a1e393e7f)](https://docs.firstpromoter.com/) v2 Search... ⌘K Search... Navigation [Documentation](https://docs.firstpromoter.com/introduction) [API Reference](https://docs.firstpromoter.com/api-reference-v2/api-admin/introduction) [Affiliate API Reference](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/introduction) Create referral cURL Copy curl --request POST \ --url https://api.firstpromoter.com/api/v2/affiliate/referrals \ --header 'Account-ID: ' \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data ' { "email": "[email protected]", "promoter_campaign_id": 123, "uid": "" } ' 200 403 422 Copy { "id": 123, "uid": "", "state": "subscribed", "metadata": {}, "created_at": "2023-11-07T05:31:56Z", "customer_since": "2023-11-07T05:31:56Z", "email": "[email protected]", "promoter_campaign": { "id": 123, "campaign_id": 123, "created_at": "2023-11-07T05:31:56Z", "campaign": { "id": 123, "name": "", "color": "" } } } POST / referrals Try it Create referral cURL Copy curl --request POST \ --url https://api.firstpromoter.com/api/v2/affiliate/referrals \ --header 'Account-ID: ' \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data ' { "email": "[email protected]", "promoter_campaign_id": 123, "uid": "" } ' 200 403 422 Copy { "id": 123, "uid": "", "state": "subscribed", "metadata": {}, "created_at": "2023-11-07T05:31:56Z", "customer_since": "2023-11-07T05:31:56Z", "email": "[email protected]", "promoter_campaign": { "id": 123, "campaign_id": 123, "created_at": "2023-11-07T05:31:56Z", "campaign": { "id": 123, "name": "", "color": "" } } } #### Authorizations [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referrals/create-referral-for-current-promoter#authorization-authorization) Authorization string header required Access token passed as a Bearer token in the Authorization header #### Headers [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referrals/create-referral-for-current-promoter#parameter-account-id) Account-ID string required Account identifier that specifies which account is making the request Example: `"acc_123456"` #### Body application/json [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referrals/create-referral-for-current-promoter#body-email) email string required Email of the referral [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referrals/create-referral-for-current-promoter#body-promoter-campaign-id) promoter\_campaign\_id integer required The ID of the promoter campaign [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referrals/create-referral-for-current-promoter#body-uid) uid string Unique ID of the referral #### Response 200 application/json Successful response [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referrals/create-referral-for-current-promoter#response-id) id integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referrals/create-referral-for-current-promoter#response-uid) uid string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referrals/create-referral-for-current-promoter#response-state) state enum Available options: `subscribed`, `signup`, `active`, `cancelled`, `refunded`, `denied`, `pending`, `moved` [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referrals/create-referral-for-current-promoter#response-metadata) metadata object [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referrals/create-referral-for-current-promoter#response-created-at) created\_at string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referrals/create-referral-for-current-promoter#response-customer-since) customer\_since string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referrals/create-referral-for-current-promoter#response-email) email string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referrals/create-referral-for-current-promoter#response-promoter-campaign) promoter\_campaign object Show child attributes [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referrals/create-referral-for-current-promoter#response-promoter-campaign-id) promoter\_campaign.id integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referrals/create-referral-for-current-promoter#response-promoter-campaign-campaign-id) promoter\_campaign.campaign\_id integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referrals/create-referral-for-current-promoter#response-promoter-campaign-created-at) promoter\_campaign.created\_at string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referrals/create-referral-for-current-promoter#response-promoter-campaign-campaign) promoter\_campaign.campaign object Show child attributes [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referrals/create-referral-for-current-promoter#response-promoter-campaign-campaign-id) promoter\_campaign.campaign.id integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referrals/create-referral-for-current-promoter#response-promoter-campaign-campaign-name) promoter\_campaign.campaign.name string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referrals/create-referral-for-current-promoter#response-promoter-campaign-campaign-color) promoter\_campaign.campaign.color string [Get available referrals for current promoter](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referrals/get-available-referrals-for-current-promoter) [Update referral](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referrals/update-referral) ⌘I --- # Delete referral - FirstPromoter Docs [Skip to main content](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referrals/delete-referral#content-area) [FirstPromoter Docs home page![light logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/light.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=6ded212b82547bec37a22e90f72eeb71)![dark logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/dark.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=c393ff83772047b8a444f78a1e393e7f)](https://docs.firstpromoter.com/) v2 Search... ⌘K Search... Navigation [Documentation](https://docs.firstpromoter.com/introduction) [API Reference](https://docs.firstpromoter.com/api-reference-v2/api-admin/introduction) [Affiliate API Reference](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/introduction) Delete referral cURL Copy curl --request DELETE \ --url https://api.firstpromoter.com/api/v2/affiliate/referrals/{id} \ --header 'Account-ID: ' \ --header 'Authorization: Bearer ' 403 Copy { "message": "", "code": "", "errors": {} } DELETE / referrals / {id} Try it Delete referral cURL Copy curl --request DELETE \ --url https://api.firstpromoter.com/api/v2/affiliate/referrals/{id} \ --header 'Account-ID: ' \ --header 'Authorization: Bearer ' 403 Copy { "message": "", "code": "", "errors": {} } #### Authorizations [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referrals/delete-referral#authorization-authorization) Authorization string header required Access token passed as a Bearer token in the Authorization header #### Headers [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referrals/delete-referral#parameter-account-id) Account-ID string required Account identifier that specifies which account is making the request Example: `"acc_123456"` #### Path Parameters [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referrals/delete-referral#parameter-id) id integer required #### Response 204 Successfully deleted [Update referral](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referrals/update-referral) [Export referrals](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referrals/export-referrals) ⌘I --- # Export referrals - FirstPromoter Docs [Skip to main content](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referrals/export-referrals#content-area) [FirstPromoter Docs home page![light logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/light.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=6ded212b82547bec37a22e90f72eeb71)![dark logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/dark.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=c393ff83772047b8a444f78a1e393e7f)](https://docs.firstpromoter.com/) v2 Search... ⌘K Search... Navigation [Documentation](https://docs.firstpromoter.com/introduction) [API Reference](https://docs.firstpromoter.com/api-reference-v2/api-admin/introduction) [Affiliate API Reference](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/introduction) Export referrals cURL Copy curl --request GET \ --url https://api.firstpromoter.com/api/v2/affiliate/referrals/export \ --header 'Account-ID: ' \ --header 'Authorization: Bearer ' 200 202 403 Copy "" GET / referrals / export Try it Export referrals cURL Copy curl --request GET \ --url https://api.firstpromoter.com/api/v2/affiliate/referrals/export \ --header 'Account-ID: ' \ --header 'Authorization: Bearer ' 200 202 403 Copy "" #### Authorizations [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referrals/export-referrals#authorization-authorization) Authorization string header required Access token passed as a Bearer token in the Authorization header #### Headers [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referrals/export-referrals#parameter-account-id) Account-ID string required Account identifier that specifies which account is making the request Example: `"acc_123456"` #### Query Parameters [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referrals/export-referrals#parameter-filters-type) filters\[type\] enum Type (lead or customer) Available options: `lead`, `customer` [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referrals/export-referrals#parameter-filters-state) filters\[state\] enum State Available options: `subscribed`, `signup`, `active`, `cancelled`, `refunded`, `denied`, `pending`, `moved` #### Response 200 text/csv Successful response The response is of type `string`. [Delete referral](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referrals/delete-referral) [Get campaigns reports for current promoter](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/reports/get-campaigns-reports-for-current-promoter) ⌘I --- # Update referral - FirstPromoter Docs [Skip to main content](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referrals/update-referral#content-area) [FirstPromoter Docs home page![light logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/light.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=6ded212b82547bec37a22e90f72eeb71)![dark logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/dark.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=c393ff83772047b8a444f78a1e393e7f)](https://docs.firstpromoter.com/) v2 Search... ⌘K Search... Navigation [Documentation](https://docs.firstpromoter.com/introduction) [API Reference](https://docs.firstpromoter.com/api-reference-v2/api-admin/introduction) [Affiliate API Reference](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/introduction) Update referral cURL Copy curl --request PUT \ --url https://api.firstpromoter.com/api/v2/affiliate/referrals/{id} \ --header 'Account-ID: ' \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data ' { "email": "[email protected]", "uid": "" } ' 200 403 Copy { "id": 123, "uid": "", "state": "subscribed", "metadata": {}, "created_at": "2023-11-07T05:31:56Z", "customer_since": "2023-11-07T05:31:56Z", "email": "[email protected]", "promoter_campaign": { "id": 123, "campaign_id": 123, "created_at": "2023-11-07T05:31:56Z", "campaign": { "id": 123, "name": "", "color": "" } } } PUT / referrals / {id} Try it Update referral cURL Copy curl --request PUT \ --url https://api.firstpromoter.com/api/v2/affiliate/referrals/{id} \ --header 'Account-ID: ' \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data ' { "email": "[email protected]", "uid": "" } ' 200 403 Copy { "id": 123, "uid": "", "state": "subscribed", "metadata": {}, "created_at": "2023-11-07T05:31:56Z", "customer_since": "2023-11-07T05:31:56Z", "email": "[email protected]", "promoter_campaign": { "id": 123, "campaign_id": 123, "created_at": "2023-11-07T05:31:56Z", "campaign": { "id": 123, "name": "", "color": "" } } } #### Authorizations [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referrals/update-referral#authorization-authorization) Authorization string header required Access token passed as a Bearer token in the Authorization header #### Headers [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referrals/update-referral#parameter-account-id) Account-ID string required Account identifier that specifies which account is making the request Example: `"acc_123456"` #### Path Parameters [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referrals/update-referral#parameter-id) id integer required #### Body application/json [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referrals/update-referral#body-email) email string Email of the referral [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referrals/update-referral#body-uid) uid string Unique ID of the referral #### Response 200 application/json Successful response [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referrals/update-referral#response-id) id integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referrals/update-referral#response-uid) uid string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referrals/update-referral#response-state) state enum Available options: `subscribed`, `signup`, `active`, `cancelled`, `refunded`, `denied`, `pending`, `moved` [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referrals/update-referral#response-metadata) metadata object [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referrals/update-referral#response-created-at) created\_at string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referrals/update-referral#response-customer-since) customer\_since string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referrals/update-referral#response-email) email string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referrals/update-referral#response-promoter-campaign) promoter\_campaign object Show child attributes [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referrals/update-referral#response-promoter-campaign-id) promoter\_campaign.id integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referrals/update-referral#response-promoter-campaign-campaign-id) promoter\_campaign.campaign\_id integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referrals/update-referral#response-promoter-campaign-created-at) promoter\_campaign.created\_at string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referrals/update-referral#response-promoter-campaign-campaign) promoter\_campaign.campaign object Show child attributes [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referrals/update-referral#response-promoter-campaign-campaign-id) promoter\_campaign.campaign.id integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referrals/update-referral#response-promoter-campaign-campaign-name) promoter\_campaign.campaign.name string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referrals/update-referral#response-promoter-campaign-campaign-color) promoter\_campaign.campaign.color string [Create referral for current promoter](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referrals/create-referral-for-current-promoter) [Delete referral](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referrals/delete-referral) ⌘I --- # Get available referrals for current promoter - FirstPromoter Docs [Skip to main content](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referrals/get-available-referrals-for-current-promoter#content-area) [FirstPromoter Docs home page![light logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/light.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=6ded212b82547bec37a22e90f72eeb71)![dark logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/dark.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=c393ff83772047b8a444f78a1e393e7f)](https://docs.firstpromoter.com/) v2 Search... ⌘K Search... Navigation [Documentation](https://docs.firstpromoter.com/introduction) [API Reference](https://docs.firstpromoter.com/api-reference-v2/api-admin/introduction) [Affiliate API Reference](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/introduction) Get available referrals cURL Copy curl --request GET \ --url https://api.firstpromoter.com/api/v2/affiliate/referrals \ --header 'Account-ID: ' \ --header 'Authorization: Bearer ' 200 403 Copy [\ {\ "id": 123,\ "uid": "",\ "state": "subscribed",\ "metadata": {},\ "created_at": "2023-11-07T05:31:56Z",\ "customer_since": "2023-11-07T05:31:56Z",\ "email": "[email protected]",\ "promoter_campaign": {\ "id": 123,\ "campaign_id": 123,\ "created_at": "2023-11-07T05:31:56Z",\ "campaign": {\ "id": 123,\ "name": "",\ "color": ""\ }\ }\ }\ ] GET / referrals Try it Get available referrals cURL Copy curl --request GET \ --url https://api.firstpromoter.com/api/v2/affiliate/referrals \ --header 'Account-ID: ' \ --header 'Authorization: Bearer ' 200 403 Copy [\ {\ "id": 123,\ "uid": "",\ "state": "subscribed",\ "metadata": {},\ "created_at": "2023-11-07T05:31:56Z",\ "customer_since": "2023-11-07T05:31:56Z",\ "email": "[email protected]",\ "promoter_campaign": {\ "id": 123,\ "campaign_id": 123,\ "created_at": "2023-11-07T05:31:56Z",\ "campaign": {\ "id": 123,\ "name": "",\ "color": ""\ }\ }\ }\ ] #### Authorizations [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referrals/get-available-referrals-for-current-promoter#authorization-authorization) Authorization string header required Access token passed as a Bearer token in the Authorization header #### Headers [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referrals/get-available-referrals-for-current-promoter#parameter-account-id) Account-ID string required Account identifier that specifies which account is making the request Example: `"acc_123456"` #### Query Parameters [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referrals/get-available-referrals-for-current-promoter#parameter-q) q string Search params. Searches by email, uid, username, website [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referrals/get-available-referrals-for-current-promoter#parameter-filters-type) filters\[type\] enum Type (lead or customer) Available options: `lead`, `customer` [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referrals/get-available-referrals-for-current-promoter#parameter-filters-state) filters\[state\] enum State Available options: `subscribed`, `signup`, `active`, `cancelled`, `refunded`, `denied`, `pending`, `moved` [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referrals/get-available-referrals-for-current-promoter#parameter-filters-created-at-from) filters\[created\_at\]\[from\] string created\_at start date [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referrals/get-available-referrals-for-current-promoter#parameter-filters-created-at-to) filters\[created\_at\]\[to\] string created\_at end date [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referrals/get-available-referrals-for-current-promoter#parameter-filters-customer-since-from) filters\[customer\_since\]\[from\] string customer\_since start date [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referrals/get-available-referrals-for-current-promoter#parameter-filters-customer-since-to) filters\[customer\_since\]\[to\] string customer\_since end date [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referrals/get-available-referrals-for-current-promoter#parameter-one-of-0) filters\[campaign\_id\] integerinteger\[\] Campaign ids. Can be Integer or an Array of Integers [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referrals/get-available-referrals-for-current-promoter#parameter-sorting-state) sorting\[state\] enum Sort by state direction Available options: `asc`, `desc` [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referrals/get-available-referrals-for-current-promoter#parameter-sorting-email) sorting\[email\] enum Sort by email direction Available options: `asc`, `desc` #### Response 200 application/json Successful response [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referrals/get-available-referrals-for-current-promoter#response-items-id) id integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referrals/get-available-referrals-for-current-promoter#response-items-uid) uid string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referrals/get-available-referrals-for-current-promoter#response-items-state) state enum Available options: `subscribed`, `signup`, `active`, `cancelled`, `refunded`, `denied`, `pending`, `moved` [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referrals/get-available-referrals-for-current-promoter#response-items-metadata) metadata object [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referrals/get-available-referrals-for-current-promoter#response-items-created-at) created\_at string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referrals/get-available-referrals-for-current-promoter#response-items-customer-since) customer\_since string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referrals/get-available-referrals-for-current-promoter#response-items-email) email string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referrals/get-available-referrals-for-current-promoter#response-items-promoter-campaign) promoter\_campaign object Show child attributes [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referrals/get-available-referrals-for-current-promoter#response-items-promoter-campaign-id) promoter\_campaign.id integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referrals/get-available-referrals-for-current-promoter#response-items-promoter-campaign-campaign-id) promoter\_campaign.campaign\_id integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referrals/get-available-referrals-for-current-promoter#response-items-promoter-campaign-created-at) promoter\_campaign.created\_at string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referrals/get-available-referrals-for-current-promoter#response-items-promoter-campaign-campaign) promoter\_campaign.campaign object Show child attributes [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referrals/get-available-referrals-for-current-promoter#response-items-promoter-campaign-campaign-id) promoter\_campaign.campaign.id integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referrals/get-available-referrals-for-current-promoter#response-items-promoter-campaign-campaign-name) promoter\_campaign.campaign.name string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referrals/get-available-referrals-for-current-promoter#response-items-promoter-campaign-campaign-color) promoter\_campaign.campaign.color string [Destroys a referral link](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referral-links/destroys-a-referral-link) [Create referral for current promoter](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referrals/create-referral-for-current-promoter) ⌘I --- # Tracking with fpr.js - FirstPromoter Docs [Skip to main content](https://docs.firstpromoter.com/guides/tracking-with-fprjs#content-area) [FirstPromoter Docs home page![light logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/light.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=6ded212b82547bec37a22e90f72eeb71)![dark logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/dark.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=c393ff83772047b8a444f78a1e393e7f)](https://docs.firstpromoter.com/) v2 Search... ⌘K Search... Navigation How to guides Tracking with fpr.js [Documentation](https://docs.firstpromoter.com/introduction) [API Reference](https://docs.firstpromoter.com/api-reference-v2/api-admin/introduction) On this page * [Installation](https://docs.firstpromoter.com/guides/tracking-with-fprjs#installation) * [Tracking Flow](https://docs.firstpromoter.com/guides/tracking-with-fprjs#tracking-flow) * [1\. Click Tracking](https://docs.firstpromoter.com/guides/tracking-with-fprjs#1-click-tracking) * [2\. Referral Tracking](https://docs.firstpromoter.com/guides/tracking-with-fprjs#2-referral-tracking) * [3\. Sales Tracking](https://docs.firstpromoter.com/guides/tracking-with-fprjs#3-sales-tracking) [​](https://docs.firstpromoter.com/guides/tracking-with-fprjs#installation) Installation ------------------------------------------------------------------------------------------- First Add the main tracking scripts to your website. Replace `` with your **actual account id** found in the settings > integrations page on your FirstPromoter dashboard. Copy [​](https://docs.firstpromoter.com/guides/tracking-with-fprjs#tracking-flow) Tracking Flow --------------------------------------------------------------------------------------------- ### [​](https://docs.firstpromoter.com/guides/tracking-with-fprjs#1-click-tracking) 1\. Click Tracking The main tracking script automatically tracks visitors that come through your affiliate links: * When a visitor arrives on your website using a referral link the main tracking script will automatically track the click. * The click sets 2 cookies in the browser - `_fprom_ref` and `_fprom_tid` * These cookies are used for tracking in future without the need for a referral link. ### [​](https://docs.firstpromoter.com/guides/tracking-with-fprjs#2-referral-tracking) 2\. Referral Tracking When a visitor signs up or fills an opt-in form, convert them to a referral by using the signup function: Copy You can send only the email or only the uid or both. You need to ensure that the actual visitor data is passed to the function. ### [​](https://docs.firstpromoter.com/guides/tracking-with-fprjs#3-sales-tracking) 3\. Sales Tracking If you are using [Stripe](https://login.firstpromoter.com/?redirect=%2Fintegration%2Fstripe) , [Chargebee](https://login.firstpromoter.com/?redirect=%2Fintegration%2Fchargebee) , [Braintree](https://login.firstpromoter.com/?redirect=%2Fintegration%2Fbraintree) , [Paddle](https://login.firstpromoter.com/?redirect=%2Fintegration%2Fpaddle) or [Recurly](https://login.firstpromoter.com/?redirect=%2Fintegration%2Frecurly) we can track sales automatically on our end. You will only need to connect your billing provider to FirstPromoter. If you use any other billing provider you will need to track sales using the tracking [API](https://docs.firstpromoter.com/api-reference-v2/api-admin/tracking-api/sales) . For more information on sales tracking API, see documentation [here](https://docs.firstpromoter.com/api-reference-v2/api-admin/tracking-api/sales) When a sale event is received, FirstPromoter will automatically: * Identify the corresponding affiliate to assign the sale to. * Assign the corresponding reward/commission to the promoter. With this in place you have completed the basic tracking flow. From tracking of clicks through to assigning the corresponding commissions to the affiliates. [Quickstart](https://docs.firstpromoter.com/quickstart) [Tracking without fpr.js](https://docs.firstpromoter.com/guides/tracking-without-fprjs) ⌘I --- # How FirstPromoter works - FirstPromoter Docs [Skip to main content](https://docs.firstpromoter.com/how-it-works#content-area) [FirstPromoter Docs home page![light logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/light.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=6ded212b82547bec37a22e90f72eeb71)![dark logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/dark.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=c393ff83772047b8a444f78a1e393e7f)](https://docs.firstpromoter.com/) v2 Search... ⌘K Search... Navigation Overview How FirstPromoter works [Documentation](https://docs.firstpromoter.com/introduction) [API Reference](https://docs.firstpromoter.com/api-reference-v2/api-admin/introduction) On this page * [Setting Up a Campaign](https://docs.firstpromoter.com/how-it-works#setting-up-a-campaign) * [Click Tracking](https://docs.firstpromoter.com/how-it-works#click-tracking) * [Referral Tracking](https://docs.firstpromoter.com/how-it-works#referral-tracking) * [Sales Tracking](https://docs.firstpromoter.com/how-it-works#sales-tracking) [​](https://docs.firstpromoter.com/how-it-works#setting-up-a-campaign) Setting Up a Campaign ----------------------------------------------------------------------------------------------- Setting up a campaign with FirstPromoter is seamless and can be done in just a few clicks. During the onboarding process, you will create your first campaign. Each campaign generates a unique signup link that can be shared with your affiliates. When they sign up, FirstPromoter creates a unique referral link using the website URL you provide. Affiliates can then share their referral link with potential customers. [​](https://docs.firstpromoter.com/how-it-works#click-tracking) Click Tracking --------------------------------------------------------------------------------- Click tracking on FirstPromoter works after adding the main tracking script to your website. It works only once when a user visits a referral link by sending a `click` event to FirstPromoter. [​](https://docs.firstpromoter.com/how-it-works#referral-tracking) Referral Tracking --------------------------------------------------------------------------------------- Referral tracking occurs when a lead is captured on your website and sent to FirstPromoter after they sign up or fill out a form. This is achieved via the referral tracking script or API, which requires you to send the referral email address or UID to FirstPromoter. When a lead visits with a referral link, two cookies, `_fprom_tid` and `_fprom_ref`are set in their browser. These cookies have a default lifespan of 60 days (adjustable in the Admin panel) and are essential for the referral tracking script to function. [​](https://docs.firstpromoter.com/how-it-works#sales-tracking) Sales Tracking --------------------------------------------------------------------------------- Sales tracking is crucial for calculating commissions for affiliates. By default, FirstPromoter automatically tracks sales from providers like `Stripe`,`Chargebee`,`Braintree (subscriptions)`,`Recurly`, `Paddle` by listening to and cross-referencing events sent from the billing provider. For other billing providers or custom setups, we provide an API to send sales events to FirstPromoter. [Introduction](https://docs.firstpromoter.com/introduction) [Quickstart](https://docs.firstpromoter.com/quickstart) ⌘I --- # Tracking without fpr.js - FirstPromoter Docs [Skip to main content](https://docs.firstpromoter.com/guides/tracking-without-fprjs#content-area) [FirstPromoter Docs home page![light logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/light.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=6ded212b82547bec37a22e90f72eeb71)![dark logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/dark.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=c393ff83772047b8a444f78a1e393e7f)](https://docs.firstpromoter.com/) v2 Search... ⌘K Search... Navigation How to guides Tracking without fpr.js [Documentation](https://docs.firstpromoter.com/introduction) [API Reference](https://docs.firstpromoter.com/api-reference-v2/api-admin/introduction) On this page * [Tracking Flow](https://docs.firstpromoter.com/guides/tracking-without-fprjs#tracking-flow) * [1\. Store and retrieve link token (Referral ID):](https://docs.firstpromoter.com/guides/tracking-without-fprjs#1-store-and-retrieve-link-token-referral-id-%3A) * [I. Store referral link token implementation](https://docs.firstpromoter.com/guides/tracking-without-fprjs#i-store-referral-link-token-implementation) * [II. Retrive referral ID/token](https://docs.firstpromoter.com/guides/tracking-without-fprjs#ii-retrive-referral-id%2Ftoken) * [2\. Lead/Referral tracking](https://docs.firstpromoter.com/guides/tracking-without-fprjs#2-lead%2Freferral-tracking) * [3\. Sales Tracking](https://docs.firstpromoter.com/guides/tracking-without-fprjs#3-sales-tracking) [​](https://docs.firstpromoter.com/guides/tracking-without-fprjs#tracking-flow) Tracking Flow ================================================================================================ [​](https://docs.firstpromoter.com/guides/tracking-without-fprjs#1-store-and-retrieve-link-token-referral-id-:) 1\. Store and retrieve link token (Referral ID): ------------------------------------------------------------------------------------------------------------------------------------------------------------------- When a visitor arrives through a referral link (e.g., [https://yourdomain.com?fpr=joe13](https://yourdomain.com/?fpr=joe13) , where `fpr` is the affiliate’s Referral ID parameter and `joe13` is the value), retrieve the referral link token (Referral ID) from the referral link, store it in the browser’s localStorage or as cookie for later use. The available query parameters are `?fpr`, `?via`, `?fp_ref`, `?deal`, `?ref`, `?_from`, `?_by`, `?_go` . ### [​](https://docs.firstpromoter.com/guides/tracking-without-fprjs#i-store-referral-link-token-implementation) I. Store referral link token implementation client side (localStorage implementation) client side (cookie implementation) Copy ### [​](https://docs.firstpromoter.com/guides/tracking-without-fprjs#ii-retrive-referral-id/token) II. Retrive referral ID/token client-side (localStorage implementation) client Side(cookie retrieval implementation) Server Side (cookie retrieval implementation) Copy [​](https://docs.firstpromoter.com/guides/tracking-without-fprjs#2-lead/referral-tracking) 2\. Lead/Referral tracking ------------------------------------------------------------------------------------------------------------------------ When a visitor signs up or fills an opt-in form, convert them to a referral by using the [track/signup](https://docs.firstpromoter.com/api-reference-v2/api-admin/tracking-api/leads-and-signups) endpoint. You can send only the email or only the uid or both. You need to ensure that the actual visitor data is passed in the API call. Copy curl --request POST \ --url https://api.firstpromoter.com/api/v2/track/signup \ --header 'Account-ID: ' \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data '{ "email": "[email protected]", "uid": "cus_000001", "ref_id": "joe13", "skip_email_notification": true }' [​](https://docs.firstpromoter.com/guides/tracking-without-fprjs#3-sales-tracking) 3\. Sales Tracking -------------------------------------------------------------------------------------------------------- If you are using [Stripe](https://login.firstpromoter.com/?redirect=%2Fintegration%2Fstripe) , [Chargebee](https://login.firstpromoter.com/?redirect=%2Fintegration%2Fchargebee) , [Braintree](https://login.firstpromoter.com/?redirect=%2Fintegration%2Fbraintree) , [Paddle](https://login.firstpromoter.com/?redirect=%2Fintegration%2Fpaddle) or [Recurly](https://login.firstpromoter.com/?redirect=%2Fintegration%2Frecurly) we can track sales automatically on our end. You will only need to connect your billing provider to FirstPromoter. If you use any other billing provider you will need to track sales using the tracking [API](https://docs.firstpromoter.com/api-reference-v2/api-admin/tracking-api/sales) . For more information on sales tracking API, see documentation [here](https://docs.firstpromoter.com/api-reference-v2/api-admin/tracking-api/sales) When a sale event is received, FirstPromoter will automatically: * Identify the corresponding affiliate to assign the sale to. * Assign the corresponding reward/commission to the promoter. With this in place, you have completed the basic tracking flow. From storing and retrieval of affiliate referral link token (Referral ID) through to assigning the corresponding commissions to the affiliates. [Tracking with fpr.js](https://docs.firstpromoter.com/guides/tracking-with-fprjs) [Proxy Setup (Optional)](https://docs.firstpromoter.com/guides/proxy-setup) ⌘I --- # Download reports - FirstPromoter Docs [Skip to main content](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/reports/download-reports#content-area) [FirstPromoter Docs home page![light logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/light.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=6ded212b82547bec37a22e90f72eeb71)![dark logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/dark.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=c393ff83772047b8a444f78a1e393e7f)](https://docs.firstpromoter.com/) v2 Search... ⌘K Search... Navigation [Documentation](https://docs.firstpromoter.com/introduction) [API Reference](https://docs.firstpromoter.com/api-reference-v2/api-admin/introduction) [Affiliate API Reference](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/introduction) Download reports cURL Copy curl --request GET \ --url https://api.firstpromoter.com/api/v2/affiliate/reports/download \ --header 'Account-ID: ' \ --header 'Authorization: Bearer ' 200 Copy "" GET / reports / download Try it Download reports cURL Copy curl --request GET \ --url https://api.firstpromoter.com/api/v2/affiliate/reports/download \ --header 'Account-ID: ' \ --header 'Authorization: Bearer ' 200 Copy "" #### Authorizations [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/reports/download-reports#authorization-authorization) Authorization string header required Access token passed as a Bearer token in the Authorization header #### Headers [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/reports/download-reports#parameter-account-id) Account-ID string required Account identifier that specifies which account is making the request Example: `"acc_123456"` #### Query Parameters [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/reports/download-reports#parameter-report-type) report\_type enum required Available options: `overview`, `traffic_sources`, `urls`, `sub_ids` [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/reports/download-reports#parameter-totals) totals boolean [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/reports/download-reports#parameter-columns) columns string\[\] required [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/reports/download-reports#parameter-group-by) group\_by enum required Available options: `day`, `week`, `month`, `year` [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/reports/download-reports#parameter-start-date) start\_date string required [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/reports/download-reports#parameter-end-date) end\_date string required #### Response 200 text/csv Successful response The response is of type `string`. [Get sub ids report for current promoter](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/reports/get-sub_ids-report-for-current-promoter) ⌘I --- # Braintree - FirstPromoter Docs [Skip to main content](https://docs.firstpromoter.com/integrations/billing/braintree#content-area) [FirstPromoter Docs home page![light logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/light.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=6ded212b82547bec37a22e90f72eeb71)![dark logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/dark.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=c393ff83772047b8a444f78a1e393e7f)](https://docs.firstpromoter.com/) v2 Search... ⌘K Search... Navigation Billing Provider Braintree [Documentation](https://docs.firstpromoter.com/introduction) [API Reference](https://docs.firstpromoter.com/api-reference-v2/api-admin/introduction) `Difficulty: Easy` `Developer Required: No` FirstPromoter enables you to automatically track sales, refunds, upgrades and cancellations by connecting your Braintree account. Click [here](https://login.firstpromoter.com/?redirect=%2Fintegration%2Fbraintree) to view the guide. [Paddle](https://docs.firstpromoter.com/integrations/billing/paddle) [API](https://docs.firstpromoter.com/integrations/billing/api) ⌘I --- # Proxy Setup (Optional) - FirstPromoter Docs [Skip to main content](https://docs.firstpromoter.com/guides/proxy-setup#content-area) [FirstPromoter Docs home page![light logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/light.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=6ded212b82547bec37a22e90f72eeb71)![dark logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/dark.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=c393ff83772047b8a444f78a1e393e7f)](https://docs.firstpromoter.com/) v2 Search... ⌘K Search... Navigation How to guides Proxy Setup (Optional) [Documentation](https://docs.firstpromoter.com/introduction) [API Reference](https://docs.firstpromoter.com/api-reference-v2/api-admin/introduction) On this page * [Overview](https://docs.firstpromoter.com/guides/proxy-setup#overview) * [The Challenge with Ad Blockers](https://docs.firstpromoter.com/guides/proxy-setup#the-challenge-with-ad-blockers) * [Proxy Integration Solution](https://docs.firstpromoter.com/guides/proxy-setup#proxy-integration-solution) * [Implementation Methods](https://docs.firstpromoter.com/guides/proxy-setup#implementation-methods) * [Method 1: Vercel redirect setup](https://docs.firstpromoter.com/guides/proxy-setup#method-1%3A-vercel-redirect-setup) * [Method 2: Cloudflare workers setup](https://docs.firstpromoter.com/guides/proxy-setup#method-2%3A-cloudflare-workers-setup) * [Method 3: Apache setup](https://docs.firstpromoter.com/guides/proxy-setup#method-3%3A-apache-setup) * [Method 4: NGINX setup](https://docs.firstpromoter.com/guides/proxy-setup#method-4%3A-nginx-setup) [​](https://docs.firstpromoter.com/guides/proxy-setup#overview) Overview --------------------------------------------------------------------------- This document outlines how to implement proxy integrations with FirstPromoter to ensure reliable tracking even when ad blockers are present. By leveraging a proxy setup, you can maintain accurate affiliate tracking and conversion attribution while minimizing the impact of ad blocking technologies. [​](https://docs.firstpromoter.com/guides/proxy-setup#the-challenge-with-ad-blockers) The Challenge with Ad Blockers ----------------------------------------------------------------------------------------------------------------------- Ad blockers and privacy tools can interfere with affiliate tracking in several ways: * Blocking tracking scripts from loading * Preventing cookies from being set * Blocking HTTP requests to domains identified as tracking services * Stripping tracking parameters from URLs ![](https://mintcdn.com/firstpromoter/rNk-Jdvp2vdjAvd9/images/adblocker-l.png?w=2500&fit=max&auto=format&n=rNk-Jdvp2vdjAvd9&q=85&s=e46d0a6f4ed9ed78a027ff02f2cb7f47) ![](https://mintcdn.com/firstpromoter/rNk-Jdvp2vdjAvd9/images/adblocker-d.png?w=2500&fit=max&auto=format&n=rNk-Jdvp2vdjAvd9&q=85&s=7d58febc53bd49bae4dde7059593f0cd) FirstPromoter, like many affiliate platforms, can be affected by these measures, resulting in lost attribution data and commission tracking failures. [​](https://docs.firstpromoter.com/guides/proxy-setup#proxy-integration-solution) Proxy Integration Solution --------------------------------------------------------------------------------------------------------------- A proxy integration routes tracking requests through your own domain or a custom domain instead of directly to FirstPromoter’s tracking domain. This approach has several advantages: * **Improved Deliverability**: Requests appear to come from your trusted domain, not a third-party tracking service * **Reduced Blocking**: Most ad blockers don’t block first-party requests * **Enhanced Privacy**: User data stays within your domain ecosystem * **Better Performance**: Removes additional DNS lookups to third-party domains ### [​](https://docs.firstpromoter.com/guides/proxy-setup#implementation-methods) Implementation Methods #### [​](https://docs.firstpromoter.com/guides/proxy-setup#method-1:-vercel-redirect-setup) Method 1: Vercel redirect setup If your service is hosted by Vercel, they provide an option to reroute your requests. To set up a Vercel redirect, follow these steps: 1. Find your vercel.json file. This is usually in your root directory. 2. Add the following lines to your vercel.json file: Copy { "rewrites": [\ {\ "source": "/get_details",\ "destination": "https://t.firstpromoter.com/get_details"\ },\ {\ "source": "/tr",\ "destination": "https://t.firstpromoter.com/tr"\ }\ ] } You can change the source paths to anything that you like. However you will need to update the URL’s in the tracking scripts as well. For these we provide the following variables which you will use when setting up your scripts : `window.proxy_fpr_tr_url` and `window.proxy_fpr_get_details_url` 3. Download the tracking scripts from [here (Click here)](https://raw.githubusercontent.com/firstpromoter/docs/refs/heads/main/downloadables/fpr-prox.js) and add it to your main websites public directory. This will allow it to be fetched from your website. You can change the name of the file to anything but remember to rename it in the main tracking code below. 4. For your main tracking scripts, add the following code. Please replace `` with your **actual account id** in the settings > integrations page on your FirstPromoter dashboard. If you changed the urls to something more custom you can uncomment the `window.proxy_fpr_tr_url` and `window.proxy_fpr_get_details_url` variables and update them to match your proxy urls. Copy 6. Deploy your changes and test using the brave browser or install uBlockOrigin and confirm if your tracking is working as expected #### [​](https://docs.firstpromoter.com/guides/proxy-setup#method-2:-cloudflare-workers-setup) Method 2: Cloudflare workers setup Cloudflare provides a free plan with up to 100,000 requests per day, making it a good choice for a reverse proxy setup. To set up a Cloudflare worker, follow these steps: 1. Set up a Cloudflare Worker Navigate to the Cloudflare dashboard, select `Compute (Workers)` > `Workers & Pages` > `Create`. You can choose a custom name for your worker or use the default one. Click “Deploy” when ready. Please take note of the url of your worker as this will be needed in your setup of the tracking scripts. 2. Modify the Worker for Proxy Functionality After deploying your new worker, click “Edit code”. If you’re already on the worker’s page, select “Quick edit”. This will open a code editor where you should replace the existing code with the following proxy code: Copy const FP_CDN_HOST = "https://cdn.firstpromoter.com/fpr-proxy.js"; const FP_HOST = "https://t.firstpromoter.com"; async function handleRequest(request, ctx) { const url = new URL(request.url) const pathname = url.pathname const search = url.search const pathWithParams = pathname + search return forwardRequest(request, pathWithParams) } async function forwardRequest(request, pathWithSearch) { const originRequest = new Request(request) originRequest.headers.delete("cookie") return await fetch(`${FP_HOST}${pathWithSearch}`, originRequest) } export default { async fetch(request, env, ctx) { return handleRequest(request, ctx); } }; 3. When done, click “Save and deploy”. 4. Download the tracking scripts from [here (Click here)](https://raw.githubusercontent.com/firstpromoter/docs/refs/heads/main/downloadables/fpr-prox.js) and add it to your main websites public directory. This will allow it to be fetched from your website. You can change the name of the file to anything but remember to rename it in the main tracking code below. 5. For your main tracking scripts, add the following code. Please replace `` with the url of your worker and `` with your **actual account id** in the settings > integrations page on your FirstPromoter dashboard. Copy 6. Test using the brave browser or install uBlockOrigin and confirm if your tracking is working as expected #### [​](https://docs.firstpromoter.com/guides/proxy-setup#method-3:-apache-setup) Method 3: Apache setup 1. Find your apache config. Depending on your setup you may need to put the below in your default-ssl.conf file. `yourdomain.com/tr` will be pointed to `https://t.firstpromoter.com/tr` and `yourdomain.com/tr/get_details` will point to `https://t.firstpromoter.com/get_details`. Feel free to change `/tr` to anything you want on your domain if you do you will be required to set the following in your script `window.proxy_fpr_tr_url` and `window.proxy_fpr_get_details_url` Copy #your other configs ProxyPass /tr/get_details https://t.firstpromoter.com/get_details ProxyPassReverse /tr/get_details https://t.firstpromoter.com/get_details ProxyPass /tr https://t.firstpromoter.com/tr ProxyPassReverse /tr https://t.firstpromoter.com/tr Feel free to change `/tr` and `/tr/get_details` to anything you want on your domain if you do you will be required to set the following in your script `window.proxy_fpr_tr_url` and `window.proxy_fpr_get_details_url` 2. Restart your server. `sudo service apache2 restart` 3. Download the FirstPromoter scripts from [here (Click here)](https://raw.githubusercontent.com/firstpromoter/docs/refs/heads/main/downloadables/fpr-prox.js) and add it to your main websites public directory. This will allow it to be fetched from your website. 4. Add the scripts below directly to your website. Replace `` with your **actual account id** in the settings > integrations page on your FirstPromoter dashboard. Copy 5. Deploy and test using the brave browser or install uBlockOrigin and confirm if your tracking is working as expected. #### [​](https://docs.firstpromoter.com/guides/proxy-setup#method-4:-nginx-setup) Method 4: NGINX setup 1. Find your NGINX config file. This is typically at: `/etc/nginx/sites-available/yourdomain.com` Or if using a default site: `/etc/nginx/sites-available/default` Then within the server block, add the proxy rules like this: Copy location /tr/get_details { proxy_pass https://t.firstpromoter.com/get_details; proxy_set_header Host t.firstpromoter.com; proxy_ssl_server_name on; } location /tr { proxy_pass https://t.firstpromoter.com/tr; proxy_set_header Host t.firstpromoter.com; proxy_ssl_server_name on; } The contents of your file should look like the below Copy server { listen 80; server_name yourdomain.com; location /tr/get_details { proxy_pass https://t.firstpromoter.com/get_details; proxy_set_header Host t.firstpromoter.com; proxy_ssl_server_name on; } location /tr { proxy_pass https://t.firstpromoter.com/tr; proxy_set_header Host t.firstpromoter.com; proxy_ssl_server_name on; } # other configs here } 2. Restart your server. `sudo service nginx restart` 3. Download the FirstPromoter scripts from from [here (Click here)](https://raw.githubusercontent.com/firstpromoter/docs/refs/heads/main/downloadables/fpr-prox.js) and add it to your main websites public directory. This will allow it to be fetched from your website. 4. Add the scripts below directly to your website. Replace `your-account-id-here` with your **actual account id** in the settings > integrations page on your FirstPromoter dashboard. Copy 5. Deploy and test using the brave browser or install uBlockOrigin and confirm if your tracking is working as expected [Tracking without fpr.js](https://docs.firstpromoter.com/guides/tracking-without-fprjs) [FirstPromoter JavaScript Library (fpr.js)](https://docs.firstpromoter.com/script-docs/fpr-js-docs) ⌘I --- # API - FirstPromoter Docs [Skip to main content](https://docs.firstpromoter.com/integrations/billing/api#content-area) [FirstPromoter Docs home page![light logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/light.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=6ded212b82547bec37a22e90f72eeb71)![dark logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/dark.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=c393ff83772047b8a444f78a1e393e7f)](https://docs.firstpromoter.com/) v2 Search... ⌘K Search... Navigation Billing Provider API [Documentation](https://docs.firstpromoter.com/introduction) [API Reference](https://docs.firstpromoter.com/api-reference-v2/api-admin/introduction) `Difficulty: Intermediate` `Developer Required: Yes` Our API allows you to track sales, refunds, upgrades and cancellations even if you have a billing provider we do not support. **Precondition**: You will need to set up an endpoint on your server for which you will receive webhook events from your billing provider. Once you are receiving webhook events on your server from your billing provider, you can then make a request to FirstPromoter to track sales when events are received. Click [here](https://login.firstpromoter.com/?redirect=%2Fintegration%2Fcustom) to view the guilde. [Braintree](https://docs.firstpromoter.com/integrations/billing/braintree) [Highlevel](https://docs.firstpromoter.com/integrations/tracking/platform/highlevel) ⌘I --- # Chargebee - FirstPromoter Docs [Skip to main content](https://docs.firstpromoter.com/integrations/billing/chargebee#content-area) [FirstPromoter Docs home page![light logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/light.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=6ded212b82547bec37a22e90f72eeb71)![dark logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/dark.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=c393ff83772047b8a444f78a1e393e7f)](https://docs.firstpromoter.com/) v2 Search... ⌘K Search... Navigation Billing Provider Chargebee [Documentation](https://docs.firstpromoter.com/introduction) [API Reference](https://docs.firstpromoter.com/api-reference-v2/api-admin/introduction) `Difficulty: Easy` `Developer Required: No` FirstPromoter enables you to automatically track sales, refunds, upgrades and cancellations by connecting your Chargebee account. Click [here](https://login.firstpromoter.com/?redirect=%2Fintegration%2Fchargebee) to view the guide. [Stripe](https://docs.firstpromoter.com/integrations/billing/stripe) [Recurly](https://docs.firstpromoter.com/integrations/billing/recurly) ⌘I --- # Paddle - FirstPromoter Docs [Skip to main content](https://docs.firstpromoter.com/integrations/billing/paddle#content-area) [FirstPromoter Docs home page![light logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/light.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=6ded212b82547bec37a22e90f72eeb71)![dark logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/dark.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=c393ff83772047b8a444f78a1e393e7f)](https://docs.firstpromoter.com/) v2 Search... ⌘K Search... Navigation Billing Provider Paddle [Documentation](https://docs.firstpromoter.com/introduction) [API Reference](https://docs.firstpromoter.com/api-reference-v2/api-admin/introduction) `Difficulty: Easy` `Developer Required: No` FirstPromoter enables you to automatically track sales, refunds, upgrades and cancellations from your Paddle account automatically. Click [here](https://login.firstpromoter.com/?redirect=%2Fintegration%2Fpaddle) to view the guide. [Recurly](https://docs.firstpromoter.com/integrations/billing/recurly) [Braintree](https://docs.firstpromoter.com/integrations/billing/braintree) ⌘I --- # Recurly - FirstPromoter Docs [Skip to main content](https://docs.firstpromoter.com/integrations/billing/recurly#content-area) [FirstPromoter Docs home page![light logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/light.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=6ded212b82547bec37a22e90f72eeb71)![dark logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/dark.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=c393ff83772047b8a444f78a1e393e7f)](https://docs.firstpromoter.com/) v2 Search... ⌘K Search... Navigation Billing Provider Recurly [Documentation](https://docs.firstpromoter.com/introduction) [API Reference](https://docs.firstpromoter.com/api-reference-v2/api-admin/introduction) `Difficulty: Easy` `Developer Required: No` FirstPromoter enables you to automatically track sales, refunds, upgrades and cancellations from your Recurly account automatically. Click [here](https://login.firstpromoter.com/?redirect=%2Fintegration%2Frecurly) to view the guide. [Chargebee](https://docs.firstpromoter.com/integrations/billing/chargebee) [Paddle](https://docs.firstpromoter.com/integrations/billing/paddle) ⌘I --- # Stripe - FirstPromoter Docs [Skip to main content](https://docs.firstpromoter.com/integrations/billing/stripe#content-area) [FirstPromoter Docs home page![light logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/light.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=6ded212b82547bec37a22e90f72eeb71)![dark logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/dark.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=c393ff83772047b8a444f78a1e393e7f)](https://docs.firstpromoter.com/) v2 Search... ⌘K Search... Navigation Billing Provider Stripe [Documentation](https://docs.firstpromoter.com/introduction) [API Reference](https://docs.firstpromoter.com/api-reference-v2/api-admin/introduction) `Difficulty: Easy` `Developer Required: No` FirstPromoter enables you to automatically track sales, refunds, upgrades and cancellations by connecting your Stripe account either in Test or Live mode. Click [here](https://login.firstpromoter.com/?redirect=%2Fintegration%2Fstripe) to view the guide. [Concepts & Key Terminologies](https://docs.firstpromoter.com/script-docs/concepts) [Chargebee](https://docs.firstpromoter.com/integrations/billing/chargebee) ⌘I --- # Get campaigns reports for current promoter - FirstPromoter Docs [Skip to main content](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/reports/get-campaigns-reports-for-current-promoter#content-area) [FirstPromoter Docs home page![light logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/light.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=6ded212b82547bec37a22e90f72eeb71)![dark logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/dark.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=c393ff83772047b8a444f78a1e393e7f)](https://docs.firstpromoter.com/) v2 Search... ⌘K Search... Navigation [Documentation](https://docs.firstpromoter.com/introduction) [API Reference](https://docs.firstpromoter.com/api-reference-v2/api-admin/introduction) [Affiliate API Reference](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/introduction) Get campaigns reports cURL Copy curl --request GET \ --url https://api.firstpromoter.com/api/v2/affiliate/reports/overview \ --header 'Account-ID: ' \ --header 'Authorization: Bearer ' 200 401 403 422 Copy [\ {\ "period": "",\ "id": "",\ "data": {\ "revenue_amount": 123,\ "net_revenue_amount": 123,\ "promoter_earnings_amount": 123,\ "customers_count": 123,\ "referrals_count": 123,\ "clicks_count": 123,\ "active_customers": 123,\ "3m_epc": 123\ }\ }\ ] GET / reports / overview Try it Get campaigns reports cURL Copy curl --request GET \ --url https://api.firstpromoter.com/api/v2/affiliate/reports/overview \ --header 'Account-ID: ' \ --header 'Authorization: Bearer ' 200 401 403 422 Copy [\ {\ "period": "",\ "id": "",\ "data": {\ "revenue_amount": 123,\ "net_revenue_amount": 123,\ "promoter_earnings_amount": 123,\ "customers_count": 123,\ "referrals_count": 123,\ "clicks_count": 123,\ "active_customers": 123,\ "3m_epc": 123\ }\ }\ ] #### Authorizations [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/reports/get-campaigns-reports-for-current-promoter#authorization-authorization) Authorization string header required Access token passed as a Bearer token in the Authorization header #### Headers [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/reports/get-campaigns-reports-for-current-promoter#parameter-account-id) Account-ID string required Account identifier that specifies which account is making the request Example: `"acc_123456"` #### Query Parameters [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/reports/get-campaigns-reports-for-current-promoter#parameter-columns) columns enum\[\] required Available options: `active_customers`, `monthly_churn`, `clicks_count`, `net_revenue_amount`, `revenue_amount`, `referrals_count`, `customers_count`, `sales_count`, `refunds_count`, `cancelled_customers_count`, `promoter_earnings_amount`, `non_link_customers`, `referrals_to_customers_cr`, `3m_epc`, `6m_epc`, `clicks_to_customers_cr`, `clicks_to_referrals_cr`, `promoter_paid_amount`, `signups_count` [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/reports/get-campaigns-reports-for-current-promoter#parameter-q) q string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/reports/get-campaigns-reports-for-current-promoter#parameter-group-by) group\_by enum required Available options: `day`, `week`, `month`, `year` [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/reports/get-campaigns-reports-for-current-promoter#parameter-start-date) start\_date string required [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/reports/get-campaigns-reports-for-current-promoter#parameter-end-date) end\_date string required [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/reports/get-campaigns-reports-for-current-promoter#parameter-sorting) sorting object Show child attributes [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/reports/get-campaigns-reports-for-current-promoter#parameter-additional-properties) sorting.{key} enum Available options: `asc`, `desc` #### Response 200 application/json Successful response [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/reports/get-campaigns-reports-for-current-promoter#response-items-period) period string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/reports/get-campaigns-reports-for-current-promoter#response-items-id) id string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/reports/get-campaigns-reports-for-current-promoter#response-items-data) data object Show child attributes [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/reports/get-campaigns-reports-for-current-promoter#response-items-data-revenue-amount) data.revenue\_amount number [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/reports/get-campaigns-reports-for-current-promoter#response-items-data-net-revenue-amount) data.net\_revenue\_amount number [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/reports/get-campaigns-reports-for-current-promoter#response-items-data-promoter-earnings-amount) data.promoter\_earnings\_amount number [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/reports/get-campaigns-reports-for-current-promoter#response-items-data-customers-count) data.customers\_count integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/reports/get-campaigns-reports-for-current-promoter#response-items-data-referrals-count) data.referrals\_count integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/reports/get-campaigns-reports-for-current-promoter#response-items-data-clicks-count) data.clicks\_count integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/reports/get-campaigns-reports-for-current-promoter#response-items-data-active-customers) data.active\_customers integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/reports/get-campaigns-reports-for-current-promoter#response-items-data-3m-epc) data.3m\_epc number [Export referrals](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/referrals/export-referrals) [Get sub ids report for current promoter](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/reports/get-sub_ids-report-for-current-promoter) ⌘I --- # API Integration - FirstPromoter Docs [Skip to main content](https://docs.firstpromoter.com/integrations/tracking/custom/api#content-area) [FirstPromoter Docs home page![light logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/light.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=6ded212b82547bec37a22e90f72eeb71)![dark logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/dark.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=c393ff83772047b8a444f78a1e393e7f)](https://docs.firstpromoter.com/) v2 Search... ⌘K Search... Navigation Custom API Integration [Documentation](https://docs.firstpromoter.com/introduction) [API Reference](https://docs.firstpromoter.com/api-reference-v2/api-admin/introduction) `Difficulty: Intermediate` `Developer Required: Yes` With our API you can track the referrals from your website dynamically from your backend. Click [here](https://login.firstpromoter.com/?redirect=%2Finstructions%2Fapi) to view the guide. [JavaScript Tracking](https://docs.firstpromoter.com/integrations/tracking/custom/js) [Django](https://docs.firstpromoter.com/integrations/tracking/custom/django) ⌘I --- # Introduction - FirstPromoter Docs [Skip to main content](https://docs.firstpromoter.com/introduction#content-area) [FirstPromoter Docs home page![light logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/light.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=6ded212b82547bec37a22e90f72eeb71)![dark logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/dark.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=c393ff83772047b8a444f78a1e393e7f)](https://docs.firstpromoter.com/) v2 Search... ⌘K Search... Navigation [Documentation](https://docs.firstpromoter.com/introduction) [API Reference](https://docs.firstpromoter.com/api-reference-v2/api-admin/introduction) On this page * [What is FirstPromoter](https://docs.firstpromoter.com/introduction#what-is-firstpromoter) * [Benefits of using FirstPromoter](https://docs.firstpromoter.com/introduction#benefits-of-using-firstpromoter) * [Key Features](https://docs.firstpromoter.com/introduction#key-features) [​](https://docs.firstpromoter.com/introduction#what-is-firstpromoter) What is FirstPromoter ----------------------------------------------------------------------------------------------- FirstPromoter is a modern and reliable affiliate tool for subscription-based/SaaS companies that enables you to track, manage and optimize referral-based marketing programs. It is easy to set up, yet powerful to scale with your growing needs. Instead of coding your own affiliate programs, you can simply integrate with FirstPromoter to handle your affiliate programs for you with a few lines of code. ### [​](https://docs.firstpromoter.com/introduction#benefits-of-using-firstpromoter) Benefits of using FirstPromoter Use your own domain ------------------- Set your own domain (with SSL encryption support) for affiliate dashboard and sign up pages. Individual rewards and bonuses ------------------------------ Give performance bonuses and personalize the commissions and rewards scheme for each affiliate individually. Advanced reporting ------------------ Oversee the performance of your affiliate program across 18 data points. Fraud protection ---------------- Affiliates get commissions only when the purchase is confirmed by your billing provider. We also have algorithms to identify suspicious leads. SEO-friendly referral links --------------------------- No redirects. No ugly short-links. Get the maximum SEO juice with referral links in 8 formats. Invite your team ---------------- Get your teammates inside FirstPromoter. You can set 4 different user roles ( `Manager`, `Admin`, `Admin Plus`, `Super Admin`) and restrict access to certain campaigns. Multiple currencies ------------------- We support 190 currencies and can do conversions in 170. We use daily updated exchange rates and you can apply your own exchange fee. Custom CSS and JavaScript ------------------------- Get unlimited flexibility on your affiliates’ dashboard. From enabling services like live-chat, surveys or analytics to changing the design completely. Embeddable affiliate dashboard ------------------------------ You can embed the affiliate dashboard inside your application and log your users in automatically, without asking them to enter a password or email. ### [​](https://docs.firstpromoter.com/introduction#key-features) Key Features Launch affiliate and referral campaigns with ease ------------------------------------------------- Follow the step-by-step setup to start your first affiliate program, no matter how simple or complex your affiliate scheme is. Customize the affiliate dashboard with your branding ---------------------------------------------------- Edit the affiliate dashboard to make it yours. Add your colors, logo, and choose the layout that suits you. Track personalized referral links and coupon codes -------------------------------------------------- Track sales by discount coupon codes alone, email or personalized referral links. Leverage powerful reporting --------------------------- Oversee the performance of your affiliate program across 18 data points. Save time with one-click payouts -------------------------------- Pay hundreds of affiliates at once, directly from the FirstPromoter dashboard. [How FirstPromoter works](https://docs.firstpromoter.com/how-it-works) ⌘I --- # Django - FirstPromoter Docs [Skip to main content](https://docs.firstpromoter.com/integrations/tracking/custom/django#content-area) [FirstPromoter Docs home page![light logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/light.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=6ded212b82547bec37a22e90f72eeb71)![dark logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/dark.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=c393ff83772047b8a444f78a1e393e7f)](https://docs.firstpromoter.com/) v2 Search... ⌘K Search... Navigation Custom Django [Documentation](https://docs.firstpromoter.com/introduction) [API Reference](https://docs.firstpromoter.com/api-reference-v2/api-admin/introduction) `Difficulty: Intermediate` `Developer Required: Yes` Depending on the complexity of your website it is ideal to have a developer assist you in the setup. With FirstPromoter you can setup click and signup tracking using our Django integration option. Click [here](https://login.firstpromoter.com/?redirect=%2Finstructions%2Fdjango) to view the guide. [API Integration](https://docs.firstpromoter.com/integrations/tracking/custom/api) [PHP](https://docs.firstpromoter.com/integrations/tracking/custom/php) ⌘I --- # Ruby on rails - FirstPromoter Docs [Skip to main content](https://docs.firstpromoter.com/integrations/tracking/custom/rails#content-area) [FirstPromoter Docs home page![light logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/light.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=6ded212b82547bec37a22e90f72eeb71)![dark logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/dark.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=c393ff83772047b8a444f78a1e393e7f)](https://docs.firstpromoter.com/) v2 Search... ⌘K Search... Navigation Custom Ruby on rails [Documentation](https://docs.firstpromoter.com/introduction) [API Reference](https://docs.firstpromoter.com/api-reference-v2/api-admin/introduction) `Difficulty: Intermediate` `Developer Required: Yes` Depending on the complexity of your website it is ideal to have a developer assist you in the setup. With FirstPromoter you can setup click and signup tracking using our Rails integration option. This setup mainly requires you to add tracking scripts into your website or web application integrating it at a code level and sending details about the referrals using the script. Click [here](https://login.firstpromoter.com/?redirect=%2Finstructions%2Frails) to view the guide. [PHP](https://docs.firstpromoter.com/integrations/tracking/custom/php) [Stripe Checkout](https://docs.firstpromoter.com/integrations/tracking/custom/stripe-checkout) ⌘I --- # PHP - FirstPromoter Docs [Skip to main content](https://docs.firstpromoter.com/integrations/tracking/custom/php#content-area) [FirstPromoter Docs home page![light logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/light.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=6ded212b82547bec37a22e90f72eeb71)![dark logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/dark.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=c393ff83772047b8a444f78a1e393e7f)](https://docs.firstpromoter.com/) v2 Search... ⌘K Search... Navigation Custom PHP [Documentation](https://docs.firstpromoter.com/introduction) [API Reference](https://docs.firstpromoter.com/api-reference-v2/api-admin/introduction) `Difficulty: Intermediate` `Developer Required: Yes` Depending on the complexity of your website it is ideal to have a developer assist you in the setup. With FirstPromoter you can setup click and signup tracking using our PHP integration option. This setup mainly requires you to add tracking scripts into your website or web application integrating it at a code level and sending details about the referrals using the script. Click [here](https://login.firstpromoter.com/?redirect=%2Finstructions%2Fphp) to view the guide. [Django](https://docs.firstpromoter.com/integrations/tracking/custom/django) [Ruby on rails](https://docs.firstpromoter.com/integrations/tracking/custom/rails) ⌘I --- # Paddle Checkout - FirstPromoter Docs [Skip to main content](https://docs.firstpromoter.com/integrations/tracking/custom/paddle-checkout#content-area) [FirstPromoter Docs home page![light logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/light.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=6ded212b82547bec37a22e90f72eeb71)![dark logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/dark.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=c393ff83772047b8a444f78a1e393e7f)](https://docs.firstpromoter.com/) v2 Search... ⌘K Search... Navigation Custom Paddle Checkout [Documentation](https://docs.firstpromoter.com/introduction) [API Reference](https://docs.firstpromoter.com/api-reference-v2/api-admin/introduction) `Difficulty: Intermediate` `Developer Required: Yes` Depending on the complexity of your website it is ideal to have a developer assist you in the setup. If you are using the paddle checkout feature on your website you can integrate with FirstPromoter. This setup mainly requires you to add tracking scripts into your website and setting extra configurations on your paddle billing/classic checkout function `Paddle.Checkout.open()` or `Paddle.Initialize()`. Click [here](https://login.firstpromoter.com/?redirect=%2Finstructions%2Fpaddle-checkout) to view the guide. [Stripe Checkout](https://docs.firstpromoter.com/integrations/tracking/custom/stripe-checkout) [Google Tag Manager](https://docs.firstpromoter.com/integrations/tracking/custom/gtm) ⌘I --- # Stripe Checkout - FirstPromoter Docs [Skip to main content](https://docs.firstpromoter.com/integrations/tracking/custom/stripe-checkout#content-area) [FirstPromoter Docs home page![light logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/light.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=6ded212b82547bec37a22e90f72eeb71)![dark logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/dark.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=c393ff83772047b8a444f78a1e393e7f)](https://docs.firstpromoter.com/) v2 Search... ⌘K Search... Navigation Custom Stripe Checkout [Documentation](https://docs.firstpromoter.com/introduction) [API Reference](https://docs.firstpromoter.com/api-reference-v2/api-admin/introduction) `Difficulty: Intermediate` `Developer Required: Yes` Depending on the complexity of your website it is ideal to have a developer assist you in the setup. If you are using the [stripe checkout feature](https://stripe.com/en-ro/payments/checkout) on your website you can integrate with FirstPromoter. You should have a checkout page similar to this. Otherwise we suggest you use our JavaScript option instead. Click [here](https://login.firstpromoter.com/?redirect=%2Finstructions%2Fstripe-checkout) to view the guide. [Ruby on rails](https://docs.firstpromoter.com/integrations/tracking/custom/rails) [Paddle Checkout](https://docs.firstpromoter.com/integrations/tracking/custom/paddle-checkout) ⌘I --- # JavaScript Tracking - FirstPromoter Docs [Skip to main content](https://docs.firstpromoter.com/integrations/tracking/custom/js#content-area) [FirstPromoter Docs home page![light logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/light.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=6ded212b82547bec37a22e90f72eeb71)![dark logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/dark.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=c393ff83772047b8a444f78a1e393e7f)](https://docs.firstpromoter.com/) v2 Search... ⌘K Search... Navigation Custom JavaScript Tracking [Documentation](https://docs.firstpromoter.com/introduction) [API Reference](https://docs.firstpromoter.com/api-reference-v2/api-admin/introduction) `Difficulty: Intermediate` `Developer Required: Yes` Depending on the complexity of your website it is ideal to have a developer assist you in the setup. With FirstPromoter you can setup click and signup tracking using our JavaScript integration. This setup mainly requires you to add tracking scripts into your website or web application integrating it at a code level. Click [here](https://login.firstpromoter.com/?redirect=%2Finstructions%2Fjavascript) to view the guide. [Hosted Pages](https://docs.firstpromoter.com/integrations/tracking/platform/chargebee/hosted-pages) [API Integration](https://docs.firstpromoter.com/integrations/tracking/custom/api) ⌘I --- # Google Tag Manager - FirstPromoter Docs [Skip to main content](https://docs.firstpromoter.com/integrations/tracking/custom/gtm#content-area) [FirstPromoter Docs home page![light logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/light.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=6ded212b82547bec37a22e90f72eeb71)![dark logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/dark.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=c393ff83772047b8a444f78a1e393e7f)](https://docs.firstpromoter.com/) v2 Search... ⌘K Search... Navigation Custom Google Tag Manager [Documentation](https://docs.firstpromoter.com/introduction) [API Reference](https://docs.firstpromoter.com/api-reference-v2/api-admin/introduction) `Difficulty: Intermediate` `Developer Required: Yes` With FirstPromoter you can setup click and signup tracking using our Google Tag Manager option. This setup mainly requires you to add tracking scripts into your Google Tag Manager and sending details about the referrals using the script. Depending on the complexity of your website it is ideal to have a developer assist you in the setup. This procedure assumes you have already Set up GTM to work on your website. 1. To get started on FirstPromoter: * [Login](https://login.firstpromoter.com/) to your admin account. * Navigate to Settings > Integrations > Integrate your website section of your dashboard. * Click on the `Integrate` button. * Click on the `setup` button or click on the `change` link for a new setup instructions. * Under `Custom integration`, select the `JS` option. * Copy the `Main tracking script` under the `JavaScript` tab. 2. Login in Google Tag Manager: * Navigate to your `Tags` section * Click on `New` button (at top right corner) ![](https://mintcdn.com/firstpromoter/rNk-Jdvp2vdjAvd9/images/gtm/image-1.png?w=2500&fit=max&auto=format&n=rNk-Jdvp2vdjAvd9&q=85&s=e412e99024f84938f119aea9d2de9074) * Click on the `Tag configuration` panel to open the TAG type selection panel. ![](https://mintcdn.com/firstpromoter/rNk-Jdvp2vdjAvd9/images/gtm/image-2.png?w=2500&fit=max&auto=format&n=rNk-Jdvp2vdjAvd9&q=85&s=a4ed5e7b8c4ec9a2216433b7de59dfce) * Scroll down and select the `Custom HTML` option ![](https://mintcdn.com/firstpromoter/rNk-Jdvp2vdjAvd9/images/gtm/image-3.png?w=2500&fit=max&auto=format&n=rNk-Jdvp2vdjAvd9&q=85&s=0118f7d7d31837182c272b77f1fc0364) * Add/paste the `Main tracking script` copied from FirstPromoter into the `HTML` Section. As shown in the screenshot below: ![](https://mintcdn.com/firstpromoter/rNk-Jdvp2vdjAvd9/images/gtm/image-4.png?w=2500&fit=max&auto=format&n=rNk-Jdvp2vdjAvd9&q=85&s=d77f760c6ae940e27a1032d66836ad03) * Now, you need to select when Google Tag Manager should trigger the script. To do this, scroll down to the `triggering` section, click on it and choose when to trigger the tag. We recommend selecting the `pages trigger` to load the `Main tracking script` on all your landing pages. ![](https://mintcdn.com/firstpromoter/rNk-Jdvp2vdjAvd9/images/gtm/image-5.png?w=2500&fit=max&auto=format&n=rNk-Jdvp2vdjAvd9&q=85&s=8291a0efe4329823d7aa9a8a981c45f3) ![](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/images/gtm/image-5a.png?w=2500&fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=c1d3519c4f60516fe8adb79532d9e5f5) * Rename/change the name to `Firstpromoter Main Tracking script` ![](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/images/gtm/image-6.png?w=2500&fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=93e16dcb74a43a69c9d591805a88fee5) * Save and publish your changes. ![](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/images/gtm/image-7.png?w=2500&fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=415e80010ae6f8bad8a107d7f014e901) [Paddle Checkout](https://docs.firstpromoter.com/integrations/tracking/custom/paddle-checkout) [Overview](https://docs.firstpromoter.com/webhooks/overview) ⌘I --- # Get sub ids report for current promoter - FirstPromoter Docs [Skip to main content](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/reports/get-sub_ids-report-for-current-promoter#content-area) [FirstPromoter Docs home page![light logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/light.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=6ded212b82547bec37a22e90f72eeb71)![dark logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/dark.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=c393ff83772047b8a444f78a1e393e7f)](https://docs.firstpromoter.com/) v2 Search... ⌘K Search... Navigation [Documentation](https://docs.firstpromoter.com/introduction) [API Reference](https://docs.firstpromoter.com/api-reference-v2/api-admin/introduction) [Affiliate API Reference](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/introduction) Get sub\_ids report cURL Copy curl --request GET \ --url https://api.firstpromoter.com/api/v2/affiliate/reports/sub_ids \ --header 'Account-ID: ' \ --header 'Authorization: Bearer ' 200 401 403 422 Copy [\ {\ "sub_id": "",\ "id": "",\ "data": {\ "clicks_count": 123,\ "revenue_amount": 123,\ "promoter_earnings_amount": 123,\ "referrals_count": 123,\ "customers_count": 123,\ "sales_count": 123,\ "refunds_count": 123,\ "cancelled_customers_count": 123,\ "referrals_to_customers_cr": 123,\ "clicks_to_customers_cr": 123,\ "clicks_to_referrals_cr": 123\ },\ "sub_data": [\ {\ "period": "",\ "id": "",\ "data": ""\ }\ ]\ }\ ] GET / reports / sub\_ids Try it Get sub\_ids report cURL Copy curl --request GET \ --url https://api.firstpromoter.com/api/v2/affiliate/reports/sub_ids \ --header 'Account-ID: ' \ --header 'Authorization: Bearer ' 200 401 403 422 Copy [\ {\ "sub_id": "",\ "id": "",\ "data": {\ "clicks_count": 123,\ "revenue_amount": 123,\ "promoter_earnings_amount": 123,\ "referrals_count": 123,\ "customers_count": 123,\ "sales_count": 123,\ "refunds_count": 123,\ "cancelled_customers_count": 123,\ "referrals_to_customers_cr": 123,\ "clicks_to_customers_cr": 123,\ "clicks_to_referrals_cr": 123\ },\ "sub_data": [\ {\ "period": "",\ "id": "",\ "data": ""\ }\ ]\ }\ ] #### Authorizations [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/reports/get-sub_ids-report-for-current-promoter#authorization-authorization) Authorization string header required Access token passed as a Bearer token in the Authorization header #### Headers [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/reports/get-sub_ids-report-for-current-promoter#parameter-account-id) Account-ID string required Account identifier that specifies which account is making the request Example: `"acc_123456"` #### Query Parameters [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/reports/get-sub_ids-report-for-current-promoter#parameter-columns) columns enum\[\] required Available options: `clicks_count`, `revenue_amount`, `promoter_earnings_amount`, `referrals_count`, `customers_count`, `sales_count`, `refunds_count`, `cancelled_customers_count`, `referrals_to_customers_cr`, `clicks_to_customers_cr`, `clicks_to_referrals_cr` [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/reports/get-sub_ids-report-for-current-promoter#parameter-q) q string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/reports/get-sub_ids-report-for-current-promoter#parameter-group-by) group\_by enum required Available options: `day`, `week`, `month`, `year` [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/reports/get-sub_ids-report-for-current-promoter#parameter-start-date) start\_date string required [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/reports/get-sub_ids-report-for-current-promoter#parameter-end-date) end\_date string required [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/reports/get-sub_ids-report-for-current-promoter#parameter-sorting) sorting object Show child attributes [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/reports/get-sub_ids-report-for-current-promoter#parameter-additional-properties) sorting.{key} enum Available options: `asc`, `desc` #### Response 200 application/json Successful response [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/reports/get-sub_ids-report-for-current-promoter#response-items-sub-id) sub\_id string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/reports/get-sub_ids-report-for-current-promoter#response-items-id) id string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/reports/get-sub_ids-report-for-current-promoter#response-items-data) data object Show child attributes [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/reports/get-sub_ids-report-for-current-promoter#response-items-data-clicks-count) data.clicks\_count integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/reports/get-sub_ids-report-for-current-promoter#response-items-data-revenue-amount) data.revenue\_amount number [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/reports/get-sub_ids-report-for-current-promoter#response-items-data-promoter-earnings-amount) data.promoter\_earnings\_amount number [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/reports/get-sub_ids-report-for-current-promoter#response-items-data-referrals-count) data.referrals\_count integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/reports/get-sub_ids-report-for-current-promoter#response-items-data-customers-count) data.customers\_count integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/reports/get-sub_ids-report-for-current-promoter#response-items-data-sales-count) data.sales\_count integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/reports/get-sub_ids-report-for-current-promoter#response-items-data-refunds-count) data.refunds\_count integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/reports/get-sub_ids-report-for-current-promoter#response-items-data-cancelled-customers-count) data.cancelled\_customers\_count integer [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/reports/get-sub_ids-report-for-current-promoter#response-items-data-referrals-to-customers-cr) data.referrals\_to\_customers\_cr number [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/reports/get-sub_ids-report-for-current-promoter#response-items-data-clicks-to-customers-cr) data.clicks\_to\_customers\_cr number [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/reports/get-sub_ids-report-for-current-promoter#response-items-data-clicks-to-referrals-cr) data.clicks\_to\_referrals\_cr number [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/reports/get-sub_ids-report-for-current-promoter#response-items-sub-data) sub\_data object\[\] Show child attributes [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/reports/get-sub_ids-report-for-current-promoter#response-items-sub-data-items-period) sub\_data.period string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/reports/get-sub_ids-report-for-current-promoter#response-items-sub-data-items-id) sub\_data.id string [​](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/reports/get-sub_ids-report-for-current-promoter#response-items-sub-data-items-data) sub\_data.data any [Get campaigns reports for current promoter](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/reports/get-campaigns-reports-for-current-promoter) [Download reports](https://docs.firstpromoter.com/api-reference-v2/api-affiliate/reports/download-reports) ⌘I --- # Calendly - FirstPromoter Docs [Skip to main content](https://docs.firstpromoter.com/integrations/tracking/platform/calendly#content-area) [FirstPromoter Docs home page![light logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/light.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=6ded212b82547bec37a22e90f72eeb71)![dark logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/dark.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=c393ff83772047b8a444f78a1e393e7f)](https://docs.firstpromoter.com/) v2 Search... ⌘K Search... Navigation Platform Calendly [Documentation](https://docs.firstpromoter.com/introduction) [API Reference](https://docs.firstpromoter.com/api-reference-v2/api-admin/introduction) `Difficulty: Easy` `Developer Required: No` With FirstPromoter, you can setup click and signup/referral tracking using our calendly integration option. This integration is for users who have custom websites and have Calendly added. Click [here](https://login.firstpromoter.com/?redirect=%2Finstructions%2Fcalendly) to view the guide. [DropFunnels](https://docs.firstpromoter.com/integrations/tracking/platform/dropfunnels) [Kickpages](https://docs.firstpromoter.com/integrations/tracking/platform/kickpages) ⌘I --- # ClickFunnels - FirstPromoter Docs [Skip to main content](https://docs.firstpromoter.com/integrations/tracking/platform/clickfunnels#content-area) [FirstPromoter Docs home page![light logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/light.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=6ded212b82547bec37a22e90f72eeb71)![dark logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/dark.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=c393ff83772047b8a444f78a1e393e7f)](https://docs.firstpromoter.com/) v2 Search... ⌘K Search... Navigation Platform ClickFunnels [Documentation](https://docs.firstpromoter.com/introduction) [API Reference](https://docs.firstpromoter.com/api-reference-v2/api-admin/introduction) `Difficulty: Easy` `Developer Required: No` With FirstPromoter, you can setup click and signup tracking using our ClickFunnels integration option. This setup mainly requires you to add/insert our ready made scripts into your ClickFunnels website. Click [here](https://login.firstpromoter.com/?redirect=%2Finstructions%2Fclickfunnels) to view the guide. [Highlevel](https://docs.firstpromoter.com/integrations/tracking/platform/highlevel) [Payment Links](https://docs.firstpromoter.com/integrations/tracking/platform/stripe/payment-links) ⌘I --- # DropFunnels - FirstPromoter Docs [Skip to main content](https://docs.firstpromoter.com/integrations/tracking/platform/dropfunnels#content-area) [FirstPromoter Docs home page![light logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/light.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=6ded212b82547bec37a22e90f72eeb71)![dark logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/dark.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=c393ff83772047b8a444f78a1e393e7f)](https://docs.firstpromoter.com/) v2 Search... ⌘K Search... Navigation Platform DropFunnels [Documentation](https://docs.firstpromoter.com/introduction) [API Reference](https://docs.firstpromoter.com/api-reference-v2/api-admin/introduction) `Difficulty: Easy` `Developer Required: No` With FirstPromoter, you can setup click and signup tracking using our DropFunnels integration option. This setup mainly requires you to add/insert our ready made scripts into your DropFunnels website platform. Click [here](https://login.firstpromoter.com/?redirect=%2Finstructions%2Fdropfunnels) to view the guide. [Kartra](https://docs.firstpromoter.com/integrations/tracking/platform/kartra) [Calendly](https://docs.firstpromoter.com/integrations/tracking/platform/calendly) ⌘I --- # Drop-in Scripts - FirstPromoter Docs [Skip to main content](https://docs.firstpromoter.com/integrations/tracking/platform/chargebee/drop-in-scripts#content-area) [FirstPromoter Docs home page![light logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/light.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=6ded212b82547bec37a22e90f72eeb71)![dark logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/dark.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=c393ff83772047b8a444f78a1e393e7f)](https://docs.firstpromoter.com/) v2 Search... ⌘K Search... Navigation Chargebee Drop-in Scripts [Documentation](https://docs.firstpromoter.com/introduction) [API Reference](https://docs.firstpromoter.com/api-reference-v2/api-admin/introduction) `Difficulty: Easy` `Developer Required: No` With FirstPromoter, you can setup click and signup tracking using our `Chargebee Drop-in Scripts` integration option. This setup mainly requires you to add/insert our ready made scripts into your website. Click [here](https://login.firstpromoter.com/?redirect=%2Finstructions%2Fchargebee-drop-in-script) to view the guide. [Thinkific](https://docs.firstpromoter.com/integrations/tracking/platform/thinkific) [Hosted Pages](https://docs.firstpromoter.com/integrations/tracking/platform/chargebee/hosted-pages) ⌘I --- # Ghost - FirstPromoter Docs [Skip to main content](https://docs.firstpromoter.com/integrations/tracking/platform/ghost#content-area) [FirstPromoter Docs home page![light logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/light.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=6ded212b82547bec37a22e90f72eeb71)![dark logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/dark.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=c393ff83772047b8a444f78a1e393e7f)](https://docs.firstpromoter.com/) v2 Search... ⌘K Search... Navigation Platform Ghost [Documentation](https://docs.firstpromoter.com/introduction) [API Reference](https://docs.firstpromoter.com/api-reference-v2/api-admin/introduction) `Difficulty: Easy` `Developer Required: No` The integration between FirstPromoter and Ghost is fully automated and does not require any additional scripts to be added. Click [here](https://login.firstpromoter.com/?redirect=%2Finstructions%2Fghost) to view the guide. [Pricing Table](https://docs.firstpromoter.com/integrations/tracking/platform/stripe/pricing-table) [Kajabi](https://docs.firstpromoter.com/integrations/tracking/platform/kajabi) ⌘I --- # Highlevel - FirstPromoter Docs [Skip to main content](https://docs.firstpromoter.com/integrations/tracking/platform/highlevel#content-area) [FirstPromoter Docs home page![light logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/light.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=6ded212b82547bec37a22e90f72eeb71)![dark logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/dark.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=c393ff83772047b8a444f78a1e393e7f)](https://docs.firstpromoter.com/) v2 Search... ⌘K Search... Navigation Platform Highlevel [Documentation](https://docs.firstpromoter.com/introduction) [API Reference](https://docs.firstpromoter.com/api-reference-v2/api-admin/introduction) `Difficulty: Easy` `Developer Required: No` With FirstPromoter, you can setup click and signup tracking using our Highlevel integration option. This setup mainly requires you to add/insert our ready made scripts into your Highlevel website. Click [here](https://login.firstpromoter.com/?redirect=%2Finstructions%2Fhighlevel) [API](https://docs.firstpromoter.com/integrations/billing/api) [ClickFunnels](https://docs.firstpromoter.com/integrations/tracking/platform/clickfunnels) ⌘I --- # Kartra - FirstPromoter Docs [Skip to main content](https://docs.firstpromoter.com/integrations/tracking/platform/kartra#content-area) [FirstPromoter Docs home page![light logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/light.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=6ded212b82547bec37a22e90f72eeb71)![dark logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/dark.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=c393ff83772047b8a444f78a1e393e7f)](https://docs.firstpromoter.com/) v2 Search... ⌘K Search... Navigation Platform Kartra [Documentation](https://docs.firstpromoter.com/introduction) [API Reference](https://docs.firstpromoter.com/api-reference-v2/api-admin/introduction) `Difficulty: Easy` `Developer Required: No` With FirstPromoter, you can setup click and signup tracking using our Kartra integration option. This setup mainly requires you to add/insert our ready made scripts into your Kartra website platform. Click [here](https://login.firstpromoter.com/?redirect=%2Finstructions%2Fkartra) to view the guide. [Samcart](https://docs.firstpromoter.com/integrations/tracking/platform/samcart) [DropFunnels](https://docs.firstpromoter.com/integrations/tracking/platform/dropfunnels) ⌘I --- # Samcart - FirstPromoter Docs [Skip to main content](https://docs.firstpromoter.com/integrations/tracking/platform/samcart#content-area) [FirstPromoter Docs home page![light logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/light.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=6ded212b82547bec37a22e90f72eeb71)![dark logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/dark.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=c393ff83772047b8a444f78a1e393e7f)](https://docs.firstpromoter.com/) v2 Search... ⌘K Search... Navigation Platform Samcart [Documentation](https://docs.firstpromoter.com/introduction) [API Reference](https://docs.firstpromoter.com/api-reference-v2/api-admin/introduction) `Difficulty: Easy` `Developer Required: No` With FirstPromoter, you can setup click and signup tracking using our Samcart integration option. This setup mainly requires you to add/insert our ready made scripts into your Samcart website platform. Click [here](https://login.firstpromoter.com/?redirect=%2Finstructions%2Fsamcart) to view the guide. [ThriveCart](https://docs.firstpromoter.com/integrations/tracking/platform/thrivecart) [Kartra](https://docs.firstpromoter.com/integrations/tracking/platform/kartra) ⌘I --- # Concepts & Key Terminologies - FirstPromoter Docs [Skip to main content](https://docs.firstpromoter.com/script-docs/concepts#content-area) [FirstPromoter Docs home page![light logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/light.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=6ded212b82547bec37a22e90f72eeb71)![dark logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/dark.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=c393ff83772047b8a444f78a1e393e7f)](https://docs.firstpromoter.com/) v2 Search... ⌘K Search... Navigation Scripts Concepts & Key Terminologies [Documentation](https://docs.firstpromoter.com/introduction) [API Reference](https://docs.firstpromoter.com/api-reference-v2/api-admin/introduction) On this page * [Promoter](https://docs.firstpromoter.com/script-docs/concepts#promoter) * [Clicks](https://docs.firstpromoter.com/script-docs/concepts#clicks) * [Referral](https://docs.firstpromoter.com/script-docs/concepts#referral) * [Lead](https://docs.firstpromoter.com/script-docs/concepts#lead) * [Customer](https://docs.firstpromoter.com/script-docs/concepts#customer) * [Sale](https://docs.firstpromoter.com/script-docs/concepts#sale) * [Referral Tracking](https://docs.firstpromoter.com/script-docs/concepts#referral-tracking) * [Sale Tracking](https://docs.firstpromoter.com/script-docs/concepts#sale-tracking) * [ref\_id](https://docs.firstpromoter.com/script-docs/concepts#ref-id) * [tid](https://docs.firstpromoter.com/script-docs/concepts#tid) [​](https://docs.firstpromoter.com/script-docs/concepts#promoter) Promoter ----------------------------------------------------------------------------- Promoters/Affiliates are individuals or companies who drive traffic to a company’s website, products, or services through referral links and earn a commission when that traffic converts. [​](https://docs.firstpromoter.com/script-docs/concepts#clicks) Clicks ------------------------------------------------------------------------- Clicks are the number of unique visits to your website via the referral link. **NB:** The user’s first click on your website via the referral link is what is counted. [​](https://docs.firstpromoter.com/script-docs/concepts#referral) Referral ----------------------------------------------------------------------------- A referral is an individual or business that signs up for or purchases a service using a referral link. A referral can either be a lead or a customer. [​](https://docs.firstpromoter.com/script-docs/concepts#lead) Lead --------------------------------------------------------------------- A lead is an individual or business that signs up on your website using a referral link but hasn’t purchased from your website. [​](https://docs.firstpromoter.com/script-docs/concepts#customer) Customer ----------------------------------------------------------------------------- A customer is an individual or business that signed up on your website using a referral link and has made at least one purchase from your website. [​](https://docs.firstpromoter.com/script-docs/concepts#sale) Sale --------------------------------------------------------------------- A sale occurs when a customer makes a purchase using a referral link. We generate rewards or commissions only for sales. [​](https://docs.firstpromoter.com/script-docs/concepts#referral-tracking) Referral Tracking ----------------------------------------------------------------------------------------------- This refers to when the referral details (email address/UID) are sent to FirstPromoter from your website after they sign up or fill out a form. This can be done using the referral tracking script or API. [​](https://docs.firstpromoter.com/script-docs/concepts#sale-tracking) Sale Tracking --------------------------------------------------------------------------------------- This refers to when payments are tracked from your billing provider, allowing commissions to be generated for your affiliates. [​](https://docs.firstpromoter.com/script-docs/concepts#ref-id) ref\_id -------------------------------------------------------------------------- This is the referral id/token assigned to an affiliate/promoter once they signup or are added to a campaign. It is generated by FirstPromoter by default and can be set using our API as well. If a referral link is used it is set as a cookie `_fprom_ref` in your browser [​](https://docs.firstpromoter.com/script-docs/concepts#tid) tid ------------------------------------------------------------------- This is a tracking ID that is dynamically generated by FirstPromoter when someone visits a referral link. This ID is set as a cookie called `_fprom_tid` in your browser. [Advanced use cases & examples](https://docs.firstpromoter.com/script-docs/advanced) [Stripe](https://docs.firstpromoter.com/integrations/billing/stripe) ⌘I --- # Hosted Pages - FirstPromoter Docs [Skip to main content](https://docs.firstpromoter.com/integrations/tracking/platform/chargebee/hosted-pages#content-area) [FirstPromoter Docs home page![light logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/light.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=6ded212b82547bec37a22e90f72eeb71)![dark logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/dark.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=c393ff83772047b8a444f78a1e393e7f)](https://docs.firstpromoter.com/) v2 Search... ⌘K Search... Navigation Chargebee Hosted Pages [Documentation](https://docs.firstpromoter.com/introduction) [API Reference](https://docs.firstpromoter.com/api-reference-v2/api-admin/introduction) `Difficulty: Easy` `Developer Required: No` With FirstPromoter, you can setup click and signup tracking using our `Chargebee Hosted Pages` integration option. This setup mainly requires you to add/insert our ready made scripts into your website. Click [here](https://login.firstpromoter.com/?redirect=%2Finstructions%2Fchargebee-hosted-pages) to view the guide. [Drop-in Scripts](https://docs.firstpromoter.com/integrations/tracking/platform/chargebee/drop-in-scripts) [JavaScript Tracking](https://docs.firstpromoter.com/integrations/tracking/custom/js) ⌘I --- # Kickpages - FirstPromoter Docs [Skip to main content](https://docs.firstpromoter.com/integrations/tracking/platform/kickpages#content-area) [FirstPromoter Docs home page![light logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/light.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=6ded212b82547bec37a22e90f72eeb71)![dark logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/dark.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=c393ff83772047b8a444f78a1e393e7f)](https://docs.firstpromoter.com/) v2 Search... ⌘K Search... Navigation Platform Kickpages [Documentation](https://docs.firstpromoter.com/introduction) [API Reference](https://docs.firstpromoter.com/api-reference-v2/api-admin/introduction) `Difficulty: Easy` `Developer Required: No` With FirstPromoter, you can setup click and signup tracking using our Kickpages integration option. This setup mainly requires you to add/insert our ready made scripts into your Kickpages website platform. Click [here](https://login.firstpromoter.com/?redirect=%2Finstructions%2Fkickpages) to view the guide. [Calendly](https://docs.firstpromoter.com/integrations/tracking/platform/calendly) [Thinkific](https://docs.firstpromoter.com/integrations/tracking/platform/thinkific) ⌘I --- # ThriveCart - FirstPromoter Docs [Skip to main content](https://docs.firstpromoter.com/integrations/tracking/platform/thrivecart#content-area) [FirstPromoter Docs home page![light logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/light.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=6ded212b82547bec37a22e90f72eeb71)![dark logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/dark.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=c393ff83772047b8a444f78a1e393e7f)](https://docs.firstpromoter.com/) v2 Search... ⌘K Search... Navigation Platform ThriveCart [Documentation](https://docs.firstpromoter.com/introduction) [API Reference](https://docs.firstpromoter.com/api-reference-v2/api-admin/introduction) `Difficulty: Easy` `Developer Required: No` With FirstPromoter, you can setup click and signup tracking using our ThriveCart integration option. This setup mainly requires you to add/insert our ready made scripts into your ThriveCart website platform. Click [here](https://login.firstpromoter.com/?redirect=%2Finstructions%2Fthrivecart) to view the guide. [Kajabi](https://docs.firstpromoter.com/integrations/tracking/platform/kajabi) [Samcart](https://docs.firstpromoter.com/integrations/tracking/platform/samcart) ⌘I --- # Thinkific - FirstPromoter Docs [Skip to main content](https://docs.firstpromoter.com/integrations/tracking/platform/thinkific#content-area) [FirstPromoter Docs home page![light logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/light.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=6ded212b82547bec37a22e90f72eeb71)![dark logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/dark.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=c393ff83772047b8a444f78a1e393e7f)](https://docs.firstpromoter.com/) v2 Search... ⌘K Search... Navigation Platform Thinkific [Documentation](https://docs.firstpromoter.com/introduction) [API Reference](https://docs.firstpromoter.com/api-reference-v2/api-admin/introduction) `Difficulty: Easy` `Developer Required: No` With FirstPromoter, you can setup click and signup tracking using our Thinkific integration option. This setup mainly requires you to add/insert our ready made scripts into your Thinkific website platform. Click [here](https://login.firstpromoter.com/?redirect=%2Finstructions%2Fthinkific) to view the guide. [Kickpages](https://docs.firstpromoter.com/integrations/tracking/platform/kickpages) [Drop-in Scripts](https://docs.firstpromoter.com/integrations/tracking/platform/chargebee/drop-in-scripts) ⌘I --- # Kajabi - FirstPromoter Docs [Skip to main content](https://docs.firstpromoter.com/integrations/tracking/platform/kajabi#content-area) [FirstPromoter Docs home page![light logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/light.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=6ded212b82547bec37a22e90f72eeb71)![dark logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/dark.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=c393ff83772047b8a444f78a1e393e7f)](https://docs.firstpromoter.com/) v2 Search... ⌘K Search... Navigation Platform Kajabi [Documentation](https://docs.firstpromoter.com/introduction) [API Reference](https://docs.firstpromoter.com/api-reference-v2/api-admin/introduction) `Difficulty: Easy` `Developer Required: No` With FirstPromoter, you can setup click and signup tracking using our Kajabi integration option. This setup mainly requires you to add/insert our ready made scripts into your Kajabi website platform. Click [here](https://login.firstpromoter.com/?redirect=%2Finstructions%2Fkajabi) to view the guide. [Ghost](https://docs.firstpromoter.com/integrations/tracking/platform/ghost) [ThriveCart](https://docs.firstpromoter.com/integrations/tracking/platform/thrivecart) ⌘I --- # Pricing Table - FirstPromoter Docs [Skip to main content](https://docs.firstpromoter.com/integrations/tracking/platform/stripe/pricing-table#content-area) [FirstPromoter Docs home page![light logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/light.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=6ded212b82547bec37a22e90f72eeb71)![dark logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/dark.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=c393ff83772047b8a444f78a1e393e7f)](https://docs.firstpromoter.com/) v2 Search... ⌘K Search... Navigation Stripe Pricing Table [Documentation](https://docs.firstpromoter.com/introduction) [API Reference](https://docs.firstpromoter.com/api-reference-v2/api-admin/introduction) `Difficulty: Easy` `Developer Required: No` With FirstPromoter, you can setup click and signup/referral tracking using our `Stripe Pricing Table` integration option. This setup mainly requires you to add/insert our ready made scripts into your website pages where you have `` html tag. To get the best results for tracking when using Stripe pricing tables, add the scripts to all pages where `` html tags are available. Click [here](https://login.firstpromoter.com/?redirect=%2Finstructions%2Fstripe-pricing-table) to view the guide. [Payment Links](https://docs.firstpromoter.com/integrations/tracking/platform/stripe/payment-links) [Ghost](https://docs.firstpromoter.com/integrations/tracking/platform/ghost) ⌘I --- # Payment Links - FirstPromoter Docs [Skip to main content](https://docs.firstpromoter.com/integrations/tracking/platform/stripe/payment-links#content-area) [FirstPromoter Docs home page![light logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/light.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=6ded212b82547bec37a22e90f72eeb71)![dark logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/dark.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=c393ff83772047b8a444f78a1e393e7f)](https://docs.firstpromoter.com/) v2 Search... ⌘K Search... Navigation Stripe Payment Links [Documentation](https://docs.firstpromoter.com/introduction) [API Reference](https://docs.firstpromoter.com/api-reference-v2/api-admin/introduction) `Difficulty: Easy` `Developer Required: No` With FirstPromoter, you can setup click and signup/referral tracking using our `Stripe Payment Links` integration option. This setup mainly requires you to add/insert our ready made scripts into your website pages where you have buy/payment checkout links such as `https://buy.stripe.com/xxxxx` NB: If you are using your custom domain with stripe, you will need to change the link in the code that will be provided in your FirstPromoter dashboard from `https://buy.stripe.com/` to your checkout page’s custom domain. Click [here](https://login.firstpromoter.com/?redirect=%2Finstructions%2Fstripe-payment-links) to view the guide. [ClickFunnels](https://docs.firstpromoter.com/integrations/tracking/platform/clickfunnels) [Pricing Table](https://docs.firstpromoter.com/integrations/tracking/platform/stripe/pricing-table) ⌘I --- # Quickstart - FirstPromoter Docs [Skip to main content](https://docs.firstpromoter.com/quickstart#content-area) [FirstPromoter Docs home page![light logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/light.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=6ded212b82547bec37a22e90f72eeb71)![dark logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/dark.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=c393ff83772047b8a444f78a1e393e7f)](https://docs.firstpromoter.com/) v2 Search... ⌘K Search... Navigation Overview Quickstart [Documentation](https://docs.firstpromoter.com/introduction) [API Reference](https://docs.firstpromoter.com/api-reference-v2/api-admin/introduction) On this page * [Steps](https://docs.firstpromoter.com/quickstart#steps) ### [​](https://docs.firstpromoter.com/quickstart#steps) Steps 1 Create an account [Click here](https://new.firstpromoter.com/company/signup) to create an Admin account. If you already have an account, [Login here](https://login.firstpromoter.com/) If you are a new user, you will need to complete the onboarding process, which involves creating a campaign, connecting your billing provider, and integrating your website. 2 Integrate your billing provider Connect your billing provider to FirstPromoter. This will enable FirstPromoter to automatically track sales, refunds, upgrades or upsells and cancellations data/record from any of the [supported billing providers](https://docs.firstpromoter.com/integrations/billing) . **NB:** For a billing provider that is not supported by default, there is an option to use our [API](https://docs.firstpromoter.com/integrations/billing/api) 3 Integrate your website Install or add our ready-made scripts/pixels to your website or [platform](https://docs.firstpromoter.com/integrations/tracking/platform) . We also provide [universal scripts and an API for custom built websites or apps](https://docs.firstpromoter.com/integrations/tracking/custom) . Integrating the tracking script into your website enables you to track clicks and referrals (thus, it allows you to send the lead’s or referral’s details such as the `email` or `uid` to FirstPromoter). When combined with the billing provider integration, this setup enables FirstPromoter to track sales by linking referral information with transaction data from your billing provider.[Learn more about our tracking script here](https://docs.firstpromoter.com/script-docs/fpr-js-docs) You can also track sales using `Coupon Codes`. This option is available for users who want `No-Code` or `No-Scripts` integration or want an alternative to traditional referral links . [Learn more](https://help.firstpromoter.com/en/articles/8971002-how-to-track-sales-with-coupon-codes-in-firstpromoter) 4 Test your integrations Test all parts of your integration to make sure everything is tracking. * Clicks tracking * Referral tracking * Sales tracking [How FirstPromoter works](https://docs.firstpromoter.com/how-it-works) [Tracking with fpr.js](https://docs.firstpromoter.com/guides/tracking-with-fprjs) ⌘I --- # FirstPromoter JavaScript Library (fpr.js) - FirstPromoter Docs [Skip to main content](https://docs.firstpromoter.com/script-docs/fpr-js-docs#content-area) [FirstPromoter Docs home page![light logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/light.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=6ded212b82547bec37a22e90f72eeb71)![dark logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/dark.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=c393ff83772047b8a444f78a1e393e7f)](https://docs.firstpromoter.com/) v2 Search... ⌘K Search... Navigation Scripts FirstPromoter JavaScript Library (fpr.js) [Documentation](https://docs.firstpromoter.com/introduction) [API Reference](https://docs.firstpromoter.com/api-reference-v2/api-admin/introduction) On this page * [Including fpr.js](https://docs.firstpromoter.com/script-docs/fpr-js-docs#including-fpr-js) * [Functions](https://docs.firstpromoter.com/script-docs/fpr-js-docs#functions) * [fpr(“init”,options, callback?)](https://docs.firstpromoter.com/script-docs/fpr-js-docs#fpr-%E2%80%9Cinit%E2%80%9D%2Coptions%2C-callback) * [Parameters](https://docs.firstpromoter.com/script-docs/fpr-js-docs#parameters) * [Available keys](https://docs.firstpromoter.com/script-docs/fpr-js-docs#available-keys) * [fpr(“click”,payload?, callback?)](https://docs.firstpromoter.com/script-docs/fpr-js-docs#fpr-%E2%80%9Cclick%E2%80%9D%2Cpayload%2C-callback) * [Parameters](https://docs.firstpromoter.com/script-docs/fpr-js-docs#parameters-2) * [Available keys](https://docs.firstpromoter.com/script-docs/fpr-js-docs#available-keys-2) * [Example](https://docs.firstpromoter.com/script-docs/fpr-js-docs#example) * [fpr(“onReady”,callback)](https://docs.firstpromoter.com/script-docs/fpr-js-docs#fpr-%E2%80%9Conready%E2%80%9D%2Ccallback) * [Parameters](https://docs.firstpromoter.com/script-docs/fpr-js-docs#parameters-3) * [Example](https://docs.firstpromoter.com/script-docs/fpr-js-docs#example-2) * [fpr(“referral”,payload, callback?)](https://docs.firstpromoter.com/script-docs/fpr-js-docs#fpr-%E2%80%9Creferral%E2%80%9D%2Cpayload%2C-callback) * [Parameters](https://docs.firstpromoter.com/script-docs/fpr-js-docs#parameters-4) * [Available keys](https://docs.firstpromoter.com/script-docs/fpr-js-docs#available-keys-3) * [Example](https://docs.firstpromoter.com/script-docs/fpr-js-docs#example-3) * [fpr(“details”,callback)](https://docs.firstpromoter.com/script-docs/fpr-js-docs#fpr-%E2%80%9Cdetails%E2%80%9D%2Ccallback) * [Parameters](https://docs.firstpromoter.com/script-docs/fpr-js-docs#parameters-5) * [Response Format](https://docs.firstpromoter.com/script-docs/fpr-js-docs#response-format) * [Example](https://docs.firstpromoter.com/script-docs/fpr-js-docs#example-4) * [fpr(“crossDomain”,domains)](https://docs.firstpromoter.com/script-docs/fpr-js-docs#fpr-%E2%80%9Ccrossdomain%E2%80%9D%2Cdomains) * [Example](https://docs.firstpromoter.com/script-docs/fpr-js-docs#example-5) * [fpr(“urlTracking”)](https://docs.firstpromoter.com/script-docs/fpr-js-docs#fpr-%E2%80%9Curltracking%E2%80%9D) [​](https://docs.firstpromoter.com/script-docs/fpr-js-docs#including-fpr-js) Including fpr.js ================================================================================================ On your FirstPromoter dashboard, under the Settings> Integrations> Integrate your website section, based on the selections you make, you are provided with some scripts which are to be added to your website. It is ideal that the script is added globally on the HEAD section of every marketing or public page of your website. Copy For JavaScript frameworks, you can simply insert the script on the public index.html page so it will be available when the framework loads. For WordPress websites, you can add the scripts to your header.php file before the closing head tag. To get the best performance, it is ideal that you have the scripts added to all the pages where you need tracking to take place. Also, the Scripts are loaded asynchronously and will not affect the website loading speed. [​](https://docs.firstpromoter.com/script-docs/fpr-js-docs#functions) Functions ================================================================================== [​](https://docs.firstpromoter.com/script-docs/fpr-js-docs#fpr-%E2%80%9Cinit%E2%80%9D,options,-callback) fpr(“init”,options, callback?) ------------------------------------------------------------------------------------------------------------------------------------------ This method helps initializes FirstPromoter with the provided options. Most of these options are loaded automatically when the script loads, but they can be overwritten by passing different ones to the method. The most used one is “ref\_id” which forces the script to track a specific promoter. ### [​](https://docs.firstpromoter.com/script-docs/fpr-js-docs#parameters) Parameters [​](https://docs.firstpromoter.com/script-docs/fpr-js-docs#param-options) options object required #### [​](https://docs.firstpromoter.com/script-docs/fpr-js-docs#available-keys) Available keys | Property | Description | | --- | --- | | cid | FirstPromoter Company Id (required) | | ref\_id | Referral id/token of the promoter | | tid | Tracking ID, value stored in fprom\_tid cookie | | url | Current URL | | domain | Current domain | | referrer | Browser referrer/ domain of the previous visited website | Setting properties that are not in the list above will be ignored. [​](https://docs.firstpromoter.com/script-docs/fpr-js-docs#param-callback) callback function A function that will be called after the init function is triggered. [​](https://docs.firstpromoter.com/script-docs/fpr-js-docs#fpr-%E2%80%9Cclick%E2%80%9D,payload,-callback) fpr(“click”,payload?, callback?) --------------------------------------------------------------------------------------------------------------------------------------------- This method is responsible for click tracking. ### [​](https://docs.firstpromoter.com/script-docs/fpr-js-docs#parameters-2) Parameters [​](https://docs.firstpromoter.com/script-docs/fpr-js-docs#param-payload) payload object This overwrites the stored data exactly like the fpr(“init”…) function does before tracking the click. #### [​](https://docs.firstpromoter.com/script-docs/fpr-js-docs#available-keys-2) Available keys | Property | Description | | --- | --- | | cid | FirstPromoter Company Id | | ref\_id | Referral id/token of the promoter | | tid | Tracking ID, value stored in fprom\_tid cookie | | url | Current URL | | domain | Current domain | | referrer | Browser referrer/ domain of the previous visited website | Setting properties that are not in the list above will be ignored. [​](https://docs.firstpromoter.com/script-docs/fpr-js-docs#param-callback-1) callback function The callback function receives the response data object and can then be extracted and use ### [​](https://docs.firstpromoter.com/script-docs/fpr-js-docs#example) Example click click\_with\_referral\_id Copy fpr("click") * * * [​](https://docs.firstpromoter.com/script-docs/fpr-js-docs#fpr-%E2%80%9Conready%E2%80%9D,callback) fpr(“onReady”,callback) ----------------------------------------------------------------------------------------------------------------------------- This method checks if the tracking script is initialized and fully loaded on the page. ### [​](https://docs.firstpromoter.com/script-docs/fpr-js-docs#parameters-3) Parameters [​](https://docs.firstpromoter.com/script-docs/fpr-js-docs#param-callback-2) callback function The callback function receives the response data object and can then be extracted and use ### [​](https://docs.firstpromoter.com/script-docs/fpr-js-docs#example-2) Example click Copy fpr("onReady", function(data){ console.log(data) }) * * * [​](https://docs.firstpromoter.com/script-docs/fpr-js-docs#fpr-%E2%80%9Creferral%E2%80%9D,payload,-callback) fpr(“referral”,payload, callback?) -------------------------------------------------------------------------------------------------------------------------------------------------- This method is used primarily to send the referral details to FirstPromoter. It takes as its payload the email of the referral/lead ### [​](https://docs.firstpromoter.com/script-docs/fpr-js-docs#parameters-4) Parameters [​](https://docs.firstpromoter.com/script-docs/fpr-js-docs#param-payload-1) payload object required The callback function receives the response data object and can then be extracted and use #### [​](https://docs.firstpromoter.com/script-docs/fpr-js-docs#available-keys-3) Available keys | Property | Description | | --- | --- | | email | actual email of the user | | uid | user id of the user | Setting properties that are not in the list above will be ignored. ### [​](https://docs.firstpromoter.com/script-docs/fpr-js-docs#example-3) Example referral referral\_with\_callback Copy fpr('referral',{email:actual_user_email@email.com, uid: 123456}) * * * [​](https://docs.firstpromoter.com/script-docs/fpr-js-docs#fpr-%E2%80%9Cdetails%E2%80%9D,callback) fpr(“details”,callback) ----------------------------------------------------------------------------------------------------------------------------- This method is used in getting the details of the promotion and the promoter. **To avoid making multiple requests, it is important to note that the details are stored in a cookie called “fprom\_details” and is available for a day.** ### [​](https://docs.firstpromoter.com/script-docs/fpr-js-docs#parameters-5) Parameters [​](https://docs.firstpromoter.com/script-docs/fpr-js-docs#param-callback-3) callback function The callback function receives the response data object and can then be extracted and use ### [​](https://docs.firstpromoter.com/script-docs/fpr-js-docs#response-format) Response Format Copy { ref_id: promo_code: campaign_id: customer_promo_code: offer: promoter: { id: first_name: last_name: } } ### [​](https://docs.firstpromoter.com/script-docs/fpr-js-docs#example-4) Example click Copy fpr("details", function(data){ console.log(data) }) * * * [​](https://docs.firstpromoter.com/script-docs/fpr-js-docs#fpr-%E2%80%9Ccrossdomain%E2%80%9D,domains) fpr(“crossDomain”,domains) ----------------------------------------------------------------------------------------------------------------------------------- This method is used when attempting to track across multiple domains. It mainly appends the tracking details to all links to the domain provided. Note: this works with only direct links and should be added preferably to the footer section or called when the whole page is loaded [​](https://docs.firstpromoter.com/script-docs/fpr-js-docs#param-domains) domains string|array The crossDomain(s) you want to track ### [​](https://docs.firstpromoter.com/script-docs/fpr-js-docs#example-5) Example one domain multiple domains Copy fpr('crossDomain','newwebsite.com') [​](https://docs.firstpromoter.com/script-docs/fpr-js-docs#fpr-%E2%80%9Curltracking%E2%80%9D) fpr(“urlTracking”) ------------------------------------------------------------------------------------------------------------------- This method is used for Direct URL tracking, thus, if you have landing pages for your affiliates/promoters, you can use the method on those pages if you don’t want the affiliates/promoters “Referral ID” to be part of their referral links. For this method to work, you will have to first add FirstPromoter’s main tracking scripts to the landing page(s) and also enable “Direct URL tracking” on FirstPromoter. To do so, please check out this article: [How to enable direct URL tracking in FirstPromoter](https://help.firstpromoter.com/en/articles/8971394-how-to-enable-direct-url-tracking-in-firstpromoter) Please note that the method **should not** be used on your homepage, but instead should only be used on all landing pages of your affiliates/promoters. Copy [Proxy Setup (Optional)](https://docs.firstpromoter.com/guides/proxy-setup) [Advanced use cases & examples](https://docs.firstpromoter.com/script-docs/advanced) ⌘I --- # Overview - FirstPromoter Docs [Skip to main content](https://docs.firstpromoter.com/webhooks/overview#content-area) [FirstPromoter Docs home page![light logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/light.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=6ded212b82547bec37a22e90f72eeb71)![dark logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/dark.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=c393ff83772047b8a444f78a1e393e7f)](https://docs.firstpromoter.com/) v2 Search... ⌘K Search... Navigation Webhooks Overview [Documentation](https://docs.firstpromoter.com/introduction) [API Reference](https://docs.firstpromoter.com/api-reference-v2/api-admin/introduction) On this page * [Receive FirstPromoter events in your webhook endpoint](https://docs.firstpromoter.com/webhooks/overview#receive-firstpromoter-events-in-your-webhook-endpoint) * [Why webhooks](https://docs.firstpromoter.com/webhooks/overview#why-webhooks) * [How to set it up](https://docs.firstpromoter.com/webhooks/overview#how-to-set-it-up) * [Availible webhook events](https://docs.firstpromoter.com/webhooks/overview#availible-webhook-events) [​](https://docs.firstpromoter.com/webhooks/overview#receive-firstpromoter-events-in-your-webhook-endpoint) Receive FirstPromoter events in your webhook endpoint ==================================================================================================================================================================== Listen to events in your FirstPromoter account on your webhook endpoint so you can use them in your app. [​](https://docs.firstpromoter.com/webhooks/overview#why-webhooks) Why webhooks ---------------------------------------------------------------------------------- After setting up your FirstPromoter account, you may want to receive events from FirstPromoter in order to trigger an action or automate a process in your application. Webhooks allow you to do this. To receive webhook events, you need to have an endpoint in your application that will accept the event. If you are using a tool like [Zapier](https://zapier.com/) , [Albato](https://albato.com/apps/firstpromoter) or [Make](https://www.make.com/en/integrations/firstpromoter) they provide these endpoints when creating an automation flow. After you add the webhook to FirstPromoter, it can push real-time event data to your endpoint when events occur in your FirstPromoter account. [​](https://docs.firstpromoter.com/webhooks/overview#how-to-set-it-up) How to set it up ------------------------------------------------------------------------------------------ Navigate to your Settings page > Select Integrations> Scroll down to the webhooks section. You can also click [here](https://docs.firstpromoter.com/webhooks/'https://login.firstpromoter.com?redirect=%settings%2Fintegrations%27) to go there directly. [​](https://docs.firstpromoter.com/webhooks/overview#availible-webhook-events) Availible webhook events ---------------------------------------------------------------------------------------------------------- * Lead Signup * Promoter Accepted * Reward Created * New customer * Fulfilment Pending [Google Tag Manager](https://docs.firstpromoter.com/integrations/tracking/custom/gtm) [Lead Signup](https://docs.firstpromoter.com/webhooks/lead-signup) ⌘I --- # Advanced use cases & examples - FirstPromoter Docs [Skip to main content](https://docs.firstpromoter.com/script-docs/advanced#content-area) [FirstPromoter Docs home page![light logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/light.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=6ded212b82547bec37a22e90f72eeb71)![dark logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/dark.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=c393ff83772047b8a444f78a1e393e7f)](https://docs.firstpromoter.com/) v2 Search... ⌘K Search... Navigation Scripts Advanced use cases & examples [Documentation](https://docs.firstpromoter.com/introduction) [API Reference](https://docs.firstpromoter.com/api-reference-v2/api-admin/introduction) On this page * [Passing the ref id programmatically](https://docs.firstpromoter.com/script-docs/advanced#passing-the-ref-id-programmatically) * [Passing the ref id programmatically from a query string](https://docs.firstpromoter.com/script-docs/advanced#passing-the-ref-id-programmatically-from-a-query-string) * [Forcing a new tid to be created or reinitializing the FirstPromoter cookies](https://docs.firstpromoter.com/script-docs/advanced#forcing-a-new-tid-to-be-created-or-reinitializing-the-firstpromoter-cookies) * [Setting a default Promoter](https://docs.firstpromoter.com/script-docs/advanced#setting-a-default-promoter) [​](https://docs.firstpromoter.com/script-docs/advanced#passing-the-ref-id-programmatically) Passing the ref id programmatically ----------------------------------------------------------------------------------------------------------------------------------- `fpr("init",{cid:"...",ref_id:"..."})` Getting the ref id from the url and passing it to fpr init Custom query parameter Custom hash Copy [​](https://docs.firstpromoter.com/script-docs/advanced#passing-the-ref-id-programmatically-from-a-query-string) Passing the ref id programmatically from a query string --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- Copy [​](https://docs.firstpromoter.com/script-docs/advanced#forcing-a-new-tid-to-be-created-or-reinitializing-the-firstpromoter-cookies) Forcing a new tid to be created or reinitializing the FirstPromoter cookies ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- You can force a new tid to be created by invalidating the old one this can be done by passing cookie\_ref\_id: ‘xxx’ as shown in the example below Copy fpr("referral",{email: getParam("wj_lead_email")}, function(){ window.fpr("click",{cookie_ref_id: 'xxx'}); }); it can also be used to force new emails to be collected on page refresh Copy [​](https://docs.firstpromoter.com/script-docs/advanced#setting-a-default-promoter) Setting a default Promoter ----------------------------------------------------------------------------------------------------------------- Copy [FirstPromoter JavaScript Library (fpr.js)](https://docs.firstpromoter.com/script-docs/fpr-js-docs) [Concepts & Key Terminologies](https://docs.firstpromoter.com/script-docs/concepts) ⌘I --- # Fulfilment Pending - FirstPromoter Docs [Skip to main content](https://docs.firstpromoter.com/webhooks/fulfilment-pending#content-area) [FirstPromoter Docs home page![light logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/light.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=6ded212b82547bec37a22e90f72eeb71)![dark logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/dark.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=c393ff83772047b8a444f78a1e393e7f)](https://docs.firstpromoter.com/) v2 Search... ⌘K Search... Navigation Webhooks Fulfilment Pending [Documentation](https://docs.firstpromoter.com/introduction) [API Reference](https://docs.firstpromoter.com/api-reference-v2/api-admin/introduction) Response Copy { "event": { "id": 13007875, "type": "fulfilment_pending", "created_at": "2023-08-23T11:06:02.663Z" }, "data": { "id": 2429153, "status": "pending", "amount": 3, "date_paid": null, "due_date": null, "unit": "free_months", "created_at": "2023-08-23T11:06:02.607Z", "has_issues": false, "reward": { "id": 109465, "amount": null, "type": "per_promotion", "unit": "free_months", "name": "Free subscription months", "per_of_sale": 0, "default_promo_code": null }, "promoter": { "id": 5272969, "status": "active", "cust_id": "", "email": "[email protected]", "created_at": "2023-02-08T06:25:28.004Z", "temp_password": "gpBwBYw1", "default_promotion_id": 5680057, "pref": "i790yc6", "default_ref_id": "referralid18", "note": null, "w8_form_url": null, "w9_form_url": null, "parent_promoter_id": null, "earnings_balance": { "cash": 882, "free_months": 3 }, "current_balance": { "cash": 882, "free_months": 3 }, "paid_balance": null, "auth_token": "2-5P1Shfk2nnKaZrYFZExh-sfCThGt-2", "profile": { "id": 5306304, "first_name": "Promoter", "last_name": "Name", "website": "", "company_name": "", "phone_number": "", "address": "", "vat_id": "", "country": "", "paypal_email": null, "avatar_url": "", "description": null, "social_accounts": { "twitter": { "url": "" }, "youtube": { "url": "" }, "facebook": { "url": "" }, "linkedin": { "url": "" }, "instagram": { "url": "" } } }, "promotions": [\ {\ "id": 5680057,\ "status": "offer_inactive",\ "ref_id": "referralid18",\ "promo_code": "",\ "customer_promo_code": "",\ "target_reached_at": null,\ "promoter_id": 5272969,\ "campaign_id": 17476,\ "referral_link": "https://www.your-company.com/?fpr=referralid18",\ "current_offer": null,\ "current_referral_reward": {\ "id": 90548,\ "amount": null,\ "type": "per_referral",\ "unit": "cash",\ "name": "35% recurring commission",\ "per_of_sale": 35,\ "default_promo_code": null\ },\ "current_promotion_reward": null,\ "current_target_reward": null,\ "campaign_name": "Campaign Name",\ "hidden": false,\ "visitors_count": 4,\ "leads_count": 3,\ "customers_count": 2,\ "refunds_count": 0,\ "cancellations_count": 0,\ "sales_count": 2,\ "sales_total": 2522,\ "refunds_total": 0,\ "active_customers_count": 2\ }\ ] }, "campaign": { "id": 17476, "name": "Campaign Name", "landing_url": "https://www.your-company.com", "description": "Private campaign with 2 plans", "private": false, "color": "#42a5f5", "default_webhook_url": "https://your-webhook-url.com", "auto_approve_rewards": true, "auto_approve_promoters": false, "offer": null, "referral_reward": { "id": 90548, "amount": null, "type": "per_referral", "unit": "cash", "name": "35% recurring commission", "per_of_sale": 35, "default_promo_code": null }, "promotion_reward": null, "target_reward": null } } } This webhook will be fired right after the reward is attributed. To utilize the ‘fulfilment\_pending’ webhook in FirstPromoter, follow these steps: [​](https://docs.firstpromoter.com/webhooks/fulfilment-pending#how-to-respond-to-this-webhook-call:) How to respond to this webhook call: -------------------------------------------------------------------------------------------------------------------------------------------- Respond with status 200 if you fulfilled the reward on your end. Respond with a 2xx status (except 200) to keep the fulfilment marked as pending on FirstPromoter’s end. Respond with any other status to indicate an error (FirstPromoter will retry for 7 times during the day). [​](https://docs.firstpromoter.com/webhooks/fulfilment-pending#param-event) Event Event Object Show properties [​](https://docs.firstpromoter.com/webhooks/fulfilment-pending#param-id) id string The Id of the event [​](https://docs.firstpromoter.com/webhooks/fulfilment-pending#param-type) type string Indicates the webhook event type, such as `fulfilment_pending`. [​](https://docs.firstpromoter.com/webhooks/fulfilment-pending#param-created-at) created\_at string Timestamp of when the event occurred. [​](https://docs.firstpromoter.com/webhooks/fulfilment-pending#param-data) Data Data Object Show properties [​](https://docs.firstpromoter.com/webhooks/fulfilment-pending#param-id-1) id number The Id of the reward [​](https://docs.firstpromoter.com/webhooks/fulfilment-pending#param-status) status string The status of the reward. [​](https://docs.firstpromoter.com/webhooks/fulfilment-pending#param-amount) amount number The reward amount [​](https://docs.firstpromoter.com/webhooks/fulfilment-pending#param-unit) unit string The unit of the reward [​](https://docs.firstpromoter.com/webhooks/fulfilment-pending#param-created-at-1) created\_at string The date and time the reward was created [​](https://docs.firstpromoter.com/webhooks/fulfilment-pending#param-has-issues) has\_issues boolean Whether the reward has issues [​](https://docs.firstpromoter.com/webhooks/fulfilment-pending#param-reward) reward Reward Object Show properties [​](https://docs.firstpromoter.com/webhooks/fulfilment-pending#param-id-2) id number The Id of the reward [​](https://docs.firstpromoter.com/webhooks/fulfilment-pending#param-amount-1) amount number The reward amount [​](https://docs.firstpromoter.com/webhooks/fulfilment-pending#param-type-1) type string The type of the reward [​](https://docs.firstpromoter.com/webhooks/fulfilment-pending#param-unit-1) unit string The unit of the reward [​](https://docs.firstpromoter.com/webhooks/fulfilment-pending#param-name) name string The name of the reward [​](https://docs.firstpromoter.com/webhooks/fulfilment-pending#param-per-of-sale) per\_of\_sale number The per of sale of the reward [​](https://docs.firstpromoter.com/webhooks/fulfilment-pending#param-default-promo-code) default\_promo\_code string The default promo code of the reward [​](https://docs.firstpromoter.com/webhooks/fulfilment-pending#param-promoter) promoter Promoter Object Show properties [​](https://docs.firstpromoter.com/webhooks/fulfilment-pending#param-id-3) id number The Id of the promoter [​](https://docs.firstpromoter.com/webhooks/fulfilment-pending#param-status-1) status string The status of the promoter [​](https://docs.firstpromoter.com/webhooks/fulfilment-pending#param-cust-id) cust\_id string The customer id of the promoter [​](https://docs.firstpromoter.com/webhooks/fulfilment-pending#param-email) email string The email of the promoter [​](https://docs.firstpromoter.com/webhooks/fulfilment-pending#param-created-at-2) created\_at string The date the promoter was created [​](https://docs.firstpromoter.com/webhooks/fulfilment-pending#param-temp-password) temp\_password string The temporary password of the promoter [​](https://docs.firstpromoter.com/webhooks/fulfilment-pending#param-default-promotion-id) default\_promotion\_id number The default promotion id of the promoter [​](https://docs.firstpromoter.com/webhooks/fulfilment-pending#param-pref) pref string The pref of the promoter [​](https://docs.firstpromoter.com/webhooks/fulfilment-pending#param-default-ref-id) default\_ref\_id string The default referral id of the promoter [​](https://docs.firstpromoter.com/webhooks/fulfilment-pending#param-note) note string The note saved on the promoter profile by an admin [​](https://docs.firstpromoter.com/webhooks/fulfilment-pending#param-w8-form-url) w8\_form\_url string The w8 form url saved on the promoter profile by an admin [​](https://docs.firstpromoter.com/webhooks/fulfilment-pending#param-w9-form-url) w9\_form\_url string The w9 form url saved on the promoter profile by an admin [​](https://docs.firstpromoter.com/webhooks/fulfilment-pending#param-parent-promoter-id) parent\_promoter\_id number The parent promoter id of the promoter [​](https://docs.firstpromoter.com/webhooks/fulfilment-pending#param-earnings-balance) earnings\_balance number The earnings balance of the promoter [​](https://docs.firstpromoter.com/webhooks/fulfilment-pending#param-current-balance) current\_balance number The current balance of the promoter [​](https://docs.firstpromoter.com/webhooks/fulfilment-pending#param-paid-balance) paid\_balance number The paid balance of the promoter [​](https://docs.firstpromoter.com/webhooks/fulfilment-pending#param-auth-token) auth\_token string The auth token of the promoter [​](https://docs.firstpromoter.com/webhooks/fulfilment-pending#param-profile) profile Profile Object Show properties [​](https://docs.firstpromoter.com/webhooks/fulfilment-pending#param-id-4) id number The Id of the profile [​](https://docs.firstpromoter.com/webhooks/fulfilment-pending#param-first-name) first\_name string The first name of the profile [​](https://docs.firstpromoter.com/webhooks/fulfilment-pending#param-last-name) last\_name string The last name of the profile [​](https://docs.firstpromoter.com/webhooks/fulfilment-pending#param-website) website string The website of the profile [​](https://docs.firstpromoter.com/webhooks/fulfilment-pending#param-company-name) company\_name string The company name of the profile [​](https://docs.firstpromoter.com/webhooks/fulfilment-pending#param-phone-number) phone\_number string The phone number of the profile [​](https://docs.firstpromoter.com/webhooks/fulfilment-pending#param-address) address string The address of the profile [​](https://docs.firstpromoter.com/webhooks/fulfilment-pending#param-vat-id) vat\_id string The vat id of the profile [​](https://docs.firstpromoter.com/webhooks/fulfilment-pending#param-country) country string The country of the profile [​](https://docs.firstpromoter.com/webhooks/fulfilment-pending#param-paypal-email) paypal\_email string The paypal email of the profile [​](https://docs.firstpromoter.com/webhooks/fulfilment-pending#param-avatar-url) avatar\_url string The avatar url of the profile [​](https://docs.firstpromoter.com/webhooks/fulfilment-pending#param-description) description string The description of the profile [​](https://docs.firstpromoter.com/webhooks/fulfilment-pending#param-social-accounts) social\_accounts Social Accounts Object Show properties [​](https://docs.firstpromoter.com/webhooks/fulfilment-pending#param-tiktok) tiktok Social Account Object Show properties [​](https://docs.firstpromoter.com/webhooks/fulfilment-pending#param-url) url string The url of the social account [​](https://docs.firstpromoter.com/webhooks/fulfilment-pending#param-twitch) twitch Social Account Object Show properties [​](https://docs.firstpromoter.com/webhooks/fulfilment-pending#param-url-1) url string The url of the social account [​](https://docs.firstpromoter.com/webhooks/fulfilment-pending#param-twitter) twitter Social Account Object Show properties [​](https://docs.firstpromoter.com/webhooks/fulfilment-pending#param-url-2) url string The url of the social account [​](https://docs.firstpromoter.com/webhooks/fulfilment-pending#param-youtube) youtube Social Account Object Show properties [​](https://docs.firstpromoter.com/webhooks/fulfilment-pending#param-url-3) url string The url of the social account [​](https://docs.firstpromoter.com/webhooks/fulfilment-pending#param-facebook) facebook Social Account Object Show properties [​](https://docs.firstpromoter.com/webhooks/fulfilment-pending#param-url-4) url string The url of the social account [​](https://docs.firstpromoter.com/webhooks/fulfilment-pending#param-linkedin) linkedin Social Account Object Show properties [​](https://docs.firstpromoter.com/webhooks/fulfilment-pending#param-url-5) url string The url of the social account [​](https://docs.firstpromoter.com/webhooks/fulfilment-pending#param-instagram) instagram Social Account Object Show properties [​](https://docs.firstpromoter.com/webhooks/fulfilment-pending#param-url-6) url string The url of the social account Response Copy { "event": { "id": 13007875, "type": "fulfilment_pending", "created_at": "2023-08-23T11:06:02.663Z" }, "data": { "id": 2429153, "status": "pending", "amount": 3, "date_paid": null, "due_date": null, "unit": "free_months", "created_at": "2023-08-23T11:06:02.607Z", "has_issues": false, "reward": { "id": 109465, "amount": null, "type": "per_promotion", "unit": "free_months", "name": "Free subscription months", "per_of_sale": 0, "default_promo_code": null }, "promoter": { "id": 5272969, "status": "active", "cust_id": "", "email": "[email protected]", "created_at": "2023-02-08T06:25:28.004Z", "temp_password": "gpBwBYw1", "default_promotion_id": 5680057, "pref": "i790yc6", "default_ref_id": "referralid18", "note": null, "w8_form_url": null, "w9_form_url": null, "parent_promoter_id": null, "earnings_balance": { "cash": 882, "free_months": 3 }, "current_balance": { "cash": 882, "free_months": 3 }, "paid_balance": null, "auth_token": "2-5P1Shfk2nnKaZrYFZExh-sfCThGt-2", "profile": { "id": 5306304, "first_name": "Promoter", "last_name": "Name", "website": "", "company_name": "", "phone_number": "", "address": "", "vat_id": "", "country": "", "paypal_email": null, "avatar_url": "", "description": null, "social_accounts": { "twitter": { "url": "" }, "youtube": { "url": "" }, "facebook": { "url": "" }, "linkedin": { "url": "" }, "instagram": { "url": "" } } }, "promotions": [\ {\ "id": 5680057,\ "status": "offer_inactive",\ "ref_id": "referralid18",\ "promo_code": "",\ "customer_promo_code": "",\ "target_reached_at": null,\ "promoter_id": 5272969,\ "campaign_id": 17476,\ "referral_link": "https://www.your-company.com/?fpr=referralid18",\ "current_offer": null,\ "current_referral_reward": {\ "id": 90548,\ "amount": null,\ "type": "per_referral",\ "unit": "cash",\ "name": "35% recurring commission",\ "per_of_sale": 35,\ "default_promo_code": null\ },\ "current_promotion_reward": null,\ "current_target_reward": null,\ "campaign_name": "Campaign Name",\ "hidden": false,\ "visitors_count": 4,\ "leads_count": 3,\ "customers_count": 2,\ "refunds_count": 0,\ "cancellations_count": 0,\ "sales_count": 2,\ "sales_total": 2522,\ "refunds_total": 0,\ "active_customers_count": 2\ }\ ] }, "campaign": { "id": 17476, "name": "Campaign Name", "landing_url": "https://www.your-company.com", "description": "Private campaign with 2 plans", "private": false, "color": "#42a5f5", "default_webhook_url": "https://your-webhook-url.com", "auto_approve_rewards": true, "auto_approve_promoters": false, "offer": null, "referral_reward": { "id": 90548, "amount": null, "type": "per_referral", "unit": "cash", "name": "35% recurring commission", "per_of_sale": 35, "default_promo_code": null }, "promotion_reward": null, "target_reward": null } } } [Promoter Accepted](https://docs.firstpromoter.com/webhooks/promoter-accepted) ⌘I --- # New Customer - FirstPromoter Docs [Skip to main content](https://docs.firstpromoter.com/webhooks/new-customer#content-area) [FirstPromoter Docs home page![light logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/light.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=6ded212b82547bec37a22e90f72eeb71)![dark logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/dark.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=c393ff83772047b8a444f78a1e393e7f)](https://docs.firstpromoter.com/) v2 Search... ⌘K Search... Navigation Webhooks New Customer [Documentation](https://docs.firstpromoter.com/introduction) [API Reference](https://docs.firstpromoter.com/api-reference-v2/api-admin/introduction) Response Copy { "event": { "id": 22737433, "type": "lead_becomes_referral", "created_at": "2024-10-03T14:23:20.887Z" }, "data": { "id": 21381518, "state": "active", "email": "[email protected]", "uid": "", "customer_since": "2024-10-03T14:23:20.495Z", "cancelled_at": null, "plan_name": null, "suspicion": "no_suspicion", "username": null, "website": null, "created_at": "2024-10-03T13:45:20.031Z", "split_promotion_id": null, "custom_fields": null, "split_percentage_value": null, "visitor_sub_id": null, "promotion": { "id": 4210924, "status": "offer_running", "ref_id": "afpxunub", "promo_code": null, "customer_promo_code": null, "target_reached_at": null, "promoter_id": 3920164, "campaign_id": 13202, "referral_link": "https://www.cax.ws?_get=afpxunub", "current_offer": { "id": 67212, "name": "5% discount coupon", "amount": 5, "unit": "discount_per", "default_promo_code": " MAXADA-5" }, "current_referral_reward": { "id": 128312, "amount": 0, "type": "per_referral", "unit": "cash", "name": "20% recurring commission", "per_of_sale": 20, "default_promo_code": "" }, "current_promotion_reward": { "id": 68347, "amount": null, "type": "per_promotion", "unit": "free_months", "name": "Free subscription months", "per_of_sale": 0, "default_promo_code": null }, "current_target_reward": null, "campaign_name": "Jaquelyn Ryan", "hidden": false, "visitors_count": 2, "leads_count": 4, "customers_count": 4, "refunds_count": 1, "cancellations_count": 1, "sales_count": 4, "sales_total": 211000, "refunds_total": -1000, "active_customers_count": 3 }, "promoter": { "id": 3920164, "status": "active", "cust_id": "", "email": "[email protected]", "created_at": "2022-04-26T15:28:24.800Z", "temp_password": null, "default_promotion_id": 4210919, "pref": "db1znwe", "default_ref_id": "8yi2epelut", "note": null, "w8_form_url": null, "w9_form_url": null, "parent_promoter_id": 5779418, "earnings_balance": { "cash": 52744 }, "current_balance": { "cash": 22044, "free_months": -1 }, "paid_balance": { "cash": 30700, "free_months": 1 }, "auth_token": "hjsmLQwMounBWxeqQS2cMXYp8epADJmB", "profile": { "id": 3947800, "first_name": "Pelu", "last_name": "", "website": "", "company_name": "", "phone_number": "", "address": "", "vat_id": "", "country": "", "paypal_email": "[email protected]", "avatar_url": "", "description": null, "social_accounts": { "twitter": { "url": "" }, "youtube": { "url": "" }, "facebook": { "url": "" }, "linkedin": { "url": "" }, "instagram": { "url": "" } } }, "promotions": [\ {\ "id": 4210919,\ "status": "offer_running",\ "ref_id": "8yi2epelut",\ "promo_code": "MAX-1234",\ "customer_promo_code": "",\ "target_reached_at": "2023-04-20T13:41:20.782Z",\ "promoter_id": 3920164,\ "campaign_id": 13228,\ "referral_link": "https://resilient-pegasus-e7ed60.netlify.app?fpr=8yi2epelut",\ "current_offer": {\ "id": 68621,\ "name": "20% discount coupon",\ "amount": 20,\ "unit": "discount_per",\ "default_promo_code": null\ },\ "current_referral_reward": {\ "id": 97806,\ "amount": 0,\ "type": "per_referral",\ "unit": "cash",\ "name": "20% recurring commission",\ "per_of_sale": 0,\ "default_promo_code": ""\ },\ "current_promotion_reward": null,\ "current_target_reward": null,\ "campaign_name": "erSecond FP Campaign",\ "hidden": false,\ "visitors_count": 192,\ "leads_count": 77,\ "customers_count": 15,\ "refunds_count": 2,\ "cancellations_count": 0,\ "sales_count": 96,\ "sales_total": 995542,\ "refunds_total": -2600,\ "active_customers_count": 15\ },\ {\ "id": 4309469,\ "status": "offer_running",\ "ref_id": "k7iip",\ "promo_code": null,\ "customer_promo_code": null,\ "target_reached_at": null,\ "promoter_id": 3920164,\ "campaign_id": 13414,\ "referral_link": "https://hirehex1.com?fpr=k7iip",\ "current_offer": {\ "id": 67212,\ "name": "5% discount coupon",\ "amount": 5,\ "unit": "discount_per",\ "default_promo_code": " MAXADA-5"\ },\ "current_referral_reward": {\ "id": 115047,\ "amount": 20,\ "type": "per_referral",\ "unit": "points",\ "name": "20 points",\ "per_of_sale": 0,\ "default_promo_code": ""\ },\ "current_promotion_reward": null,\ "current_target_reward": null,\ "campaign_name": "Braintree",\ "hidden": true,\ "visitors_count": 0,\ "leads_count": 1,\ "customers_count": 1,\ "refunds_count": 0,\ "cancellations_count": 0,\ "sales_count": 1,\ "sales_total": 10000,\ "refunds_total": 0,\ "active_customers_count": 1\ },\ {\ "id": 4210924,\ "status": "offer_running",\ "ref_id": "afpxunub",\ "promo_code": null,\ "customer_promo_code": null,\ "target_reached_at": null,\ "promoter_id": 3920164,\ "campaign_id": 13202,\ "referral_link": "https://www.cax.ws?_get=afpxunub",\ "current_offer": {\ "id": 67212,\ "name": "5% discount coupon",\ "amount": 5,\ "unit": "discount_per",\ "default_promo_code": " MAXADA-5"\ },\ "current_referral_reward": {\ "id": 128312,\ "amount": 0,\ "type": "per_referral",\ "unit": "cash",\ "name": "20% recurring commission",\ "per_of_sale": 20,\ "default_promo_code": ""\ },\ "current_promotion_reward": {\ "id": 68347,\ "amount": null,\ "type": "per_promotion",\ "unit": "free_months",\ "name": "Free subscription months",\ "per_of_sale": 0,\ "default_promo_code": null\ },\ "current_target_reward": null,\ "campaign_name": "Jaquelyn Ryan",\ "hidden": false,\ "visitors_count": 2,\ "leads_count": 4,\ "customers_count": 4,\ "refunds_count": 1,\ "cancellations_count": 1,\ "sales_count": 4,\ "sales_total": 211000,\ "refunds_total": -1000,\ "active_customers_count": 3\ }\ ] } } } By setting up a webhook, your endpoint will receive an event when a lead becomes a customer. This event is triggered only once on the first payment made by the lead. [​](https://docs.firstpromoter.com/webhooks/new-customer#response-paramerters) Response Paramerters ------------------------------------------------------------------------------------------------------ [​](https://docs.firstpromoter.com/webhooks/new-customer#param-event) Event Event Object Show properties [​](https://docs.firstpromoter.com/webhooks/new-customer#param-id) id string The Id of the event [​](https://docs.firstpromoter.com/webhooks/new-customer#param-type) type string Indicates the webhook event type, such as `lead_becomes_referral`. [​](https://docs.firstpromoter.com/webhooks/new-customer#param-created-at) created\_at string Timestamp of when the event occurred. [​](https://docs.firstpromoter.com/webhooks/new-customer#param-data) Data Data Object Show properties [​](https://docs.firstpromoter.com/webhooks/new-customer#param-id-1) id number The Id of the lead [​](https://docs.firstpromoter.com/webhooks/new-customer#param-status) status string The state of the lead [​](https://docs.firstpromoter.com/webhooks/new-customer#param-email) email string The email of the lead [​](https://docs.firstpromoter.com/webhooks/new-customer#param-uid) uid string The user id of the lead [​](https://docs.firstpromoter.com/webhooks/new-customer#param-customer-since) customer\_since string The date and time the lead became a customer [​](https://docs.firstpromoter.com/webhooks/new-customer#param-cancelled-at) cancelled\_at string The date and time the lead was cancelled [​](https://docs.firstpromoter.com/webhooks/new-customer#param-plan-name) plan\_name string The plan name the lead is subscribed to [​](https://docs.firstpromoter.com/webhooks/new-customer#param-suspicion) suspicion string This states if the addition of the lead is suspected to be fraudulent [​](https://docs.firstpromoter.com/webhooks/new-customer#param-username) username string The username of the lead [​](https://docs.firstpromoter.com/webhooks/new-customer#param-website) website string The website of the lead [​](https://docs.firstpromoter.com/webhooks/new-customer#param-created-at-1) created\_at string The date and time the lead was created [​](https://docs.firstpromoter.com/webhooks/new-customer#param-split-promotion-id) split\_promotion\_id number The split promotion id of the lead [​](https://docs.firstpromoter.com/webhooks/new-customer#param-split-percentage-value) split\_percentage\_value number The split percentage value of the lead [​](https://docs.firstpromoter.com/webhooks/new-customer#param-promoter) promoter Promoter Object Show properties [​](https://docs.firstpromoter.com/webhooks/new-customer#param-id-2) id number The Id of the promoter [​](https://docs.firstpromoter.com/webhooks/new-customer#param-status-1) status string The status of the promoter [​](https://docs.firstpromoter.com/webhooks/new-customer#param-cust-id) cust\_id string The customer id of the promoter [​](https://docs.firstpromoter.com/webhooks/new-customer#param-email-1) email string The email of the promoter [​](https://docs.firstpromoter.com/webhooks/new-customer#param-created-at-2) created\_at string The date the promoter was created [​](https://docs.firstpromoter.com/webhooks/new-customer#param-temp-password) temp\_password string The temporary password of the promoter [​](https://docs.firstpromoter.com/webhooks/new-customer#param-default-promotion-id) default\_promotion\_id number The default promotion id of the promoter [​](https://docs.firstpromoter.com/webhooks/new-customer#param-pref) pref string The pref of the promoter [​](https://docs.firstpromoter.com/webhooks/new-customer#param-default-ref-id) default\_ref\_id string The default referral id of the promoter [​](https://docs.firstpromoter.com/webhooks/new-customer#param-note) note string The note saved on the promoter profile by an admin [​](https://docs.firstpromoter.com/webhooks/new-customer#param-w8-form-url) w8\_form\_url string The w8 form url saved on the promoter profile by an admin [​](https://docs.firstpromoter.com/webhooks/new-customer#param-w9-form-url) w9\_form\_url string The w9 form url saved on the promoter profile by an admin [​](https://docs.firstpromoter.com/webhooks/new-customer#param-parent-promoter-id) parent\_promoter\_id number The parent promoter id of the promoter [​](https://docs.firstpromoter.com/webhooks/new-customer#param-earnings-balance) earnings\_balance number The earnings balance of the promoter [​](https://docs.firstpromoter.com/webhooks/new-customer#param-current-balance) current\_balance number The current balance of the promoter [​](https://docs.firstpromoter.com/webhooks/new-customer#param-paid-balance) paid\_balance number The paid balance of the promoter [​](https://docs.firstpromoter.com/webhooks/new-customer#param-auth-token) auth\_token string The auth token of the promoter [​](https://docs.firstpromoter.com/webhooks/new-customer#param-profile) profile Profile Object Show properties [​](https://docs.firstpromoter.com/webhooks/new-customer#param-id-3) id number The Id of the profile [​](https://docs.firstpromoter.com/webhooks/new-customer#param-first-name) first\_name string The first name of the profile [​](https://docs.firstpromoter.com/webhooks/new-customer#param-last-name) last\_name string The last name of the profile [​](https://docs.firstpromoter.com/webhooks/new-customer#param-website-1) website string The website of the profile [​](https://docs.firstpromoter.com/webhooks/new-customer#param-company-name) company\_name string The company name of the profile [​](https://docs.firstpromoter.com/webhooks/new-customer#param-phone-number) phone\_number string The phone number of the profile [​](https://docs.firstpromoter.com/webhooks/new-customer#param-address) address string The address of the profile [​](https://docs.firstpromoter.com/webhooks/new-customer#param-vat-id) vat\_id string The vat id of the profile [​](https://docs.firstpromoter.com/webhooks/new-customer#param-country) country string The country of the profile [​](https://docs.firstpromoter.com/webhooks/new-customer#param-paypal-email) paypal\_email string The paypal email of the profile [​](https://docs.firstpromoter.com/webhooks/new-customer#param-avatar-url) avatar\_url string The avatar url of the profile [​](https://docs.firstpromoter.com/webhooks/new-customer#param-description) description string The description of the profile [​](https://docs.firstpromoter.com/webhooks/new-customer#param-social-accounts) social\_accounts Social Accounts Object Show properties [​](https://docs.firstpromoter.com/webhooks/new-customer#param-tiktok) tiktok Social Account Object Show properties [​](https://docs.firstpromoter.com/webhooks/new-customer#param-url) url string The url of the social account [​](https://docs.firstpromoter.com/webhooks/new-customer#param-twitch) twitch Social Account Object Show properties [​](https://docs.firstpromoter.com/webhooks/new-customer#param-url-1) url string The url of the social account [​](https://docs.firstpromoter.com/webhooks/new-customer#param-twitter) twitter Social Account Object Show properties [​](https://docs.firstpromoter.com/webhooks/new-customer#param-url-2) url string The url of the social account [​](https://docs.firstpromoter.com/webhooks/new-customer#param-youtube) youtube Social Account Object Show properties [​](https://docs.firstpromoter.com/webhooks/new-customer#param-url-3) url string The url of the social account [​](https://docs.firstpromoter.com/webhooks/new-customer#param-facebook) facebook Social Account Object Show properties [​](https://docs.firstpromoter.com/webhooks/new-customer#param-url-4) url string The url of the social account [​](https://docs.firstpromoter.com/webhooks/new-customer#param-linkedin) linkedin Social Account Object Show properties [​](https://docs.firstpromoter.com/webhooks/new-customer#param-url-5) url string The url of the social account [​](https://docs.firstpromoter.com/webhooks/new-customer#param-instagram) instagram Social Account Object Show properties [​](https://docs.firstpromoter.com/webhooks/new-customer#param-url-6) url string The url of the social account [​](https://docs.firstpromoter.com/webhooks/new-customer#param-promotions) promotions Promotions Array Show properties [​](https://docs.firstpromoter.com/webhooks/new-customer#param-promotion) promotion Promotion Object Show properties [​](https://docs.firstpromoter.com/webhooks/new-customer#param-id-4) id number The Id of the promotion [​](https://docs.firstpromoter.com/webhooks/new-customer#param-status-2) status string The status of the promotion [​](https://docs.firstpromoter.com/webhooks/new-customer#param-ref-id) ref\_id string The referral id of the promotion [​](https://docs.firstpromoter.com/webhooks/new-customer#param-promo-code) promo\_code string The promo code of the promotion [​](https://docs.firstpromoter.com/webhooks/new-customer#param-customer-promo-code) customer\_promo\_code string The customer promo code of the promotion [​](https://docs.firstpromoter.com/webhooks/new-customer#param-target-reached-at) target\_reached\_at string The target reached at of the promotion [​](https://docs.firstpromoter.com/webhooks/new-customer#param-promoter-id) promoter\_id number The promoter id of the promotion [​](https://docs.firstpromoter.com/webhooks/new-customer#param-campaign-id) campaign\_id number The campaign id of the promotion [​](https://docs.firstpromoter.com/webhooks/new-customer#param-referral-link) referral\_link string The referral link of the promotion [​](https://docs.firstpromoter.com/webhooks/new-customer#param-current-offer) current\_offer Offer Object Show properties [​](https://docs.firstpromoter.com/webhooks/new-customer#param-id-5) id number The Id of the offer [​](https://docs.firstpromoter.com/webhooks/new-customer#param-name) name string The name of the offer [​](https://docs.firstpromoter.com/webhooks/new-customer#param-amount) amount number The amount of the offer [​](https://docs.firstpromoter.com/webhooks/new-customer#param-unit) unit string The unit of the offer [​](https://docs.firstpromoter.com/webhooks/new-customer#param-default-promo-code) default\_promo\_code string The default promo code of the offer [​](https://docs.firstpromoter.com/webhooks/new-customer#param-current-referral-reward) current\_referral\_reward Current referral reward Object Show properties [​](https://docs.firstpromoter.com/webhooks/new-customer#param-id-6) id number The Id of the referral reward [​](https://docs.firstpromoter.com/webhooks/new-customer#param-amount-1) amount number The amount of the referral reward [​](https://docs.firstpromoter.com/webhooks/new-customer#param-type-1) type string The type of the referral reward [​](https://docs.firstpromoter.com/webhooks/new-customer#param-unit-1) unit string The unit of the referral reward [​](https://docs.firstpromoter.com/webhooks/new-customer#param-name-1) name string The name of the referral reward [​](https://docs.firstpromoter.com/webhooks/new-customer#param-per-of-sale) per\_of\_sale number The per of sale of the referral reward [​](https://docs.firstpromoter.com/webhooks/new-customer#param-default-promo-code-1) default\_promo\_code string The default promo code of the referral reward [​](https://docs.firstpromoter.com/webhooks/new-customer#param-current-promotion-reward) current\_promotion\_reward Current promotion reward Object Show properties [​](https://docs.firstpromoter.com/webhooks/new-customer#param-id-7) id number The Id of the promotion reward [​](https://docs.firstpromoter.com/webhooks/new-customer#param-amount-2) amount number The amount of the promotion reward [​](https://docs.firstpromoter.com/webhooks/new-customer#param-type-2) type string The type of the promotion reward [​](https://docs.firstpromoter.com/webhooks/new-customer#param-unit-2) unit string The unit of the promotion reward [​](https://docs.firstpromoter.com/webhooks/new-customer#param-name-2) name string The name of the promotion reward [​](https://docs.firstpromoter.com/webhooks/new-customer#param-per-of-sale-1) per\_of\_sale number The per of sale of the promotion reward [​](https://docs.firstpromoter.com/webhooks/new-customer#param-default-promo-code-2) default\_promo\_code string The default promo code of the promotion reward [​](https://docs.firstpromoter.com/webhooks/new-customer#param-current-target-reward) current\_target\_reward Current target reward Object Show properties [​](https://docs.firstpromoter.com/webhooks/new-customer#param-id-8) id number The Id of the referral reward [​](https://docs.firstpromoter.com/webhooks/new-customer#param-amount-3) amount number The amount of the referral reward [​](https://docs.firstpromoter.com/webhooks/new-customer#param-type-3) type string The type of the referral reward [​](https://docs.firstpromoter.com/webhooks/new-customer#param-unit-3) unit string The unit of the referral reward [​](https://docs.firstpromoter.com/webhooks/new-customer#param-name-3) name string The name of the referral reward [​](https://docs.firstpromoter.com/webhooks/new-customer#param-per-of-sale-2) per\_of\_sale number The per of sale of the referral reward [​](https://docs.firstpromoter.com/webhooks/new-customer#param-default-promo-code-3) default\_promo\_code string The default promo code of the referral reward [​](https://docs.firstpromoter.com/webhooks/new-customer#param-campaign-name) campaign\_name string The name of the campaign [​](https://docs.firstpromoter.com/webhooks/new-customer#param-hidden) hidden boolean Whether the campaign is hidden [​](https://docs.firstpromoter.com/webhooks/new-customer#param-visitors-count) visitors\_count number The number of visitors [​](https://docs.firstpromoter.com/webhooks/new-customer#param-leads-count) leads\_count number The number of leads [​](https://docs.firstpromoter.com/webhooks/new-customer#param-customers-count) customers\_count number The number of customers [​](https://docs.firstpromoter.com/webhooks/new-customer#param-refunds-count) refunds\_count number The number of refunds [​](https://docs.firstpromoter.com/webhooks/new-customer#param-cancellations-count) cancellations\_count number The number of cancellations [​](https://docs.firstpromoter.com/webhooks/new-customer#param-sales-count) sales\_count number The number of sales [​](https://docs.firstpromoter.com/webhooks/new-customer#param-sales-total) sales\_total number The total sales [​](https://docs.firstpromoter.com/webhooks/new-customer#param-refunds-total) refunds\_total number The total refunds [​](https://docs.firstpromoter.com/webhooks/new-customer#param-active-customers-count) active\_customers\_count number The number of active customers Response Copy { "event": { "id": 22737433, "type": "lead_becomes_referral", "created_at": "2024-10-03T14:23:20.887Z" }, "data": { "id": 21381518, "state": "active", "email": "[email protected]", "uid": "", "customer_since": "2024-10-03T14:23:20.495Z", "cancelled_at": null, "plan_name": null, "suspicion": "no_suspicion", "username": null, "website": null, "created_at": "2024-10-03T13:45:20.031Z", "split_promotion_id": null, "custom_fields": null, "split_percentage_value": null, "visitor_sub_id": null, "promotion": { "id": 4210924, "status": "offer_running", "ref_id": "afpxunub", "promo_code": null, "customer_promo_code": null, "target_reached_at": null, "promoter_id": 3920164, "campaign_id": 13202, "referral_link": "https://www.cax.ws?_get=afpxunub", "current_offer": { "id": 67212, "name": "5% discount coupon", "amount": 5, "unit": "discount_per", "default_promo_code": " MAXADA-5" }, "current_referral_reward": { "id": 128312, "amount": 0, "type": "per_referral", "unit": "cash", "name": "20% recurring commission", "per_of_sale": 20, "default_promo_code": "" }, "current_promotion_reward": { "id": 68347, "amount": null, "type": "per_promotion", "unit": "free_months", "name": "Free subscription months", "per_of_sale": 0, "default_promo_code": null }, "current_target_reward": null, "campaign_name": "Jaquelyn Ryan", "hidden": false, "visitors_count": 2, "leads_count": 4, "customers_count": 4, "refunds_count": 1, "cancellations_count": 1, "sales_count": 4, "sales_total": 211000, "refunds_total": -1000, "active_customers_count": 3 }, "promoter": { "id": 3920164, "status": "active", "cust_id": "", "email": "[email protected]", "created_at": "2022-04-26T15:28:24.800Z", "temp_password": null, "default_promotion_id": 4210919, "pref": "db1znwe", "default_ref_id": "8yi2epelut", "note": null, "w8_form_url": null, "w9_form_url": null, "parent_promoter_id": 5779418, "earnings_balance": { "cash": 52744 }, "current_balance": { "cash": 22044, "free_months": -1 }, "paid_balance": { "cash": 30700, "free_months": 1 }, "auth_token": "hjsmLQwMounBWxeqQS2cMXYp8epADJmB", "profile": { "id": 3947800, "first_name": "Pelu", "last_name": "", "website": "", "company_name": "", "phone_number": "", "address": "", "vat_id": "", "country": "", "paypal_email": "[email protected]", "avatar_url": "", "description": null, "social_accounts": { "twitter": { "url": "" }, "youtube": { "url": "" }, "facebook": { "url": "" }, "linkedin": { "url": "" }, "instagram": { "url": "" } } }, "promotions": [\ {\ "id": 4210919,\ "status": "offer_running",\ "ref_id": "8yi2epelut",\ "promo_code": "MAX-1234",\ "customer_promo_code": "",\ "target_reached_at": "2023-04-20T13:41:20.782Z",\ "promoter_id": 3920164,\ "campaign_id": 13228,\ "referral_link": "https://resilient-pegasus-e7ed60.netlify.app?fpr=8yi2epelut",\ "current_offer": {\ "id": 68621,\ "name": "20% discount coupon",\ "amount": 20,\ "unit": "discount_per",\ "default_promo_code": null\ },\ "current_referral_reward": {\ "id": 97806,\ "amount": 0,\ "type": "per_referral",\ "unit": "cash",\ "name": "20% recurring commission",\ "per_of_sale": 0,\ "default_promo_code": ""\ },\ "current_promotion_reward": null,\ "current_target_reward": null,\ "campaign_name": "erSecond FP Campaign",\ "hidden": false,\ "visitors_count": 192,\ "leads_count": 77,\ "customers_count": 15,\ "refunds_count": 2,\ "cancellations_count": 0,\ "sales_count": 96,\ "sales_total": 995542,\ "refunds_total": -2600,\ "active_customers_count": 15\ },\ {\ "id": 4309469,\ "status": "offer_running",\ "ref_id": "k7iip",\ "promo_code": null,\ "customer_promo_code": null,\ "target_reached_at": null,\ "promoter_id": 3920164,\ "campaign_id": 13414,\ "referral_link": "https://hirehex1.com?fpr=k7iip",\ "current_offer": {\ "id": 67212,\ "name": "5% discount coupon",\ "amount": 5,\ "unit": "discount_per",\ "default_promo_code": " MAXADA-5"\ },\ "current_referral_reward": {\ "id": 115047,\ "amount": 20,\ "type": "per_referral",\ "unit": "points",\ "name": "20 points",\ "per_of_sale": 0,\ "default_promo_code": ""\ },\ "current_promotion_reward": null,\ "current_target_reward": null,\ "campaign_name": "Braintree",\ "hidden": true,\ "visitors_count": 0,\ "leads_count": 1,\ "customers_count": 1,\ "refunds_count": 0,\ "cancellations_count": 0,\ "sales_count": 1,\ "sales_total": 10000,\ "refunds_total": 0,\ "active_customers_count": 1\ },\ {\ "id": 4210924,\ "status": "offer_running",\ "ref_id": "afpxunub",\ "promo_code": null,\ "customer_promo_code": null,\ "target_reached_at": null,\ "promoter_id": 3920164,\ "campaign_id": 13202,\ "referral_link": "https://www.cax.ws?_get=afpxunub",\ "current_offer": {\ "id": 67212,\ "name": "5% discount coupon",\ "amount": 5,\ "unit": "discount_per",\ "default_promo_code": " MAXADA-5"\ },\ "current_referral_reward": {\ "id": 128312,\ "amount": 0,\ "type": "per_referral",\ "unit": "cash",\ "name": "20% recurring commission",\ "per_of_sale": 20,\ "default_promo_code": ""\ },\ "current_promotion_reward": {\ "id": 68347,\ "amount": null,\ "type": "per_promotion",\ "unit": "free_months",\ "name": "Free subscription months",\ "per_of_sale": 0,\ "default_promo_code": null\ },\ "current_target_reward": null,\ "campaign_name": "Jaquelyn Ryan",\ "hidden": false,\ "visitors_count": 2,\ "leads_count": 4,\ "customers_count": 4,\ "refunds_count": 1,\ "cancellations_count": 1,\ "sales_count": 4,\ "sales_total": 211000,\ "refunds_total": -1000,\ "active_customers_count": 3\ }\ ] } } } [Reward Created](https://docs.firstpromoter.com/webhooks/reward-created) [Promoter Accepted](https://docs.firstpromoter.com/webhooks/promoter-accepted) ⌘I --- # Lead Signup - FirstPromoter Docs [Skip to main content](https://docs.firstpromoter.com/webhooks/lead-signup#content-area) [FirstPromoter Docs home page![light logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/light.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=6ded212b82547bec37a22e90f72eeb71)![dark logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/dark.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=c393ff83772047b8a444f78a1e393e7f)](https://docs.firstpromoter.com/) v2 Search... ⌘K Search... Navigation Webhooks Lead Signup [Documentation](https://docs.firstpromoter.com/introduction) [API Reference](https://docs.firstpromoter.com/api-reference-v2/api-admin/introduction) Response Copy { "event": { "id": 22736304, "type": "lead_signup", "created_at": "2024-10-03T13:45:20.103Z" }, "data": { "id": 21381518, "state": "signup", "email": "[email protected]", "uid": "", "customer_since": null, "cancelled_at": null, "plan_name": null, "suspicion": "no_suspicion", "username": null, "website": null, "created_at": "2024-10-03T13:45:20.031Z", "split_promotion_id": null, "custom_fields": null, "split_percentage_value": null, "visitor_sub_id": null, "promotion": { "id": 4210924, "status": "offer_running", "ref_id": "afpxunub", "promo_code": null, "customer_promo_code": null, "target_reached_at": null, "promoter_id": 3920164, "campaign_id": 13202, "referral_link": "https://www.cax.ws?_get=afpxunub", "current_offer": { "id": 67212, "name": "5% discount coupon", "amount": 5, "unit": "discount_per", "default_promo_code": " MAXADA-5" }, "current_referral_reward": { "id": 128312, "amount": 0, "type": "per_referral", "unit": "cash", "name": "20% recurring commission", "per_of_sale": 20, "default_promo_code": "" }, "current_promotion_reward": { "id": 68347, "amount": null, "type": "per_promotion", "unit": "free_months", "name": "Free subscription months", "per_of_sale": 0, "default_promo_code": null }, "current_target_reward": null, "campaign_name": "Jaquelyn Ryan", "hidden": false, "visitors_count": 2, "leads_count": 4, "customers_count": 3, "refunds_count": 1, "cancellations_count": 1, "sales_count": 3, "sales_total": 201000, "refunds_total": -1000, "active_customers_count": 2 }, "promoter": { "id": 3920164, "status": "active", "cust_id": "", "email": "[email protected]", "created_at": "2022-04-26T15:28:24.800Z", "temp_password": null, "default_promotion_id": 4210919, "pref": "db1znwe", "default_ref_id": "8yi2epelut", "note": null, "w8_form_url": null, "w9_form_url": null, "parent_promoter_id": 5779418, "earnings_balance": { "cash": 50744 }, "current_balance": { "cash": 20044, "free_months": -1 }, "paid_balance": { "cash": 30700, "free_months": 1 }, "auth_token": "hjsmLQwMounBWxeqQS2cMXYp8epADJmB", "profile": { "id": 3947800, "first_name": "Pelu", "last_name": "", "website": "", "company_name": "", "phone_number": "", "address": "", "vat_id": "", "country": "", "paypal_email": "[email protected]", "avatar_url": "", "description": null, "social_accounts": { "twitter": { "url": "" }, "youtube": { "url": "" }, "facebook": { "url": "" }, "linkedin": { "url": "" }, "instagram": { "url": "" } } }, "promotions": [\ {\ "id": 4210919,\ "status": "offer_running",\ "ref_id": "8yi2epelut",\ "promo_code": "MAX-1234",\ "customer_promo_code": "",\ "target_reached_at": "2023-04-20T13:41:20.782Z",\ "promoter_id": 3920164,\ "campaign_id": 13228,\ "referral_link": "https://resilient-pegasus-e7ed60.netlify.app?fpr=8yi2epelut",\ "current_offer": {\ "id": 68621,\ "name": "20% discount coupon",\ "amount": 20,\ "unit": "discount_per",\ "default_promo_code": null\ },\ "current_referral_reward": {\ "id": 97806,\ "amount": 0,\ "type": "per_referral",\ "unit": "cash",\ "name": "20% recurring commission",\ "per_of_sale": 0,\ "default_promo_code": ""\ },\ "current_promotion_reward": null,\ "current_target_reward": null,\ "campaign_name": "erSecond FP Campaign",\ "hidden": false,\ "visitors_count": 192,\ "leads_count": 77,\ "customers_count": 15,\ "refunds_count": 2,\ "cancellations_count": 0,\ "sales_count": 96,\ "sales_total": 995542,\ "refunds_total": -2600,\ "active_customers_count": 15\ },\ {\ "id": 4309469,\ "status": "offer_running",\ "ref_id": "k7iip",\ "promo_code": null,\ "customer_promo_code": null,\ "target_reached_at": null,\ "promoter_id": 3920164,\ "campaign_id": 13414,\ "referral_link": "https://hirehex1.com?fpr=k7iip",\ "current_offer": {\ "id": 67212,\ "name": "5% discount coupon",\ "amount": 5,\ "unit": "discount_per",\ "default_promo_code": " MAXADA-5"\ },\ "current_referral_reward": {\ "id": 115047,\ "amount": 20,\ "type": "per_referral",\ "unit": "points",\ "name": "20 points",\ "per_of_sale": 0,\ "default_promo_code": ""\ },\ "current_promotion_reward": null,\ "current_target_reward": null,\ "campaign_name": "Braintree",\ "hidden": true,\ "visitors_count": 0,\ "leads_count": 1,\ "customers_count": 1,\ "refunds_count": 0,\ "cancellations_count": 0,\ "sales_count": 1,\ "sales_total": 10000,\ "refunds_total": 0,\ "active_customers_count": 1\ },\ {\ "id": 4210924,\ "status": "offer_running",\ "ref_id": "afpxunub",\ "promo_code": null,\ "customer_promo_code": null,\ "target_reached_at": null,\ "promoter_id": 3920164,\ "campaign_id": 13202,\ "referral_link": "https://www.cax.ws?_get=afpxunub",\ "current_offer": {\ "id": 67212,\ "name": "5% discount coupon",\ "amount": 5,\ "unit": "discount_per",\ "default_promo_code": " MAXADA-5"\ },\ "current_referral_reward": {\ "id": 128312,\ "amount": 0,\ "type": "per_referral",\ "unit": "cash",\ "name": "20% recurring commission",\ "per_of_sale": 20,\ "default_promo_code": ""\ },\ "current_promotion_reward": {\ "id": 68347,\ "amount": null,\ "type": "per_promotion",\ "unit": "free_months",\ "name": "Free subscription months",\ "per_of_sale": 0,\ "default_promo_code": null\ },\ "current_target_reward": null,\ "campaign_name": "Jaquelyn Ryan",\ "hidden": false,\ "visitors_count": 2,\ "leads_count": 4,\ "customers_count": 3,\ "refunds_count": 1,\ "cancellations_count": 1,\ "sales_count": 3,\ "sales_total": 201000,\ "refunds_total": -1000,\ "active_customers_count": 2\ }\ ] } } } By setting up a webhook, your endpoint will receive an event when a lead signs up. [​](https://docs.firstpromoter.com/webhooks/lead-signup#response-paramerters) Response Paramerters ----------------------------------------------------------------------------------------------------- [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-event) Event Event Object Show properties [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-id) id string The Id of the event [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-type) type string Indicates the webhook event type, such as `lead_signup`. [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-created-at) created\_at string Timestamp of when the event occurred. [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-data) Data Data Object Show properties [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-id-1) id number The Id of the lead [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-status) status string The state of the lead [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-email) email string The email of the lead [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-uid) uid string The user id of the lead [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-customer-since) customer\_since string The date and time the lead became a customer [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-cancelled-at) cancelled\_at string The date and time the lead was cancelled [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-plan-name) plan\_name string The plan name the lead is subscribed to [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-suspicion) suspicion string This states if the addition of the lead is suspected to be fraudulent [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-username) username string The username of the lead [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-website) website string The website of the lead [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-created-at-1) created\_at string The date and time the lead was created [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-split-promotion-id) split\_promotion\_id number The split promotion id of the lead [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-split-percentage-value) split\_percentage\_value number The split percentage value of the lead [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-promoter) promoter Promoter Object Show properties [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-id-2) id number The Id of the promoter [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-status-1) status string The status of the promoter [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-cust-id) cust\_id string The customer id of the promoter [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-email-1) email string The email of the promoter [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-created-at-2) created\_at string The date the promoter was created [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-temp-password) temp\_password string The temporary password of the promoter [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-default-promotion-id) default\_promotion\_id number The default promotion id of the promoter [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-pref) pref string The pref of the promoter [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-default-ref-id) default\_ref\_id string The default referral id of the promoter [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-note) note string The note saved on the promoter profile by an admin [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-w8-form-url) w8\_form\_url string The w8 form url saved on the promoter profile by an admin [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-w9-form-url) w9\_form\_url string The w9 form url saved on the promoter profile by an admin [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-parent-promoter-id) parent\_promoter\_id number The parent promoter id of the promoter [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-earnings-balance) earnings\_balance number The earnings balance of the promoter [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-current-balance) current\_balance number The current balance of the promoter [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-paid-balance) paid\_balance number The paid balance of the promoter [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-auth-token) auth\_token string The auth token of the promoter [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-profile) profile Profile Object Show properties [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-id-3) id number The Id of the profile [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-first-name) first\_name string The first name of the profile [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-last-name) last\_name string The last name of the profile [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-website-1) website string The website of the profile [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-company-name) company\_name string The company name of the profile [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-phone-number) phone\_number string The phone number of the profile [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-address) address string The address of the profile [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-vat-id) vat\_id string The vat id of the profile [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-country) country string The country of the profile [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-paypal-email) paypal\_email string The paypal email of the profile [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-avatar-url) avatar\_url string The avatar url of the profile [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-description) description string The description of the profile [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-social-accounts) social\_accounts Social Accounts Object Show properties [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-tiktok) tiktok Social Account Object Show properties [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-url) url string The url of the social account [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-twitch) twitch Social Account Object Show properties [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-url-1) url string The url of the social account [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-twitter) twitter Social Account Object Show properties [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-url-2) url string The url of the social account [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-youtube) youtube Social Account Object Show properties [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-url-3) url string The url of the social account [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-facebook) facebook Social Account Object Show properties [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-url-4) url string The url of the social account [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-linkedin) linkedin Social Account Object Show properties [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-url-5) url string The url of the social account [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-instagram) instagram Social Account Object Show properties [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-url-6) url string The url of the social account [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-promotions) promotions Promotions Array Show properties [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-promotion) promotion Promotion Object Show properties [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-id-4) id number The Id of the promotion [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-status-2) status string The status of the promotion [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-ref-id) ref\_id string The referral id of the promotion [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-promo-code) promo\_code string The promo code of the promotion [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-customer-promo-code) customer\_promo\_code string The customer promo code of the promotion [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-target-reached-at) target\_reached\_at string The target reached at of the promotion [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-promoter-id) promoter\_id number The promoter id of the promotion [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-campaign-id) campaign\_id number The campaign id of the promotion [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-referral-link) referral\_link string The referral link of the promotion [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-current-offer) current\_offer Offer Object Show properties [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-id-5) id number The Id of the offer [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-name) name string The name of the offer [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-amount) amount number The amount of the offer [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-unit) unit string The unit of the offer [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-default-promo-code) default\_promo\_code string The default promo code of the offer [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-current-referral-reward) current\_referral\_reward Current referral reward Object Show properties [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-id-6) id number The Id of the referral reward [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-amount-1) amount number The amount of the referral reward [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-type-1) type string The type of the referral reward [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-unit-1) unit string The unit of the referral reward [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-name-1) name string The name of the referral reward [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-per-of-sale) per\_of\_sale number The per of sale of the referral reward [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-default-promo-code-1) default\_promo\_code string The default promo code of the referral reward [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-current-promotion-reward) current\_promotion\_reward Current promotion reward Object Show properties [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-id-7) id number The Id of the promotion reward [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-amount-2) amount number The amount of the promotion reward [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-type-2) type string The type of the promotion reward [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-unit-2) unit string The unit of the promotion reward [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-name-2) name string The name of the promotion reward [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-per-of-sale-1) per\_of\_sale number The per of sale of the promotion reward [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-default-promo-code-2) default\_promo\_code string The default promo code of the promotion reward [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-current-target-reward) current\_target\_reward Current target reward Object Show properties [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-id-8) id number The Id of the referral reward [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-amount-3) amount number The amount of the referral reward [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-type-3) type string The type of the referral reward [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-unit-3) unit string The unit of the referral reward [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-name-3) name string The name of the referral reward [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-per-of-sale-2) per\_of\_sale number The per of sale of the referral reward [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-default-promo-code-3) default\_promo\_code string The default promo code of the referral reward [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-campaign-name) campaign\_name string The name of the campaign [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-hidden) hidden boolean Whether the campaign is hidden [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-visitors-count) visitors\_count number The number of visitors [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-leads-count) leads\_count number The number of leads [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-customers-count) customers\_count number The number of customers [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-refunds-count) refunds\_count number The number of refunds [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-cancellations-count) cancellations\_count number The number of cancellations [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-sales-count) sales\_count number The number of sales [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-sales-total) sales\_total number The total sales [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-refunds-total) refunds\_total number The total refunds [​](https://docs.firstpromoter.com/webhooks/lead-signup#param-active-customers-count) active\_customers\_count number The number of active customers Response Copy { "event": { "id": 22736304, "type": "lead_signup", "created_at": "2024-10-03T13:45:20.103Z" }, "data": { "id": 21381518, "state": "signup", "email": "[email protected]", "uid": "", "customer_since": null, "cancelled_at": null, "plan_name": null, "suspicion": "no_suspicion", "username": null, "website": null, "created_at": "2024-10-03T13:45:20.031Z", "split_promotion_id": null, "custom_fields": null, "split_percentage_value": null, "visitor_sub_id": null, "promotion": { "id": 4210924, "status": "offer_running", "ref_id": "afpxunub", "promo_code": null, "customer_promo_code": null, "target_reached_at": null, "promoter_id": 3920164, "campaign_id": 13202, "referral_link": "https://www.cax.ws?_get=afpxunub", "current_offer": { "id": 67212, "name": "5% discount coupon", "amount": 5, "unit": "discount_per", "default_promo_code": " MAXADA-5" }, "current_referral_reward": { "id": 128312, "amount": 0, "type": "per_referral", "unit": "cash", "name": "20% recurring commission", "per_of_sale": 20, "default_promo_code": "" }, "current_promotion_reward": { "id": 68347, "amount": null, "type": "per_promotion", "unit": "free_months", "name": "Free subscription months", "per_of_sale": 0, "default_promo_code": null }, "current_target_reward": null, "campaign_name": "Jaquelyn Ryan", "hidden": false, "visitors_count": 2, "leads_count": 4, "customers_count": 3, "refunds_count": 1, "cancellations_count": 1, "sales_count": 3, "sales_total": 201000, "refunds_total": -1000, "active_customers_count": 2 }, "promoter": { "id": 3920164, "status": "active", "cust_id": "", "email": "[email protected]", "created_at": "2022-04-26T15:28:24.800Z", "temp_password": null, "default_promotion_id": 4210919, "pref": "db1znwe", "default_ref_id": "8yi2epelut", "note": null, "w8_form_url": null, "w9_form_url": null, "parent_promoter_id": 5779418, "earnings_balance": { "cash": 50744 }, "current_balance": { "cash": 20044, "free_months": -1 }, "paid_balance": { "cash": 30700, "free_months": 1 }, "auth_token": "hjsmLQwMounBWxeqQS2cMXYp8epADJmB", "profile": { "id": 3947800, "first_name": "Pelu", "last_name": "", "website": "", "company_name": "", "phone_number": "", "address": "", "vat_id": "", "country": "", "paypal_email": "[email protected]", "avatar_url": "", "description": null, "social_accounts": { "twitter": { "url": "" }, "youtube": { "url": "" }, "facebook": { "url": "" }, "linkedin": { "url": "" }, "instagram": { "url": "" } } }, "promotions": [\ {\ "id": 4210919,\ "status": "offer_running",\ "ref_id": "8yi2epelut",\ "promo_code": "MAX-1234",\ "customer_promo_code": "",\ "target_reached_at": "2023-04-20T13:41:20.782Z",\ "promoter_id": 3920164,\ "campaign_id": 13228,\ "referral_link": "https://resilient-pegasus-e7ed60.netlify.app?fpr=8yi2epelut",\ "current_offer": {\ "id": 68621,\ "name": "20% discount coupon",\ "amount": 20,\ "unit": "discount_per",\ "default_promo_code": null\ },\ "current_referral_reward": {\ "id": 97806,\ "amount": 0,\ "type": "per_referral",\ "unit": "cash",\ "name": "20% recurring commission",\ "per_of_sale": 0,\ "default_promo_code": ""\ },\ "current_promotion_reward": null,\ "current_target_reward": null,\ "campaign_name": "erSecond FP Campaign",\ "hidden": false,\ "visitors_count": 192,\ "leads_count": 77,\ "customers_count": 15,\ "refunds_count": 2,\ "cancellations_count": 0,\ "sales_count": 96,\ "sales_total": 995542,\ "refunds_total": -2600,\ "active_customers_count": 15\ },\ {\ "id": 4309469,\ "status": "offer_running",\ "ref_id": "k7iip",\ "promo_code": null,\ "customer_promo_code": null,\ "target_reached_at": null,\ "promoter_id": 3920164,\ "campaign_id": 13414,\ "referral_link": "https://hirehex1.com?fpr=k7iip",\ "current_offer": {\ "id": 67212,\ "name": "5% discount coupon",\ "amount": 5,\ "unit": "discount_per",\ "default_promo_code": " MAXADA-5"\ },\ "current_referral_reward": {\ "id": 115047,\ "amount": 20,\ "type": "per_referral",\ "unit": "points",\ "name": "20 points",\ "per_of_sale": 0,\ "default_promo_code": ""\ },\ "current_promotion_reward": null,\ "current_target_reward": null,\ "campaign_name": "Braintree",\ "hidden": true,\ "visitors_count": 0,\ "leads_count": 1,\ "customers_count": 1,\ "refunds_count": 0,\ "cancellations_count": 0,\ "sales_count": 1,\ "sales_total": 10000,\ "refunds_total": 0,\ "active_customers_count": 1\ },\ {\ "id": 4210924,\ "status": "offer_running",\ "ref_id": "afpxunub",\ "promo_code": null,\ "customer_promo_code": null,\ "target_reached_at": null,\ "promoter_id": 3920164,\ "campaign_id": 13202,\ "referral_link": "https://www.cax.ws?_get=afpxunub",\ "current_offer": {\ "id": 67212,\ "name": "5% discount coupon",\ "amount": 5,\ "unit": "discount_per",\ "default_promo_code": " MAXADA-5"\ },\ "current_referral_reward": {\ "id": 128312,\ "amount": 0,\ "type": "per_referral",\ "unit": "cash",\ "name": "20% recurring commission",\ "per_of_sale": 20,\ "default_promo_code": ""\ },\ "current_promotion_reward": {\ "id": 68347,\ "amount": null,\ "type": "per_promotion",\ "unit": "free_months",\ "name": "Free subscription months",\ "per_of_sale": 0,\ "default_promo_code": null\ },\ "current_target_reward": null,\ "campaign_name": "Jaquelyn Ryan",\ "hidden": false,\ "visitors_count": 2,\ "leads_count": 4,\ "customers_count": 3,\ "refunds_count": 1,\ "cancellations_count": 1,\ "sales_count": 3,\ "sales_total": 201000,\ "refunds_total": -1000,\ "active_customers_count": 2\ }\ ] } } } [Overview](https://docs.firstpromoter.com/webhooks/overview) [Reward Created](https://docs.firstpromoter.com/webhooks/reward-created) ⌘I --- # Promoter Accepted - FirstPromoter Docs [Skip to main content](https://docs.firstpromoter.com/webhooks/promoter-accepted#content-area) [FirstPromoter Docs home page![light logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/light.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=6ded212b82547bec37a22e90f72eeb71)![dark logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/dark.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=c393ff83772047b8a444f78a1e393e7f)](https://docs.firstpromoter.com/) v2 Search... ⌘K Search... Navigation Webhooks Promoter Accepted [Documentation](https://docs.firstpromoter.com/introduction) [API Reference](https://docs.firstpromoter.com/api-reference-v2/api-admin/introduction) Response Copy { "event": { "id": 22733469, "type": "promoter_accepted", "created_at": "2024-10-03T11:57:31.228Z" }, "data": { "state": "accepted", "campaign": { "id": 13202, "name": "Jaquelyn Ryan", "landing_url": "https://www.cax.ws", "description": "", "private": false, "color": "#42a5f5", "default_webhook_url": "https://h.albato.com/wh/38/1lfiorr/DQRARvqv1zQQuxMO4FKsgWJ66qVqwm9HcfvTqCqdfF0/", "auto_approve_rewards": true, "auto_approve_promoters": false, "offer": { "id": 67212, "name": "5% discount coupon", "amount": 5, "unit": "discount_per", "default_promo_code": " MAXADA-5" }, "referral_reward": { "id": 128312, "amount": 0, "type": "per_referral", "unit": "cash", "name": "20% recurring commission", "per_of_sale": 20, "default_promo_code": "" }, "promotion_reward": { "id": 68347, "amount": null, "type": "per_promotion", "unit": "free_months", "name": "Free subscription months", "per_of_sale": 0, "default_promo_code": null }, "target_reward": null }, "promoter": { "id": 9000754, "status": "active", "cust_id": null, "email": "[email protected]", "created_at": "2024-10-03T11:57:30.943Z", "temp_password": "VKD-uS", "default_promotion_id": 11027468, "pref": "bh4oj6x", "default_ref_id": "bhyrr", "note": null, "w8_form_url": null, "w9_form_url": null, "parent_promoter_id": null, "earnings_balance": null, "current_balance": null, "paid_balance": null, "auth_token": "nu9NhM6Hza-kybjZZJivC-FgMtxMrT_o", "profile": { "id": 9048173, "first_name": "Cooper", "last_name": "Faulkner", "website": "https://www.baxyzozocu.org.au", "company_name": "Dalton and Mcneil", "phone_number": null, "address": "", "vat_id": "", "country": "AU", "paypal_email": null, "avatar_url": null, "description": null, "social_accounts": { "tiktok": { "url": "" }, "twitch": { "url": "" }, "twitter": { "url": "" }, "youtube": { "url": "" }, "facebook": { "url": "" }, "linkedin": { "url": "" }, "instagram": { "url": "" } } }, "promotions": [\ {\ "id": 11027468,\ "status": "offer_running",\ "ref_id": "bhyrr",\ "promo_code": null,\ "customer_promo_code": null,\ "target_reached_at": null,\ "promoter_id": 9000754,\ "campaign_id": 13202,\ "referral_link": "https://www.cax.ws?_get=bhyrr",\ "current_offer": {\ "id": 67212,\ "name": "5% discount coupon",\ "amount": 5,\ "unit": "discount_per",\ "default_promo_code": " MAXADA-5"\ },\ "current_referral_reward": {\ "id": 128312,\ "amount": 0,\ "type": "per_referral",\ "unit": "cash",\ "name": "20% recurring commission",\ "per_of_sale": 20,\ "default_promo_code": ""\ },\ "current_promotion_reward": {\ "id": 68347,\ "amount": null,\ "type": "per_promotion",\ "unit": "free_months",\ "name": "Free subscription months",\ "per_of_sale": 0,\ "default_promo_code": null\ },\ "current_target_reward": null,\ "campaign_name": "Jaquelyn Ryan",\ "hidden": false,\ "visitors_count": 0,\ "leads_count": 0,\ "customers_count": 0,\ "refunds_count": 0,\ "cancellations_count": 0,\ "sales_count": 0,\ "sales_total": 0,\ "refunds_total": 0,\ "active_customers_count": 0\ }\ ] }, "promotion": { "id": 11027468, "status": "offer_running", "ref_id": "bhyrr", "promo_code": null, "customer_promo_code": null, "target_reached_at": null, "promoter_id": 9000754, "campaign_id": 13202, "referral_link": "https://www.cax.ws?_get=bhyrr", "current_offer": { "id": 67212, "name": "5% discount coupon", "amount": 5, "unit": "discount_per", "default_promo_code": " MAXADA-5" }, "current_referral_reward": { "id": 128312, "amount": 0, "type": "per_referral", "unit": "cash", "name": "20% recurring commission", "per_of_sale": 20, "default_promo_code": "" }, "current_promotion_reward": { "id": 68347, "amount": null, "type": "per_promotion", "unit": "free_months", "name": "Free subscription months", "per_of_sale": 0, "default_promo_code": null }, "current_target_reward": null, "campaign_name": "Jaquelyn Ryan", "hidden": false, "visitors_count": 0, "leads_count": 0, "customers_count": 0, "refunds_count": 0, "cancellations_count": 0, "sales_count": 0, "sales_total": 0, "refunds_total": 0, "active_customers_count": 0 } } } By setting up a webhook, your endpoint will receive an event when a promoter is created. [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#response-paramerters) Response Paramerters ----------------------------------------------------------------------------------------------------------- [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-event) Event Event Object Show properties [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-id) id string The Id of the event [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-type) type string Indicates the webhook event type, such as `promoter_accepted`. [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-created-at) created\_at string Timestamp of when the event occurred. [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-data) Data Data Object Show properties [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-state) state string Current state of the promoter in relation to the campaign (e.g., “accepted”). [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-campaign) campaign Campaign Object Show properties [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-id-1) id number The Id of the campaign [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-name) name string The name of the campaign [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-landing-url) landing\_url string The landing url of the campaign [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-description) description string The description of the campaign [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-private) private boolean Whether the campaign is private [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-color) color string The color of the campaign [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-default-webhook-url) default\_webhook\_url string The default webhook url of the campaign [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-auto-approve-rewards) auto\_approve\_rewards boolean Whether the campaign automatically approves rewards [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-auto-approve-promoters) auto\_approve\_promoters boolean Whether the campaign automatically approves promoters [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-offer) offer Offer Object Show properties [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-id-2) id number The Id of the offer [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-name-1) name string The name of the offer [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-amount) amount number The amount of the offer [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-unit) unit string The unit of the offer [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-default-promo-code) default\_promo\_code string The default promo code of the offer [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-referral-reward) referral\_reward Referral Reward Object Show properties [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-id-3) id number The Id of the referral reward [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-amount-1) amount number The amount of the referral reward [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-type-1) type string The type of the referral reward [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-unit-1) unit string The unit of the referral reward [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-name-2) name string The name of the referral reward [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-per-of-sale) per\_of\_sale number The per of sale of the referral reward [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-default-promo-code-1) default\_promo\_code string The default promo code of the referral reward [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-promotion-reward) promotion\_reward Promotion Reward Object Show properties [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-id-4) id number The Id of the promotion reward [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-amount-2) amount number The amount of the promotion reward [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-type-2) type string The type of the promotion reward [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-unit-2) unit string The unit of the promotion reward [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-name-3) name string The name of the promotion reward [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-per-of-sale-1) per\_of\_sale number The per of sale of the promotion reward [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-default-promo-code-2) default\_promo\_code string The default promo code of the promotion reward [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-target-reward) target\_reward string The target reward of the campaign [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-promoter) promoter Promoter Object Show properties [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-id-5) id number The Id of the promoter [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-status) status string The status of the promoter [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-cust-id) cust\_id string The customer id of the promoter [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-email) email string The email of the promoter [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-created-at-1) created\_at string The date the promoter was created [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-temp-password) temp\_password string The temporary password of the promoter [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-default-promotion-id) default\_promotion\_id number The default promotion id of the promoter [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-pref) pref string The pref of the promoter [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-default-ref-id) default\_ref\_id string The default referral id of the promoter [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-note) note string The note saved on the promoter profile by an admin [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-w8-form-url) w8\_form\_url string The w8 form url saved on the promoter profile by an admin [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-w9-form-url) w9\_form\_url string The w9 form url saved on the promoter profile by an admin [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-parent-promoter-id) parent\_promoter\_id number The parent promoter id of the promoter [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-earnings-balance) earnings\_balance number The earnings balance of the promoter [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-current-balance) current\_balance number The current balance of the promoter [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-paid-balance) paid\_balance number The paid balance of the promoter [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-auth-token) auth\_token string The auth token of the promoter [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-profile) profile Profile Object Show properties [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-id-6) id number The Id of the profile [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-first-name) first\_name string The first name of the profile [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-last-name) last\_name string The last name of the profile [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-website) website string The website of the profile [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-company-name) company\_name string The company name of the profile [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-phone-number) phone\_number string The phone number of the profile [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-address) address string The address of the profile [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-vat-id) vat\_id string The vat id of the profile [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-country) country string The country of the profile [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-paypal-email) paypal\_email string The paypal email of the profile [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-avatar-url) avatar\_url string The avatar url of the profile [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-description-1) description string The description of the profile [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-social-accounts) social\_accounts Social Accounts Object Show properties [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-tiktok) tiktok Social Account Object Show properties [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-url) url string The url of the social account [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-twitch) twitch Social Account Object Show properties [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-url-1) url string The url of the social account [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-twitter) twitter Social Account Object Show properties [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-url-2) url string The url of the social account [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-youtube) youtube Social Account Object Show properties [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-url-3) url string The url of the social account [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-facebook) facebook Social Account Object Show properties [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-url-4) url string The url of the social account [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-linkedin) linkedin Social Account Object Show properties [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-url-5) url string The url of the social account [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-instagram) instagram Social Account Object Show properties [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-url-6) url string The url of the social account [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-promotions) promotions Promotions Array Show properties [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-promotion) promotion Promotion Object Show properties [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-id-7) id number The Id of the promotion [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-status-1) status string The status of the promotion [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-ref-id) ref\_id string The referral id of the promotion [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-promo-code) promo\_code string The promo code of the promotion [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-customer-promo-code) customer\_promo\_code string The customer promo code of the promotion [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-target-reached-at) target\_reached\_at string The target reached at of the promotion [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-promoter-id) promoter\_id number The promoter id of the promotion [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-campaign-id) campaign\_id number The campaign id of the promotion [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-referral-link) referral\_link string The referral link of the promotion [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-current-offer) current\_offer Offer Object Show properties [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-id-8) id number The Id of the offer [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-name-4) name string The name of the offer [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-amount-3) amount number The amount of the offer [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-unit-3) unit string The unit of the offer [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-default-promo-code-3) default\_promo\_code string The default promo code of the offer [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-current-referral-reward) current\_referral\_reward Current referral reward Object Show properties [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-id-9) id number The Id of the referral reward [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-amount-4) amount number The amount of the referral reward [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-type-3) type string The type of the referral reward [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-unit-4) unit string The unit of the referral reward [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-name-5) name string The name of the referral reward [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-per-of-sale-2) per\_of\_sale number The per of sale of the referral reward [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-default-promo-code-4) default\_promo\_code string The default promo code of the referral reward [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-current-promotion-reward) current\_promotion\_reward Current promotion reward Object Show properties [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-id-10) id number The Id of the promotion reward [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-amount-5) amount number The amount of the promotion reward [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-type-4) type string The type of the promotion reward [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-unit-5) unit string The unit of the promotion reward [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-name-6) name string The name of the promotion reward [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-per-of-sale-3) per\_of\_sale number The per of sale of the promotion reward [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-default-promo-code-5) default\_promo\_code string The default promo code of the promotion reward [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-current-target-reward) current\_target\_reward Current target reward Object Show properties [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-id-11) id number The Id of the referral reward [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-amount-6) amount number The amount of the referral reward [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-type-5) type string The type of the referral reward [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-unit-6) unit string The unit of the referral reward [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-name-7) name string The name of the referral reward [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-per-of-sale-4) per\_of\_sale number The per of sale of the referral reward [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-default-promo-code-6) default\_promo\_code string The default promo code of the referral reward [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-campaign-name) campaign\_name string The name of the campaign [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-hidden) hidden boolean Whether the campaign is hidden [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-visitors-count) visitors\_count number The number of visitors [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-leads-count) leads\_count number The number of leads [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-customers-count) customers\_count number The number of customers [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-refunds-count) refunds\_count number The number of refunds [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-cancellations-count) cancellations\_count number The number of cancellations [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-sales-count) sales\_count number The number of sales [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-sales-total) sales\_total number The total sales [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-refunds-total) refunds\_total number The total refunds [​](https://docs.firstpromoter.com/webhooks/promoter-accepted#param-active-customers-count) active\_customers\_count number The number of active customers Response Copy { "event": { "id": 22733469, "type": "promoter_accepted", "created_at": "2024-10-03T11:57:31.228Z" }, "data": { "state": "accepted", "campaign": { "id": 13202, "name": "Jaquelyn Ryan", "landing_url": "https://www.cax.ws", "description": "", "private": false, "color": "#42a5f5", "default_webhook_url": "https://h.albato.com/wh/38/1lfiorr/DQRARvqv1zQQuxMO4FKsgWJ66qVqwm9HcfvTqCqdfF0/", "auto_approve_rewards": true, "auto_approve_promoters": false, "offer": { "id": 67212, "name": "5% discount coupon", "amount": 5, "unit": "discount_per", "default_promo_code": " MAXADA-5" }, "referral_reward": { "id": 128312, "amount": 0, "type": "per_referral", "unit": "cash", "name": "20% recurring commission", "per_of_sale": 20, "default_promo_code": "" }, "promotion_reward": { "id": 68347, "amount": null, "type": "per_promotion", "unit": "free_months", "name": "Free subscription months", "per_of_sale": 0, "default_promo_code": null }, "target_reward": null }, "promoter": { "id": 9000754, "status": "active", "cust_id": null, "email": "[email protected]", "created_at": "2024-10-03T11:57:30.943Z", "temp_password": "VKD-uS", "default_promotion_id": 11027468, "pref": "bh4oj6x", "default_ref_id": "bhyrr", "note": null, "w8_form_url": null, "w9_form_url": null, "parent_promoter_id": null, "earnings_balance": null, "current_balance": null, "paid_balance": null, "auth_token": "nu9NhM6Hza-kybjZZJivC-FgMtxMrT_o", "profile": { "id": 9048173, "first_name": "Cooper", "last_name": "Faulkner", "website": "https://www.baxyzozocu.org.au", "company_name": "Dalton and Mcneil", "phone_number": null, "address": "", "vat_id": "", "country": "AU", "paypal_email": null, "avatar_url": null, "description": null, "social_accounts": { "tiktok": { "url": "" }, "twitch": { "url": "" }, "twitter": { "url": "" }, "youtube": { "url": "" }, "facebook": { "url": "" }, "linkedin": { "url": "" }, "instagram": { "url": "" } } }, "promotions": [\ {\ "id": 11027468,\ "status": "offer_running",\ "ref_id": "bhyrr",\ "promo_code": null,\ "customer_promo_code": null,\ "target_reached_at": null,\ "promoter_id": 9000754,\ "campaign_id": 13202,\ "referral_link": "https://www.cax.ws?_get=bhyrr",\ "current_offer": {\ "id": 67212,\ "name": "5% discount coupon",\ "amount": 5,\ "unit": "discount_per",\ "default_promo_code": " MAXADA-5"\ },\ "current_referral_reward": {\ "id": 128312,\ "amount": 0,\ "type": "per_referral",\ "unit": "cash",\ "name": "20% recurring commission",\ "per_of_sale": 20,\ "default_promo_code": ""\ },\ "current_promotion_reward": {\ "id": 68347,\ "amount": null,\ "type": "per_promotion",\ "unit": "free_months",\ "name": "Free subscription months",\ "per_of_sale": 0,\ "default_promo_code": null\ },\ "current_target_reward": null,\ "campaign_name": "Jaquelyn Ryan",\ "hidden": false,\ "visitors_count": 0,\ "leads_count": 0,\ "customers_count": 0,\ "refunds_count": 0,\ "cancellations_count": 0,\ "sales_count": 0,\ "sales_total": 0,\ "refunds_total": 0,\ "active_customers_count": 0\ }\ ] }, "promotion": { "id": 11027468, "status": "offer_running", "ref_id": "bhyrr", "promo_code": null, "customer_promo_code": null, "target_reached_at": null, "promoter_id": 9000754, "campaign_id": 13202, "referral_link": "https://www.cax.ws?_get=bhyrr", "current_offer": { "id": 67212, "name": "5% discount coupon", "amount": 5, "unit": "discount_per", "default_promo_code": " MAXADA-5" }, "current_referral_reward": { "id": 128312, "amount": 0, "type": "per_referral", "unit": "cash", "name": "20% recurring commission", "per_of_sale": 20, "default_promo_code": "" }, "current_promotion_reward": { "id": 68347, "amount": null, "type": "per_promotion", "unit": "free_months", "name": "Free subscription months", "per_of_sale": 0, "default_promo_code": null }, "current_target_reward": null, "campaign_name": "Jaquelyn Ryan", "hidden": false, "visitors_count": 0, "leads_count": 0, "customers_count": 0, "refunds_count": 0, "cancellations_count": 0, "sales_count": 0, "sales_total": 0, "refunds_total": 0, "active_customers_count": 0 } } } [New Customer](https://docs.firstpromoter.com/webhooks/new-customer) [Fulfilment Pending](https://docs.firstpromoter.com/webhooks/fulfilment-pending) ⌘I --- # Reward Created - FirstPromoter Docs [Skip to main content](https://docs.firstpromoter.com/webhooks/reward-created#content-area) [FirstPromoter Docs home page![light logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/light.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=6ded212b82547bec37a22e90f72eeb71)![dark logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/dark.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=c393ff83772047b8a444f78a1e393e7f)](https://docs.firstpromoter.com/) v2 Search... ⌘K Search... Navigation Webhooks Reward Created [Documentation](https://docs.firstpromoter.com/introduction) [API Reference](https://docs.firstpromoter.com/api-reference-v2/api-admin/introduction) Response Copy { "event": { "id": 22737431, "type": "reward_created", "created_at": "2024-10-03T14:23:20.791Z" }, "data": { "id": 11174868, "status": "approved", "amount": 200, "unit": "cash", "created_at": "2024-10-03T14:23:20.495Z", "lead": { "id": 21381518, "state": "active", "email": "[email protected]", "uid": "", "customer_since": "2024-10-03T14:23:20.495Z", "cancelled_at": null, "plan_name": null, "suspicion": "no_suspicion", "username": null, "website": null, "created_at": "2024-10-03T13:45:20.031Z", "split_promotion_id": null, "custom_fields": null, "split_percentage_value": null, "visitor_sub_id": null }, "event_id": "Sit1234_id", "conversion_amount": 10000, "tier_level": 2, "split_type": null, "promoter": { "id": 5779418, "status": "active", "cust_id": "Todd Mccormick Plc", "email": "[email protected]", "created_at": "2023-05-03T18:33:55.055Z", "temp_password": "9jCRDdmA", "default_promotion_id": 6250255, "pref": "wo05sqe", "default_ref_id": "gusdc", "note": null, "w8_form_url": null, "w9_form_url": null, "parent_promoter_id": 5772992, "earnings_balance": { "cash": 4200, "credits": 60 }, "current_balance": { "cash": 4200 }, "paid_balance": { "credits": 60 }, "auth_token": "-RjCBDM8EkjfzzzCgpNBdV6VVLqMfttb", "profile": { "id": 5814797, "first_name": "Ulysses", "last_name": "Watson", "website": "", "company_name": "", "phone_number": "", "address": "", "vat_id": "", "country": "PT", "paypal_email": null, "avatar_url": "", "description": null, "social_accounts": { "twitter": { "url": "" }, "youtube": { "url": "" }, "facebook": { "url": "" }, "linkedin": { "url": "" }, "instagram": { "url": "" } } }, "promotions": [\ {\ "id": 6238498,\ "status": "offer_inactive",\ "ref_id": "u1lxd",\ "promo_code": null,\ "customer_promo_code": "xyz1234",\ "target_reached_at": null,\ "promoter_id": 5779418,\ "campaign_id": 13313,\ "referral_link": "http://localhost:3001?fgt=qwert&fpr=u1lxd",\ "current_offer": null,\ "current_referral_reward": {\ "id": 116314,\ "amount": 0,\ "type": "per_referral",\ "unit": "cash",\ "name": "10% recurring commission",\ "per_of_sale": 10,\ "default_promo_code": ""\ },\ "current_promotion_reward": {\ "id": 85713,\ "amount": 2000,\ "type": "per_promotion",\ "unit": "cash",\ "name": "$20 cash reward",\ "per_of_sale": 0,\ "default_promo_code": ""\ },\ "current_target_reward": null,\ "campaign_name": "Highlevel Campaign",\ "hidden": true,\ "visitors_count": 2,\ "leads_count": 3,\ "customers_count": 3,\ "refunds_count": 0,\ "cancellations_count": 0,\ "sales_count": 3,\ "sales_total": 18000,\ "refunds_total": 0,\ "active_customers_count": 3\ },\ {\ "id": 9438768,\ "status": "offer_running",\ "ref_id": "jqagt",\ "promo_code": null,\ "customer_promo_code": null,\ "target_reached_at": null,\ "promoter_id": 5779418,\ "campaign_id": 13202,\ "referral_link": "https://www.cax.ws?_get=jqagt",\ "current_offer": {\ "id": 67212,\ "name": "5% discount coupon",\ "amount": 5,\ "unit": "discount_per",\ "default_promo_code": " MAXADA-5"\ },\ "current_referral_reward": {\ "id": 128312,\ "amount": 0,\ "type": "per_referral",\ "unit": "cash",\ "name": "20% recurring commission",\ "per_of_sale": 20,\ "default_promo_code": ""\ },\ "current_promotion_reward": {\ "id": 68347,\ "amount": null,\ "type": "per_promotion",\ "unit": "free_months",\ "name": "Free subscription months",\ "per_of_sale": 0,\ "default_promo_code": null\ },\ "current_target_reward": null,\ "campaign_name": "Jaquelyn Ryan",\ "hidden": true,\ "visitors_count": 0,\ "leads_count": 0,\ "customers_count": 0,\ "refunds_count": 0,\ "cancellations_count": 0,\ "sales_count": 0,\ "sales_total": 0,\ "refunds_total": 0,\ "active_customers_count": 0\ },\ {\ "id": 6250255,\ "status": "offer_running",\ "ref_id": "gusdc",\ "promo_code": "rXqBjtPG",\ "customer_promo_code": "NEWCOUP",\ "target_reached_at": null,\ "promoter_id": 5779418,\ "campaign_id": 13228,\ "referral_link": "https://resilient-pegasus-e7ed60.netlify.app?fpr=gusdc",\ "current_offer": {\ "id": 92509,\ "name": "20% discount coupon",\ "amount": 20,\ "unit": "discount_per",\ "default_promo_code": null\ },\ "current_referral_reward": {\ "id": 120200,\ "amount": 0,\ "type": "per_referral",\ "unit": "cash",\ "name": "20% recurring commission",\ "per_of_sale": 20,\ "default_promo_code": ""\ },\ "current_promotion_reward": null,\ "current_target_reward": null,\ "campaign_name": "erSecond FP Campaign",\ "hidden": false,\ "visitors_count": 0,\ "leads_count": 0,\ "customers_count": 0,\ "refunds_count": 0,\ "cancellations_count": 0,\ "sales_count": 0,\ "sales_total": 0,\ "refunds_total": 0,\ "active_customers_count": 0\ }\ ] }, "promotion": { "id": 9438768, "status": "offer_running", "ref_id": "jqagt", "promo_code": null, "customer_promo_code": null, "target_reached_at": null, "promoter_id": 5779418, "campaign_id": 13202, "referral_link": "https://www.cax.ws?_get=jqagt", "current_offer": { "id": 67212, "name": "5% discount coupon", "amount": 5, "unit": "discount_per", "default_promo_code": " MAXADA-5" }, "current_referral_reward": { "id": 128312, "amount": 0, "type": "per_referral", "unit": "cash", "name": "20% recurring commission", "per_of_sale": 20, "default_promo_code": "" }, "current_promotion_reward": { "id": 68347, "amount": null, "type": "per_promotion", "unit": "free_months", "name": "Free subscription months", "per_of_sale": 0, "default_promo_code": null }, "current_target_reward": null, "campaign_name": "Jaquelyn Ryan", "hidden": true, "visitors_count": 0, "leads_count": 0, "customers_count": 0, "refunds_count": 0, "cancellations_count": 0, "sales_count": 0, "sales_total": 0, "refunds_total": 0, "active_customers_count": 0 } } } By setting up a webhook, your endpoint will receive an event when a reward is generated. This event is triggered anytime a reward is generated. [​](https://docs.firstpromoter.com/webhooks/reward-created#response-paramerters) Response Paramerters -------------------------------------------------------------------------------------------------------- [​](https://docs.firstpromoter.com/webhooks/reward-created#param-event) Event Event Object Show properties [​](https://docs.firstpromoter.com/webhooks/reward-created#param-id) id string The Id of the event [​](https://docs.firstpromoter.com/webhooks/reward-created#param-type) type string Indicates the webhook event type, such as `reward_created`. [​](https://docs.firstpromoter.com/webhooks/reward-created#param-created-at) created\_at string Timestamp of when the event occurred. [​](https://docs.firstpromoter.com/webhooks/reward-created#param-data) Data Data Object Show properties [​](https://docs.firstpromoter.com/webhooks/reward-created#param-id-1) id number The Id of the reward [​](https://docs.firstpromoter.com/webhooks/reward-created#param-status) status string The status of the reward [​](https://docs.firstpromoter.com/webhooks/reward-created#param-amount) amount number The reward amount [​](https://docs.firstpromoter.com/webhooks/reward-created#param-unit) unit string The unit of the reward [​](https://docs.firstpromoter.com/webhooks/reward-created#param-created-at-1) created\_at string The date and time the reward was created [​](https://docs.firstpromoter.com/webhooks/reward-created#param-lead) lead Lead Object Show properties [​](https://docs.firstpromoter.com/webhooks/reward-created#param-id-2) id number The Id of the lead [​](https://docs.firstpromoter.com/webhooks/reward-created#param-status-1) status string The state of the lead [​](https://docs.firstpromoter.com/webhooks/reward-created#param-email) email string The email of the lead [​](https://docs.firstpromoter.com/webhooks/reward-created#param-uid) uid string The user id of the lead [​](https://docs.firstpromoter.com/webhooks/reward-created#param-customer-since) customer\_since string The date and time the lead became a customer [​](https://docs.firstpromoter.com/webhooks/reward-created#param-cancelled-at) cancelled\_at string The date and time the lead was cancelled [​](https://docs.firstpromoter.com/webhooks/reward-created#param-plan-name) plan\_name string The plan name the lead is subscribed to [​](https://docs.firstpromoter.com/webhooks/reward-created#param-suspicion) suspicion string This states if the addition of the lead is suspected to be fraudulent [​](https://docs.firstpromoter.com/webhooks/reward-created#param-username) username string The username of the lead [​](https://docs.firstpromoter.com/webhooks/reward-created#param-website) website string The website of the lead [​](https://docs.firstpromoter.com/webhooks/reward-created#param-created-at-2) created\_at string The date and time the lead was created [​](https://docs.firstpromoter.com/webhooks/reward-created#param-split-promotion-id) split\_promotion\_id number The split promotion id of the lead [​](https://docs.firstpromoter.com/webhooks/reward-created#param-split-percentage-value) split\_percentage\_value number The split percentage value of the lead [​](https://docs.firstpromoter.com/webhooks/reward-created#param-event-id) event\_id string The Id of the event [​](https://docs.firstpromoter.com/webhooks/reward-created#param-conversion-amount) conversion\_amount number The conversion amount [​](https://docs.firstpromoter.com/webhooks/reward-created#param-tier-level) tier\_level number The tier level [​](https://docs.firstpromoter.com/webhooks/reward-created#param-split-type) split\_type string The split type [​](https://docs.firstpromoter.com/webhooks/reward-created#param-promoter) promoter Promoter Object Show properties [​](https://docs.firstpromoter.com/webhooks/reward-created#param-id-3) id number The Id of the promoter [​](https://docs.firstpromoter.com/webhooks/reward-created#param-status-2) status string The status of the promoter [​](https://docs.firstpromoter.com/webhooks/reward-created#param-cust-id) cust\_id string The customer id of the promoter [​](https://docs.firstpromoter.com/webhooks/reward-created#param-email-1) email string The email of the promoter [​](https://docs.firstpromoter.com/webhooks/reward-created#param-created-at-3) created\_at string The date the promoter was created [​](https://docs.firstpromoter.com/webhooks/reward-created#param-temp-password) temp\_password string The temporary password of the promoter [​](https://docs.firstpromoter.com/webhooks/reward-created#param-default-promotion-id) default\_promotion\_id number The default promotion id of the promoter [​](https://docs.firstpromoter.com/webhooks/reward-created#param-pref) pref string The pref of the promoter [​](https://docs.firstpromoter.com/webhooks/reward-created#param-default-ref-id) default\_ref\_id string The default referral id of the promoter [​](https://docs.firstpromoter.com/webhooks/reward-created#param-note) note string The note saved on the promoter profile by an admin [​](https://docs.firstpromoter.com/webhooks/reward-created#param-w8-form-url) w8\_form\_url string The w8 form url saved on the promoter profile by an admin [​](https://docs.firstpromoter.com/webhooks/reward-created#param-w9-form-url) w9\_form\_url string The w9 form url saved on the promoter profile by an admin [​](https://docs.firstpromoter.com/webhooks/reward-created#param-parent-promoter-id) parent\_promoter\_id number The parent promoter id of the promoter [​](https://docs.firstpromoter.com/webhooks/reward-created#param-earnings-balance) earnings\_balance number The earnings balance of the promoter [​](https://docs.firstpromoter.com/webhooks/reward-created#param-current-balance) current\_balance number The current balance of the promoter [​](https://docs.firstpromoter.com/webhooks/reward-created#param-paid-balance) paid\_balance number The paid balance of the promoter [​](https://docs.firstpromoter.com/webhooks/reward-created#param-auth-token) auth\_token string The auth token of the promoter [​](https://docs.firstpromoter.com/webhooks/reward-created#param-profile) profile Profile Object Show properties [​](https://docs.firstpromoter.com/webhooks/reward-created#param-id-4) id number The Id of the profile [​](https://docs.firstpromoter.com/webhooks/reward-created#param-first-name) first\_name string The first name of the profile [​](https://docs.firstpromoter.com/webhooks/reward-created#param-last-name) last\_name string The last name of the profile [​](https://docs.firstpromoter.com/webhooks/reward-created#param-website-1) website string The website of the profile [​](https://docs.firstpromoter.com/webhooks/reward-created#param-company-name) company\_name string The company name of the profile [​](https://docs.firstpromoter.com/webhooks/reward-created#param-phone-number) phone\_number string The phone number of the profile [​](https://docs.firstpromoter.com/webhooks/reward-created#param-address) address string The address of the profile [​](https://docs.firstpromoter.com/webhooks/reward-created#param-vat-id) vat\_id string The vat id of the profile [​](https://docs.firstpromoter.com/webhooks/reward-created#param-country) country string The country of the profile [​](https://docs.firstpromoter.com/webhooks/reward-created#param-paypal-email) paypal\_email string The paypal email of the profile [​](https://docs.firstpromoter.com/webhooks/reward-created#param-avatar-url) avatar\_url string The avatar url of the profile [​](https://docs.firstpromoter.com/webhooks/reward-created#param-description) description string The description of the profile [​](https://docs.firstpromoter.com/webhooks/reward-created#param-social-accounts) social\_accounts Social Accounts Object Show properties [​](https://docs.firstpromoter.com/webhooks/reward-created#param-tiktok) tiktok Social Account Object Show properties [​](https://docs.firstpromoter.com/webhooks/reward-created#param-url) url string The url of the social account [​](https://docs.firstpromoter.com/webhooks/reward-created#param-twitch) twitch Social Account Object Show properties [​](https://docs.firstpromoter.com/webhooks/reward-created#param-url-1) url string The url of the social account [​](https://docs.firstpromoter.com/webhooks/reward-created#param-twitter) twitter Social Account Object Show properties [​](https://docs.firstpromoter.com/webhooks/reward-created#param-url-2) url string The url of the social account [​](https://docs.firstpromoter.com/webhooks/reward-created#param-youtube) youtube Social Account Object Show properties [​](https://docs.firstpromoter.com/webhooks/reward-created#param-url-3) url string The url of the social account [​](https://docs.firstpromoter.com/webhooks/reward-created#param-facebook) facebook Social Account Object Show properties [​](https://docs.firstpromoter.com/webhooks/reward-created#param-url-4) url string The url of the social account [​](https://docs.firstpromoter.com/webhooks/reward-created#param-linkedin) linkedin Social Account Object Show properties [​](https://docs.firstpromoter.com/webhooks/reward-created#param-url-5) url string The url of the social account [​](https://docs.firstpromoter.com/webhooks/reward-created#param-instagram) instagram Social Account Object Show properties [​](https://docs.firstpromoter.com/webhooks/reward-created#param-url-6) url string The url of the social account [​](https://docs.firstpromoter.com/webhooks/reward-created#param-promotions) promotions Promotions Array Show properties [​](https://docs.firstpromoter.com/webhooks/reward-created#param-promotion) promotion Promotion Object Show properties [​](https://docs.firstpromoter.com/webhooks/reward-created#param-id-5) id number The Id of the promotion [​](https://docs.firstpromoter.com/webhooks/reward-created#param-status-3) status string The status of the promotion [​](https://docs.firstpromoter.com/webhooks/reward-created#param-ref-id) ref\_id string The referral id of the promotion [​](https://docs.firstpromoter.com/webhooks/reward-created#param-promo-code) promo\_code string The promo code of the promotion [​](https://docs.firstpromoter.com/webhooks/reward-created#param-customer-promo-code) customer\_promo\_code string The customer promo code of the promotion [​](https://docs.firstpromoter.com/webhooks/reward-created#param-target-reached-at) target\_reached\_at string The target reached at of the promotion [​](https://docs.firstpromoter.com/webhooks/reward-created#param-promoter-id) promoter\_id number The promoter id of the promotion [​](https://docs.firstpromoter.com/webhooks/reward-created#param-campaign-id) campaign\_id number The campaign id of the promotion [​](https://docs.firstpromoter.com/webhooks/reward-created#param-referral-link) referral\_link string The referral link of the promotion [​](https://docs.firstpromoter.com/webhooks/reward-created#param-current-offer) current\_offer Offer Object Show properties [​](https://docs.firstpromoter.com/webhooks/reward-created#param-id-6) id number The Id of the offer [​](https://docs.firstpromoter.com/webhooks/reward-created#param-name) name string The name of the offer [​](https://docs.firstpromoter.com/webhooks/reward-created#param-amount-1) amount number The amount of the offer [​](https://docs.firstpromoter.com/webhooks/reward-created#param-unit-1) unit string The unit of the offer [​](https://docs.firstpromoter.com/webhooks/reward-created#param-default-promo-code) default\_promo\_code string The default promo code of the offer [​](https://docs.firstpromoter.com/webhooks/reward-created#param-current-referral-reward) current\_referral\_reward Current referral reward Object Show properties [​](https://docs.firstpromoter.com/webhooks/reward-created#param-id-7) id number The Id of the referral reward [​](https://docs.firstpromoter.com/webhooks/reward-created#param-amount-2) amount number The amount of the referral reward [​](https://docs.firstpromoter.com/webhooks/reward-created#param-type-1) type string The type of the referral reward [​](https://docs.firstpromoter.com/webhooks/reward-created#param-unit-2) unit string The unit of the referral reward [​](https://docs.firstpromoter.com/webhooks/reward-created#param-name-1) name string The name of the referral reward [​](https://docs.firstpromoter.com/webhooks/reward-created#param-per-of-sale) per\_of\_sale number The per of sale of the referral reward [​](https://docs.firstpromoter.com/webhooks/reward-created#param-default-promo-code-1) default\_promo\_code string The default promo code of the referral reward [​](https://docs.firstpromoter.com/webhooks/reward-created#param-current-promotion-reward) current\_promotion\_reward Current promotion reward Object Show properties [​](https://docs.firstpromoter.com/webhooks/reward-created#param-id-8) id number The Id of the promotion reward [​](https://docs.firstpromoter.com/webhooks/reward-created#param-amount-3) amount number The amount of the promotion reward [​](https://docs.firstpromoter.com/webhooks/reward-created#param-type-2) type string The type of the promotion reward [​](https://docs.firstpromoter.com/webhooks/reward-created#param-unit-3) unit string The unit of the promotion reward [​](https://docs.firstpromoter.com/webhooks/reward-created#param-name-2) name string The name of the promotion reward [​](https://docs.firstpromoter.com/webhooks/reward-created#param-per-of-sale-1) per\_of\_sale number The per of sale of the promotion reward [​](https://docs.firstpromoter.com/webhooks/reward-created#param-default-promo-code-2) default\_promo\_code string The default promo code of the promotion reward [​](https://docs.firstpromoter.com/webhooks/reward-created#param-current-target-reward) current\_target\_reward Current target reward Object Show properties [​](https://docs.firstpromoter.com/webhooks/reward-created#param-id-9) id number The Id of the referral reward [​](https://docs.firstpromoter.com/webhooks/reward-created#param-amount-4) amount number The amount of the referral reward [​](https://docs.firstpromoter.com/webhooks/reward-created#param-type-3) type string The type of the referral reward [​](https://docs.firstpromoter.com/webhooks/reward-created#param-unit-4) unit string The unit of the referral reward [​](https://docs.firstpromoter.com/webhooks/reward-created#param-name-3) name string The name of the referral reward [​](https://docs.firstpromoter.com/webhooks/reward-created#param-per-of-sale-2) per\_of\_sale number The per of sale of the referral reward [​](https://docs.firstpromoter.com/webhooks/reward-created#param-default-promo-code-3) default\_promo\_code string The default promo code of the referral reward [​](https://docs.firstpromoter.com/webhooks/reward-created#param-campaign-name) campaign\_name string The name of the campaign [​](https://docs.firstpromoter.com/webhooks/reward-created#param-hidden) hidden boolean Whether the campaign is hidden [​](https://docs.firstpromoter.com/webhooks/reward-created#param-visitors-count) visitors\_count number The number of visitors [​](https://docs.firstpromoter.com/webhooks/reward-created#param-leads-count) leads\_count number The number of leads [​](https://docs.firstpromoter.com/webhooks/reward-created#param-customers-count) customers\_count number The number of customers [​](https://docs.firstpromoter.com/webhooks/reward-created#param-refunds-count) refunds\_count number The number of refunds [​](https://docs.firstpromoter.com/webhooks/reward-created#param-cancellations-count) cancellations\_count number The number of cancellations [​](https://docs.firstpromoter.com/webhooks/reward-created#param-sales-count) sales\_count number The number of sales [​](https://docs.firstpromoter.com/webhooks/reward-created#param-sales-total) sales\_total number The total sales [​](https://docs.firstpromoter.com/webhooks/reward-created#param-refunds-total) refunds\_total number The total refunds [​](https://docs.firstpromoter.com/webhooks/reward-created#param-active-customers-count) active\_customers\_count number The number of active customers Response Copy { "event": { "id": 22737431, "type": "reward_created", "created_at": "2024-10-03T14:23:20.791Z" }, "data": { "id": 11174868, "status": "approved", "amount": 200, "unit": "cash", "created_at": "2024-10-03T14:23:20.495Z", "lead": { "id": 21381518, "state": "active", "email": "[email protected]", "uid": "", "customer_since": "2024-10-03T14:23:20.495Z", "cancelled_at": null, "plan_name": null, "suspicion": "no_suspicion", "username": null, "website": null, "created_at": "2024-10-03T13:45:20.031Z", "split_promotion_id": null, "custom_fields": null, "split_percentage_value": null, "visitor_sub_id": null }, "event_id": "Sit1234_id", "conversion_amount": 10000, "tier_level": 2, "split_type": null, "promoter": { "id": 5779418, "status": "active", "cust_id": "Todd Mccormick Plc", "email": "[email protected]", "created_at": "2023-05-03T18:33:55.055Z", "temp_password": "9jCRDdmA", "default_promotion_id": 6250255, "pref": "wo05sqe", "default_ref_id": "gusdc", "note": null, "w8_form_url": null, "w9_form_url": null, "parent_promoter_id": 5772992, "earnings_balance": { "cash": 4200, "credits": 60 }, "current_balance": { "cash": 4200 }, "paid_balance": { "credits": 60 }, "auth_token": "-RjCBDM8EkjfzzzCgpNBdV6VVLqMfttb", "profile": { "id": 5814797, "first_name": "Ulysses", "last_name": "Watson", "website": "", "company_name": "", "phone_number": "", "address": "", "vat_id": "", "country": "PT", "paypal_email": null, "avatar_url": "", "description": null, "social_accounts": { "twitter": { "url": "" }, "youtube": { "url": "" }, "facebook": { "url": "" }, "linkedin": { "url": "" }, "instagram": { "url": "" } } }, "promotions": [\ {\ "id": 6238498,\ "status": "offer_inactive",\ "ref_id": "u1lxd",\ "promo_code": null,\ "customer_promo_code": "xyz1234",\ "target_reached_at": null,\ "promoter_id": 5779418,\ "campaign_id": 13313,\ "referral_link": "http://localhost:3001?fgt=qwert&fpr=u1lxd",\ "current_offer": null,\ "current_referral_reward": {\ "id": 116314,\ "amount": 0,\ "type": "per_referral",\ "unit": "cash",\ "name": "10% recurring commission",\ "per_of_sale": 10,\ "default_promo_code": ""\ },\ "current_promotion_reward": {\ "id": 85713,\ "amount": 2000,\ "type": "per_promotion",\ "unit": "cash",\ "name": "$20 cash reward",\ "per_of_sale": 0,\ "default_promo_code": ""\ },\ "current_target_reward": null,\ "campaign_name": "Highlevel Campaign",\ "hidden": true,\ "visitors_count": 2,\ "leads_count": 3,\ "customers_count": 3,\ "refunds_count": 0,\ "cancellations_count": 0,\ "sales_count": 3,\ "sales_total": 18000,\ "refunds_total": 0,\ "active_customers_count": 3\ },\ {\ "id": 9438768,\ "status": "offer_running",\ "ref_id": "jqagt",\ "promo_code": null,\ "customer_promo_code": null,\ "target_reached_at": null,\ "promoter_id": 5779418,\ "campaign_id": 13202,\ "referral_link": "https://www.cax.ws?_get=jqagt",\ "current_offer": {\ "id": 67212,\ "name": "5% discount coupon",\ "amount": 5,\ "unit": "discount_per",\ "default_promo_code": " MAXADA-5"\ },\ "current_referral_reward": {\ "id": 128312,\ "amount": 0,\ "type": "per_referral",\ "unit": "cash",\ "name": "20% recurring commission",\ "per_of_sale": 20,\ "default_promo_code": ""\ },\ "current_promotion_reward": {\ "id": 68347,\ "amount": null,\ "type": "per_promotion",\ "unit": "free_months",\ "name": "Free subscription months",\ "per_of_sale": 0,\ "default_promo_code": null\ },\ "current_target_reward": null,\ "campaign_name": "Jaquelyn Ryan",\ "hidden": true,\ "visitors_count": 0,\ "leads_count": 0,\ "customers_count": 0,\ "refunds_count": 0,\ "cancellations_count": 0,\ "sales_count": 0,\ "sales_total": 0,\ "refunds_total": 0,\ "active_customers_count": 0\ },\ {\ "id": 6250255,\ "status": "offer_running",\ "ref_id": "gusdc",\ "promo_code": "rXqBjtPG",\ "customer_promo_code": "NEWCOUP",\ "target_reached_at": null,\ "promoter_id": 5779418,\ "campaign_id": 13228,\ "referral_link": "https://resilient-pegasus-e7ed60.netlify.app?fpr=gusdc",\ "current_offer": {\ "id": 92509,\ "name": "20% discount coupon",\ "amount": 20,\ "unit": "discount_per",\ "default_promo_code": null\ },\ "current_referral_reward": {\ "id": 120200,\ "amount": 0,\ "type": "per_referral",\ "unit": "cash",\ "name": "20% recurring commission",\ "per_of_sale": 20,\ "default_promo_code": ""\ },\ "current_promotion_reward": null,\ "current_target_reward": null,\ "campaign_name": "erSecond FP Campaign",\ "hidden": false,\ "visitors_count": 0,\ "leads_count": 0,\ "customers_count": 0,\ "refunds_count": 0,\ "cancellations_count": 0,\ "sales_count": 0,\ "sales_total": 0,\ "refunds_total": 0,\ "active_customers_count": 0\ }\ ] }, "promotion": { "id": 9438768, "status": "offer_running", "ref_id": "jqagt", "promo_code": null, "customer_promo_code": null, "target_reached_at": null, "promoter_id": 5779418, "campaign_id": 13202, "referral_link": "https://www.cax.ws?_get=jqagt", "current_offer": { "id": 67212, "name": "5% discount coupon", "amount": 5, "unit": "discount_per", "default_promo_code": " MAXADA-5" }, "current_referral_reward": { "id": 128312, "amount": 0, "type": "per_referral", "unit": "cash", "name": "20% recurring commission", "per_of_sale": 20, "default_promo_code": "" }, "current_promotion_reward": { "id": 68347, "amount": null, "type": "per_promotion", "unit": "free_months", "name": "Free subscription months", "per_of_sale": 0, "default_promo_code": null }, "current_target_reward": null, "campaign_name": "Jaquelyn Ryan", "hidden": true, "visitors_count": 0, "leads_count": 0, "customers_count": 0, "refunds_count": 0, "cancellations_count": 0, "sales_count": 0, "sales_total": 0, "refunds_total": 0, "active_customers_count": 0 } } } [Lead Signup](https://docs.firstpromoter.com/webhooks/lead-signup) [New Customer](https://docs.firstpromoter.com/webhooks/new-customer) ⌘I --- # Page Not Found [Skip to main content](https://docs.firstpromoter.com/webhooks/'https:/login.firstpromoter.com?redirect=settings%2Fintegrations%27#content-area) [FirstPromoter Docs home page![light logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/light.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=6ded212b82547bec37a22e90f72eeb71)![dark logo](https://mintcdn.com/firstpromoter/HBqmI3s-Wsq4TZSL/logo/dark.svg?fit=max&auto=format&n=HBqmI3s-Wsq4TZSL&q=85&s=c393ff83772047b8a444f78a1e393e7f)](https://docs.firstpromoter.com/) v2 Search... ⌘K Search... Navigation Page Not Found [Documentation](https://docs.firstpromoter.com/introduction) [API Reference](https://docs.firstpromoter.com/api-reference-v2/api-admin/introduction) 404 Page Not Found ============== We couldn't find the page. ⌘I ---