{
"error": "You need to find the promoter either by id, cust_id, auth_token, ref_id or promoter_email"
}
Promoters
Add a promoter to a campaign
Use this endpoint to add a promoter to another campaign. Your promoter can have multiple campaigns to promote, each with its own referral link and referral ID.
You can identify promoters by id, cust_id, auth_token, promoter_email or ref_id (referral id).
HTTP Request POST https://firstpromoter.com/api/v1/promoters/add_to_campaign
POST
/
add_to_campaign
cURL
curl --request POST \ --url https://firstpromoter.com/api/v1/promoters/add_to_campaign \ --header 'X-API-KEY: <api-key>'
{
"error": "You need to find the promoter either by id, cust_id, auth_token, ref_id or promoter_email"
}
Use this endpoint to add a promoter to another campaign. Your promoter will have multiple campaigns to promoter, each campaign with its own promotion, referral link and referral id.You can identify promoters by: id, cust_id, auth_token, promoter_email or ref_id(referral id).
Your customer's user ID inside your application/system for the promoter. This will be included in the webhook event and can be used to identify the promoter in your system if you subscribe for FirstPromoter's webhooks.
A temporary password the promoter can use to log in to their dashboard if you don't use authentication tokens(auth_token) to sign promoters in automatically.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"FirstPromoter Docs","colors":{"primary":"#2497F3","light":"#42A5F5","dark":"#1A1C25"},"logo":{"light":"https://mintcdn.com/firstpromoter/Qml53iAwCwPGiKRZ/logo/light.svg?fit=max\u0026auto=format\u0026n=Qml53iAwCwPGiKRZ\u0026q=85\u0026s=17d35344b27497f795682da8932295c9","dark":"https://mintcdn.com/firstpromoter/Qml53iAwCwPGiKRZ/logo/dark.svg?fit=max\u0026auto=format\u0026n=Qml53iAwCwPGiKRZ\u0026q=85\u0026s=ef23e747176d9a87b5ddf122595793f8"},"favicon":"https://mintcdn.com/firstpromoter/rNk-Jdvp2vdjAvd9/favicon.png?fit=max\u0026auto=format\u0026n=rNk-Jdvp2vdjAvd9\u0026q=85\u0026s=7faf17e323609b0fef661b9a9fe49ebc","navbar":{"links":[{"href":"mailto:support@firstpromoter.com","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://login.firstpromoter.com/"}},"footer":{"socials":{"x":"https://x.com/firstpromoter","linkedin":"https://www.linkedin.com/company/first-promoter"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"firstpromoter","hasAudioNarration":false,"actualSubdomain":"firstpromoter","customDomains":["docs.firstpromoter.com"],"gitSource":{"type":"github","owner":"firstpromoter","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6aeb056486e5c4288ac4ca44","collectionId":"46b1f99c-db41-4d10-8d3e-8d7eeeaa0b5e","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6aeb056486e5c4288ac4ca44"},"entitlements":{},"buildId":"6aeb056486e5c4288ac4ca44","clientVersion":"0.0.4067","searchFilterCounts":[{"language":"default","tag":"Documentation","count":213},{"language":"default","tag":"API Reference","count":81},{"language":"default","tag":"Integration Options","count":41},{"language":"default","tag":"Promoters","count":25},{"language":"default","tag":"Platform","count":23},{"language":"default","tag":"Custom","count":9},{"language":"default","tag":"Webhooks","count":9},{"language":"default","tag":"Reports","count":8},{"language":"default","tag":"Payouts","count":7},{"language":"default","tag":"Commissions","count":7}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference-v1/promoters-api/add-to-campaign","slug":"/api-reference-v1/promoters-api/add-to-campaign","pageMetadata":{"title":"Add a promoter to a campaign","openapi":"openapi-promoters POST /add_to_campaign","description":"Use this endpoint to add a promoter to another campaign. Your promoter can have multiple campaigns to promote, each with its own referral link and referral ID.\u003cbr/>\u003cbr/>You can identify promoters by `id`, `cust_id`, `auth_token`, `promoter_email` or `ref_id` (referral id). \u003cTip> **HTTP Request** \u003cbr/> `POST https://firstpromoter.com/api/v1/promoters/add_to_campaign` \u003c/Tip>","href":"/api-reference-v1/promoters-api/add-to-campaign"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n strong: \"strong\",\n ..._provideComponents(),\n ...props.components\n }, {Tip} = _components;\n if (!Tip) _missingMdxReference(\"Tip\", true);\n return _jsxs(_components.p, {\n children: [\"Use this endpoint to add a promoter to another campaign. Your promoter can have multiple campaigns to promote, each with its own referral link and referral ID.\", _jsx(\"br\", {}), _jsx(\"br\", {}), \"You can identify promoters by \", _jsx(_components.code, {\n children: \"id\"\n }), \", \", _jsx(_components.code, {\n children: \"cust_id\"\n }), \", \", _jsx(_components.code, {\n children: \"auth_token\"\n }), \", \", _jsx(_components.code, {\n children: \"promoter_email\"\n }), \" or \", _jsx(_components.code, {\n children: \"ref_id\"\n }), \" (referral id). \", _jsxs(Tip, {\n children: [\" \", _jsx(_components.strong, {\n children: \"HTTP Request\"\n }), \" \", _jsx(\"br\", {}), \" \", _jsx(_components.code, {\n children: \"POST https://firstpromoter.com/api/v1/promoters/add_to_campaign\"\n }), \" \"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\nfunction _missingMdxReference(id, component) {\n throw new Error(\"Expected \" + (component ? \"component\" : \"object\") + \" `\" + id + \"` to be defined: you likely forgot to import, pass, or provide it.\");\n}\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={p:`p`,strong:`strong`,..._provideComponents(),...props.components};return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Use this endpoint to add a promoter to another campaign. Your promoter will have multiple campaigns to promoter, each campaign with its own promotion, referral link and referral id.`}),`\n`,_jsxs(_components.p,{children:[`You can identify promoters `,_jsx(_components.strong,{children:`by: id, cust_id, auth_token, promoter_email or ref_id`}),`(referral id).`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Add a promoter to a campaign","openapi":"openapi-promoters POST /add_to_campaign","description":"Use this endpoint to add a promoter to another campaign. Your promoter can have multiple campaigns to promote, each with its own referral link and referral ID.\u003cbr/>\u003cbr/>You can identify promoters by `id`, `cust_id`, `auth_token`, `promoter_email` or `ref_id` (referral id). \u003cTip> **HTTP Request** \u003cbr/> `POST https://firstpromoter.com/api/v1/promoters/add_to_campaign` \u003c/Tip>","href":"/api-reference-v1/promoters-api/add-to-campaign"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/firstpromoter/8ad42af542d542c7/downloadables/fpr-prox.js"],"openApiReferenceData":{"operation":{"description":"Use this endpoint to add a promoter to another campaign. Your promoter can have multiple campaigns to promote, each with its own referral link and referral ID.\u003cbr/>\u003cbr/>You can identify promoters by `id`, `cust_id`, `auth_token`, `promoter_email` or `ref_id` (referral id). \u003cTip> **HTTP Request** \u003cbr/> `POST https://firstpromoter.com/api/v1/promoters/add_to_campaign` \u003c/Tip>","parameters":["58bb7ce6-3055-4439-b0e6-54f993d3a751","0f850c23-38f6-4aec-978c-a071ce2ef251","fda79200-c93a-4147-80d0-757e7e8ed6e8","23f8cc8b-1c9f-4c0e-8a69-9611194e6d6f","e65c861e-1500-41cb-a46f-b47bb1873f60","7f9ed463-cf10-4ac1-a383-aba9f7e503f7"],"responses":{"200":"9ec22e86-1fa9-43e7-bd6c-ed18d29b94e7","401":"e334d29e-8a94-446a-9b7e-1be3e94297c8","404":"894901da-5325-434e-b780-7c5c9e02c517","422":"c5dd8cab-5436-446e-90bb-8986170fedc0"},"method":"post","type":"path","servers":["cf343685-35f1-4bf3-bc4e-8859f920d6d8"],"security":["269911f4-0f00-42c0-8c6f-e9436c156c27"],"path":"/add_to_campaign","baseUrlOptions":["https://firstpromoter.com/api/v1/promoters"],"title":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"58bb7ce6-3055-4439-b0e6-54f993d3a751":{"name":"id","in":"query","description":"Promoter's ID inside FirstPromoter","schema":{"type":"string","description":"Promoter's ID inside FirstPromoter","uniqueKey":"","typeLabel":"string"}},"0f850c23-38f6-4aec-978c-a071ce2ef251":{"name":"promoter_email","in":"query","description":"Email of the promoter","schema":{"type":"string","description":"Email of the promoter","uniqueKey":"","typeLabel":"string"}},"fda79200-c93a-4147-80d0-757e7e8ed6e8":{"name":"cust_id","in":"query","description":"Assigned customer/user ID","schema":{"type":"string","description":"Assigned customer/user ID","uniqueKey":"","typeLabel":"string"}},"23f8cc8b-1c9f-4c0e-8a69-9611194e6d6f":{"name":"ref_id","in":"query","description":"Referral ID","schema":{"type":"string","description":"Referral ID","uniqueKey":"","typeLabel":"string"}},"e65c861e-1500-41cb-a46f-b47bb1873f60":{"name":"auth_token","in":"query","description":"Authentication token generated when the promoter was created","schema":{"type":"string","description":"Authentication token generated when the promoter was created","uniqueKey":"","typeLabel":"string"}},"7f9ed463-cf10-4ac1-a383-aba9f7e503f7":{"name":"campaign_id","in":"query","required":true,"description":"ID of the campaign to add the promoter to. It can be found on the url bar when editing the campaign","schema":{"type":"string","isRequired":true,"description":"ID of the campaign to add the promoter to. It can be found on the url bar when editing the campaign","uniqueKey":"","typeLabel":"string"}}},"responses":{"9ec22e86-1fa9-43e7-bd6c-ed18d29b94e7":{"description":"Add to campaign response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The promoter's ID inside FirstPromoter","type":"integer","uniqueKey":"id","typeLabel":"integer"},"status":{"description":"Promoter's status","type":"string","enum":["approved","pending","denied"],"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"cust_id":{"description":"Your customer's user ID inside your application/system for the promoter. This will be included in the webhook event and can be used to identify the promoter in your system if you subscribe for FirstPromoter's webhooks.","type":"string","uniqueKey":"cust_id","typeLabel":"string"},"email":{"description":"Promoter's email","type":"string","uniqueKey":"email","typeLabel":"string"},"created_at":{"description":"ISO date string when the promoter signed up","type":"string","uniqueKey":"created_at","typeLabel":"string"},"temp_password":{"description":"A temporary password the promoter can use to log in to their dashboard if you don't use authentication tokens(`auth_token`) to sign promoters in automatically.","type":"string","uniqueKey":"temp_password","typeLabel":"string"},"default_promotion_id":{"description":"Promoter's default promotion id","type":"number","example":128833,"uniqueKey":"default_promotion_id","typeLabel":"number"},"pref":{"description":"Promoter's parent referral id.","type":"string","uniqueKey":"pref","typeLabel":"string"},"default_ref_id":{"description":"Promoter's default referral id","type":"string","uniqueKey":"default_ref_id","typeLabel":"string"},"note":{"description":"A note/description of promoter","type":"string","uniqueKey":"note","typeLabel":"string"},"w8_form_url":{"description":"The w8 form url","type":"string","uniqueKey":"w8_form_url","typeLabel":"string"},"w9_form_url":{"description":"The w9 form url","type":"string","uniqueKey":"w9_form_url","typeLabel":"string"},"parent_promoter_id":{"description":"Parent promoter id","type":"string","uniqueKey":"parent_promoter_id","typeLabel":"string"},"earnings_balance":{"description":"Promoter's earnings balance. This object can contain `cash`, `credits`, `discount_per` ","type":"object","properties":{"cash":{"description":"The cash earnings","type":"integer","example":3000,"uniqueKey":"earnings_balance.cash","typeLabel":"integer"},"credits":{"description":"The earning credits","type":"integer","example":300,"uniqueKey":"earnings_balance.credits","typeLabel":"integer"},"discount_per":{"description":"The earning discount percentage","type":"integer","example":30,"uniqueKey":"earnings_balance.discount_per","typeLabel":"integer"}},"uniqueKey":"earnings_balance","typeLabel":"object"},"current_balance":{"description":"Promoter's current balance. This object can contain `cash`, `credits`, `discount_per` ","type":"object","properties":{"cash":{"description":"The current cash balance","type":"integer","example":1000,"uniqueKey":"current_balance.cash","typeLabel":"integer"},"credits":{"description":"The current credits","type":"integer","example":200,"uniqueKey":"current_balance.credits","typeLabel":"integer"},"discount_per":{"description":"The current discount percentage","type":"integer","example":15,"uniqueKey":"current_balance.discount_per","typeLabel":"integer"}},"uniqueKey":"current_balance","typeLabel":"object"},"paid_balance":{"description":"Promoter's paid balance. This object can contain `cash`, `credits`, `discount_per`","type":"object","properties":{"cash":{"description":"The cash paid","type":"integer","example":2000,"uniqueKey":"paid_balance.cash","typeLabel":"integer"},"credits":{"description":"The credits given","type":"integer","example":100,"uniqueKey":"paid_balance.credits","typeLabel":"integer"},"discount_per":{"description":"The discount percentage given","type":"integer","example":15,"uniqueKey":"paid_balance.discount_per","typeLabel":"integer"}},"uniqueKey":"paid_balance","typeLabel":"object"},"auth_token":{"description":"Authentication token generated when the promoter was created","type":"string","uniqueKey":"auth_token","typeLabel":"string"},"profile":{"type":"object","properties":{"first_name":{"description":"Promoter's first name","type":"string","uniqueKey":"profile.first_name","typeLabel":"string"},"last_name":{"description":"Promoter's last name","type":"string","uniqueKey":"profile.last_name","typeLabel":"string"},"website":{"description":"Promoter's website","type":"string","uniqueKey":"profile.website","typeLabel":"string"},"company_name":{"description":"Promoter's company name","type":"string","uniqueKey":"profile.company_name","typeLabel":"string"},"phone_number":{"description":"Promoter's phone number","type":"string","uniqueKey":"profile.phone_number","typeLabel":"string"},"address":{"description":"Promoter's address","type":"string","uniqueKey":"profile.address","typeLabel":"string"},"vat_id":{"description":"Promoter's vat id","type":"string","uniqueKey":"profile.vat_id","typeLabel":"string"},"country":{"description":"Promoter's country","type":"string","uniqueKey":"profile.country","typeLabel":"string"},"paypal_email":{"description":"Promoter's Paypal email address","type":"string","uniqueKey":"profile.paypal_email","typeLabel":"string"},"avatar_url":{"description":"URL of the profile picture promoters can see on their dashboard","type":"string","uniqueKey":"profile.avatar_url","typeLabel":"string"},"description":{"description":"A note/description of promoter","type":"string","uniqueKey":"profile.description","typeLabel":"string"},"social_accounts":{"type":"object","properties":{"twitter":{"type":"object","properties":{"url":{"description":"Promoter's twitter url","type":"string","uniqueKey":"profile.social_accounts.twitter.url","typeLabel":"string"}},"uniqueKey":"profile.social_accounts.twitter","typeLabel":"object"},"youtube":{"type":"object","properties":{"url":{"description":"Promoter's youtube url","type":"string","uniqueKey":"profile.social_accounts.youtube.url","typeLabel":"string"}},"uniqueKey":"profile.social_accounts.youtube","typeLabel":"object"},"facebook":{"type":"object","properties":{"url":{"description":"Promoter's Facebook url","type":"string","uniqueKey":"profile.social_accounts.facebook.url","typeLabel":"string"}},"uniqueKey":"profile.social_accounts.facebook","typeLabel":"object"},"linkedin":{"type":"object","properties":{"url":{"description":"Promoter's linkedin url","type":"string","uniqueKey":"profile.social_accounts.linkedin.url","typeLabel":"string"}},"uniqueKey":"profile.social_accounts.linkedin","typeLabel":"object"},"instagram":{"type":"object","properties":{"url":{"description":"Promoter's instagram url","type":"string","uniqueKey":"profile.social_accounts.instagram.url","typeLabel":"string"}},"uniqueKey":"profile.social_accounts.instagram","typeLabel":"object"}},"uniqueKey":"profile.social_accounts","typeLabel":"object"}},"uniqueKey":"profile","typeLabel":"object"},"promotions":{"type":"array","items":{"type":"object","properties":{"id":{"description":"ID of the promotion.","type":"number","uniqueKey":"promotions.items.[INDEX].id","typeLabel":"number"},"status":{"description":"Current offer status.","type":"string","uniqueKey":"promotions.items.[INDEX].status","typeLabel":"string"},"ref_id":{"type":"string","uniqueKey":"promotions.items.[INDEX].ref_id","typeLabel":"string"},"promo_code":{"description":" Unique promo code from your billing provider to assign to this affiliate for coupon tracking. This is also known as the `Coupon Code` or `Coupon ID`","type":"string","uniqueKey":"promotions.items.[INDEX].promo_code","typeLabel":"string"},"customer_promo_code":{"description":"Customer promo code from your billing provider assigned to this affiliate for coupon tracking. This is also known as `discount code` or `promotion code` or `display code`. This is the code your customer(s) used on the checkout form/page.","type":"string","uniqueKey":"promotions.items.[INDEX].customer_promo_code","typeLabel":"string"},"target_reached_at":{"type":"object","uniqueKey":"promotions.items.[INDEX].target_reached_at","typeLabel":"object"},"promoter_id":{"description":"ID of the promoter/affiliate.","type":"number","uniqueKey":"promotions.items.[INDEX].promoter_id","typeLabel":"number"},"campaign_id":{"description":"ID of the campaign where the promotion runs.","type":"number","uniqueKey":"promotions.items.[INDEX].campaign_id","typeLabel":"number"},"referral_link":{"description":"Promoter's referral link","type":"string","uniqueKey":"promotions.items.[INDEX].referral_link","typeLabel":"string"},"current_offer":{"type":"object","properties":{"id":{"description":"The reward id","type":"number","uniqueKey":"promotions.items.[INDEX].current_offer.id","typeLabel":"number"},"name":{"description":"The reward name","type":"string","uniqueKey":"promotions.items.[INDEX].current_offer.name","typeLabel":"string"},"amount":{"description":"The reward amount","type":"number","uniqueKey":"promotions.items.[INDEX].current_offer.amount","typeLabel":"number"},"unit":{"description":"The reward unit (e.g., 'credits', 'free_months', 'cash').","type":"string","uniqueKey":"promotions.items.[INDEX].current_offer.unit","typeLabel":"string"},"default_promo_code":{"type":"string","uniqueKey":"promotions.items.[INDEX].current_offer.default_promo_code","typeLabel":"string"}},"uniqueKey":"promotions.items.[INDEX].current_offer","typeLabel":"object"},"current_referral_reward":{"type":"object","properties":{"id":{"type":"number","uniqueKey":"promotions.items.[INDEX].current_referral_reward.id","typeLabel":"number"},"amount":{"type":"number","uniqueKey":"promotions.items.[INDEX].current_referral_reward.amount","typeLabel":"number"},"unit":{"type":"string","uniqueKey":"promotions.items.[INDEX].current_referral_reward.unit","typeLabel":"string"},"name":{"type":"string","uniqueKey":"promotions.items.[INDEX].current_referral_reward.name","typeLabel":"string"},"per_of_sale":{"type":"number","uniqueKey":"promotions.items.[INDEX].current_referral_reward.per_of_sale","typeLabel":"number"},"default_promo_code":{"type":"string","uniqueKey":"promotions.items.[INDEX].current_referral_reward.default_promo_code","typeLabel":"string"}},"uniqueKey":"promotions.items.[INDEX].current_referral_reward","typeLabel":"object"},"current_promotion_reward":{"type":"object","uniqueKey":"promotions.items.[INDEX].current_promotion_reward","typeLabel":"object"},"current_target_reward":{"type":"object","uniqueKey":"promotions.items.[INDEX].current_target_reward","typeLabel":"object"},"campaign_name":{"type":"string","uniqueKey":"promotions.items.[INDEX].campaign_name","typeLabel":"string"},"hidden":{"type":"boolean","uniqueKey":"promotions.items.[INDEX].hidden","typeLabel":"boolean"},"visitors_count":{"type":"number","uniqueKey":"promotions.items.[INDEX].visitors_count","typeLabel":"number"},"leads_count":{"type":"number","uniqueKey":"promotions.items.[INDEX].leads_count","typeLabel":"number"},"customers_count":{"type":"number","uniqueKey":"promotions.items.[INDEX].customers_count","typeLabel":"number"},"refunds_count":{"type":"number","uniqueKey":"promotions.items.[INDEX].refunds_count","typeLabel":"number"},"cancellations_count":{"type":"number","uniqueKey":"promotions.items.[INDEX].cancellations_count","typeLabel":"number"},"sales_count":{"type":"number","uniqueKey":"promotions.items.[INDEX].sales_count","typeLabel":"number"},"sales_total":{"type":"number","uniqueKey":"promotions.items.[INDEX].sales_total","typeLabel":"number"},"refunds_total":{"type":"number","uniqueKey":"promotions.items.[INDEX].refunds_total","typeLabel":"number"},"active_customers_count":{"type":"number","uniqueKey":"promotions.items.[INDEX].active_customers_count","typeLabel":"number"}},"uniqueKey":"promotions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"promotions","typeLabel":"object[]"},"custom_fields":{"oneOf":[{"type":"object","description":"Key-value pairs of custom fields configured for this promoter","uniqueKey":"custom_fields.oneOf.0","typeLabel":"object"},{"type":"null","description":"Key-value pairs of custom fields configured for this promoter","uniqueKey":"custom_fields.oneOf.1","typeLabel":"null"}],"uniqueKey":"custom_fields","typeLabel":"object | null"},"promo_codes":{"type":"array","description":"Promo codes associated with this promoter","items":{"type":"object","properties":{"id":{"type":"integer","uniqueKey":"promo_codes.items.[INDEX].id","typeLabel":"integer"},"code":{"type":"string","uniqueKey":"promo_codes.items.[INDEX].code","typeLabel":"string"},"reward":{"type":"object","properties":{"id":{"type":"integer","uniqueKey":"promo_codes.items.[INDEX].reward.id","typeLabel":"integer"},"name":{"type":"string","uniqueKey":"promo_codes.items.[INDEX].reward.name","typeLabel":"string"}},"uniqueKey":"promo_codes.items.[INDEX].reward","typeLabel":"object"}},"uniqueKey":"promo_codes.items.[INDEX]","typeLabel":"object"},"uniqueKey":"promo_codes","typeLabel":"object[]"}},"example":{"id":5594994,"status":"active","cust_id":null,"email":"wopomipu@mailinator.com","created_at":"2023-04-04T12:30:23.250Z","temp_password":"Pa$$w0rd!","default_promotion_id":6041923,"pref":"jme34om","default_ref_id":"cd5de","note":null,"w8_form_url":null,"w9_form_url":null,"parent_promoter_id":null,"earnings_balance":{"cash":30000},"current_balance":{"credits":-150},"paid_balance":{"cash":30000,"credits":150},"auth_token":"cxXz22oP5xNG2bFcXzo13N8HQ91RYed2","profile":{"id":5629748,"first_name":"Raven","last_name":"Moore","website":null,"company_name":null,"phone_number":null,"address":null,"vat_id":null,"country":null,"paypal_email":"nyhuxigyn@mailinator.com","avatar_url":null,"description":null,"social_accounts":{}},"promotions":[{"id":10122408,"status":"offer_inactive","ref_id":"s7rxl","promo_code":null,"customer_promo_code":null,"target_reached_at":null,"promoter_id":5594994,"campaign_id":18747,"referral_link":"https://lastechworld.com?fpr=s7rxl","current_offer":null,"current_referral_reward":{"id":94230,"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":"Publishers \u0026 marketing Partners","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},{"id":10122364,"status":"offer_running","ref_id":"4us60","promo_code":null,"customer_promo_code":null,"target_reached_at":null,"promoter_id":5594994,"campaign_id":26127,"referral_link":"https://lastechworld.com?fpr=4us60","current_offer":{"id":140358,"name":"1 free subscription months","amount":1,"unit":"free_months","default_promo_code":""},"current_referral_reward":{"id":140359,"amount":1,"type":"per_referral","unit":"free_months","name":"1 free subscription months","per_of_sale":0,"default_promo_code":""},"current_promotion_reward":null,"current_target_reward":null,"campaign_name":"Make 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},{"id":6041923,"status":"offer_running","ref_id":"cd5de","promo_code":"","customer_promo_code":"","target_reached_at":null,"promoter_id":5594994,"campaign_id":18519,"referral_link":"https://partner.lastechworld.com?fpr=cd5de","current_offer":{"id":96412,"name":"75 credits","amount":75,"unit":"credits","default_promo_code":""},"current_referral_reward":{"id":93868,"amount":null,"type":"per_referral","unit":"cash","name":"15% recurring commission","per_of_sale":15,"default_promo_code":null},"current_promotion_reward":null,"current_target_reward":null,"campaign_name":"TechScenario12Campaign-1","hidden":false,"visitors_count":1,"leads_count":1,"customers_count":1,"refunds_count":0,"cancellations_count":0,"sales_count":2,"sales_total":250000,"refunds_total":0,"active_customers_count":1}]},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":5594994,"status":"active","cust_id":null,"email":"wopomipu@mailinator.com","created_at":"2023-04-04T12:30:23.250Z","temp_password":"Pa$$w0rd!","default_promotion_id":6041923,"pref":"jme34om","default_ref_id":"cd5de","note":null,"w8_form_url":null,"w9_form_url":null,"parent_promoter_id":null,"earnings_balance":{"cash":30000},"current_balance":{"credits":-150},"paid_balance":{"cash":30000,"credits":150},"auth_token":"cxXz22oP5xNG2bFcXzo13N8HQ91RYed2","profile":{"id":5629748,"first_name":"Raven","last_name":"Moore","website":null,"company_name":null,"phone_number":null,"address":null,"vat_id":null,"country":null,"paypal_email":"nyhuxigyn@mailinator.com","avatar_url":null,"description":null,"social_accounts":{}},"promotions":[{"id":10122408,"status":"offer_inactive","ref_id":"s7rxl","promo_code":null,"customer_promo_code":null,"target_reached_at":null,"promoter_id":5594994,"campaign_id":18747,"referral_link":"https://lastechworld.com?fpr=s7rxl","current_offer":null,"current_referral_reward":{"id":94230,"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":"Publishers \u0026 marketing Partners","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},{"id":10122364,"status":"offer_running","ref_id":"4us60","promo_code":null,"customer_promo_code":null,"target_reached_at":null,"promoter_id":5594994,"campaign_id":26127,"referral_link":"https://lastechworld.com?fpr=4us60","current_offer":{"id":140358,"name":"1 free subscription months","amount":1,"unit":"free_months","default_promo_code":""},"current_referral_reward":{"id":140359,"amount":1,"type":"per_referral","unit":"free_months","name":"1 free subscription months","per_of_sale":0,"default_promo_code":""},"current_promotion_reward":null,"current_target_reward":null,"campaign_name":"Make 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},{"id":6041923,"status":"offer_running","ref_id":"cd5de","promo_code":"","customer_promo_code":"","target_reached_at":null,"promoter_id":5594994,"campaign_id":18519,"referral_link":"https://partner.lastechworld.com?fpr=cd5de","current_offer":{"id":96412,"name":"75 credits","amount":75,"unit":"credits","default_promo_code":""},"current_referral_reward":{"id":93868,"amount":null,"type":"per_referral","unit":"cash","name":"15% recurring commission","per_of_sale":15,"default_promo_code":null},"current_promotion_reward":null,"current_target_reward":null,"campaign_name":"TechScenario12Campaign-1","hidden":false,"visitors_count":1,"leads_count":1,"customers_count":1,"refunds_count":0,"cancellations_count":0,"sales_count":2,"sales_total":250000,"refunds_total":0,"active_customers_count":1}]}}},"exampleType":"generated"}},"exampleType":"generated"},"e334d29e-8a94-446a-9b7e-1be3e94297c8":{"description":"Authentication Error","content":{"application/json":{"schema":{"type":"string","example":"Bad credentials","uniqueKey":"","typeLabel":"string"},"examples":{"Example":{"title":"Example","value":"Bad credentials"}},"exampleType":"generated"}},"exampleType":"generated"},"894901da-5325-434e-b780-7c5c9e02c517":{"description":"Not Found Error","content":{"application/json":{"schema":{"required":["error"],"type":"object","properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"}},"example":{"error":"Promoter not found."},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Promoter not found."}}},"exampleType":"generated"}},"exampleType":"generated"},"c5dd8cab-5436-446e-90bb-8986170fedc0":{"description":"Unprocessable Entity Error","content":{"application/json":{"schema":{"required":["error"],"type":"object","properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"}},"example":{"error":"You need to find the promoter either by id, cust_id, auth_token, ref_id or promoter_email"},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"You need to find the promoter either by id, cust_id, auth_token, ref_id or promoter_email"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"269911f4-0f00-42c0-8c6f-e9436c156c27":{"apiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-KEY","scopes":[]}}},"servers":{"cf343685-35f1-4bf3-bc4e-8859f920d6d8":{"url":"https://firstpromoter.com/api/v1/promoters"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"X-API-KEY","scopes":[]},"schema":{"title":"X-API-KEY","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"apiKeyAuth","name":"X-API-KEY"}],"title":"apiKeyAuth"}]},"originalFileLocation":"api-reference-v1/promoters-api/openapi-promoters.json"},"subdomain":"firstpromoter","siteName":"FirstPromoter Docs","title":"Add a promoter to a campaign - FirstPromoter Docs","navMaps":{"firstHrefInVersion":{"v2":{"href":"/api-reference-v2/api-admin/promoters/get-available-promoters","matchLevel":2},"v1":{"href":"/api-reference-v1/promoters-api/add-to-campaign","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2025-08-07T12:33:18.664Z","originalFileLocation":"api-reference-v1/promoters-api/add-to-campaign.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Use this endpoint to add a promoter to another campaign. Your promoter can have multiple campaigns to promote, each with its own referral link and referral ID.You can identify promoters by id, cust_id, auth_token, promoter_email or ref_id (referral id). HTTP Request POST https://firstpromoter.com/api/v1/promoters/add_to_campaign\">\u003cmeta data-mint-head name=\"application-name\" content=\"FirstPromoter Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/firstpromoter/NHAuOTz7uXRLkEOr/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/firstpromoter/NHAuOTz7uXRLkEOr/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/firstpromoter/NHAuOTz7uXRLkEOr/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/firstpromoter/NHAuOTz7uXRLkEOr/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/firstpromoter/NHAuOTz7uXRLkEOr/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/firstpromoter/NHAuOTz7uXRLkEOr/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/firstpromoter/NHAuOTz7uXRLkEOr/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/firstpromoter/NHAuOTz7uXRLkEOr/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/firstpromoter/NHAuOTz7uXRLkEOr/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Add a promoter to a campaign - FirstPromoter Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Use this endpoint to add a promoter to another campaign. Your promoter can have multiple campaigns to promote, each with its own referral link and referral ID.You can identify promoters by id, cust_id, auth_token, promoter_email or ref_id (referral id). HTTP Request POST https://firstpromoter.com/api/v1/promoters/add_to_campaign\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"FirstPromoter Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.firstpromoter.com/api-reference-v1/promoters-api/add-to-campaign\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://firstpromoter.mintlify.app/_mintlify/api/og/v2?division=Promoters\u0026amp;title=Add+a+promoter+to+a+campaign\u0026amp;description=Use+this+endpoint+to+add+a+promoter+to+another+campaign.+Your+promoter+can+have+multiple+campaigns+to+promote%2C+each+with+its+own+referral+link+and+referral+ID.%3C\u0026amp;theme=6c5c6938239eba73fb25a5bd\u0026amp;signature=c37f42070e7d1359650dc279b10f0f0e5ead4df5ba4643acd8139d079906071a\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Add a promoter to a campaign - FirstPromoter Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Use this endpoint to add a promoter to another campaign. Your promoter can have multiple campaigns to promote, each with its own referral link and referral ID.You can identify promoters by id, cust_id, auth_token, promoter_email or ref_id (referral id). HTTP Request POST https://firstpromoter.com/api/v1/promoters/add_to_campaign\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://firstpromoter.mintlify.app/_mintlify/api/og/v2?division=Promoters\u0026amp;title=Add+a+promoter+to+a+campaign\u0026amp;description=Use+this+endpoint+to+add+a+promoter+to+another+campaign.+Your+promoter+can+have+multiple+campaigns+to+promote%2C+each+with+its+own+referral+link+and+referral+ID.%3C\u0026amp;theme=6c5c6938239eba73fb25a5bd\u0026amp;signature=c37f42070e7d1359650dc279b10f0f0e5ead4df5ba4643acd8139d079906071a\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/firstpromoter/NHAuOTz7uXRLkEOr/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"FirstPromoter Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#2497F3\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.firstpromoter.com/api-reference-v1/promoters-api/add-to-campaign\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference-v1/promoters-api/add-to-campaign.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.firstpromoter.com/#organization\",\"name\":\"FirstPromoter Docs\",\"url\":\"https://docs.firstpromoter.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/firstpromoter/Qml53iAwCwPGiKRZ/logo/light.svg?fit=max\u0026auto=format\u0026n=Qml53iAwCwPGiKRZ\u0026q=85\u0026s=17d35344b27497f795682da8932295c9\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.firstpromoter.com#website\",\"name\":\"FirstPromoter Docs\",\"url\":\"https://docs.firstpromoter.com\",\"publisher\":{\"@id\":\"https://docs.firstpromoter.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.firstpromoter.com/api-reference-v1/promoters-api/add-to-campaign#webpage\",\"url\":\"https://docs.firstpromoter.com/api-reference-v1/promoters-api/add-to-campaign\",\"name\":\"Add a promoter to a campaign\",\"description\":\"Use this endpoint to add a promoter to another campaign. Your promoter can have multiple campaigns to promote, each with its own referral link and referral ID.You can identify promoters by id, cust_id, auth_token, promoter_email or ref_id (referral id). HTTP Request POST https://firstpromoter.com/api/v1/promoters/add_to_campaign\",\"dateModified\":\"2025-08-07T12:33:18.664Z\",\"isPartOf\":{\"@id\":\"https://docs.firstpromoter.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.firstpromoter.com/api-reference-v1/promoters-api/add-to-campaign#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.firstpromoter.com/api-reference-v1/promoters-api/add-to-campaign#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Promoters\",\"item\":\"https://docs.firstpromoter.com/api-reference-v1/promoters-api/create\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Add a promoter to a campaign\",\"item\":\"https://docs.firstpromoter.com/api-reference-v1/promoters-api/add-to-campaign\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.firstpromoter.com/api-reference-v1/promoters-api/add-to-campaign#apireference\",\"headline\":\"Add a promoter to a campaign\",\"name\":\"Add a promoter to a campaign\",\"description\":\"Use this endpoint to add a promoter to another campaign. Your promoter can have multiple campaigns to promote, each with its own referral link and referral ID.You can identify promoters by id, cust_id, auth_token, promoter_email or ref_id (referral id). HTTP Request POST https://firstpromoter.com/api/v1/promoters/add_to_campaign\",\"url\":\"https://docs.firstpromoter.com/api-reference-v1/promoters-api/add-to-campaign\",\"mainEntityOfPage\":{\"@id\":\"https://docs.firstpromoter.com/api-reference-v1/promoters-api/add-to-campaign#webpage\"},\"dateModified\":\"2025-08-07T12:33:18.664Z\",\"publisher\":{\"@id\":\"https://docs.firstpromoter.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.firstpromoter.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"FirstPromoter Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"FirstPromoter Docs","nav":{"global":null,"versions":[{"version":"v2","pages":[{"title":"v2","href":"/api-reference-v2/api-admin/promoters/get-available-promoters"}]},{"version":"v1","anchors":[{"anchor":"Documentation","icon":"book-open","tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"API Reference","groups":[{"group":"API Documentation","pages":[{"title":"Introduction","href":"/api-reference-v1/introduction"},{"title":"Authentication","href":"/api-reference-v1/authentication"}]},{"group":"Tracking","pages":[{"title":"Tracking leads and sign-ups","openapi":"openapi-tracking POST /signup","href":"/api-reference-v1/tracking-api/leads-and-signups"},{"title":"Tracking sales and commissions","openapi":"openapi-tracking POST /sale","href":"/api-reference-v1/tracking-api/sales"},{"title":"Tracking refunds and negative commissions","openapi":"openapi-tracking POST /refund","href":"/api-reference-v1/tracking-api/refund"},{"title":"Tracking cancellations","openapi":"openapi-tracking POST /cancellation","href":"/api-reference-v1/tracking-api/cancellation"}]},{"group":"Leads","pages":[{"title":"Modify existing lead/customer","openapi":"openapi-leads PUT /update","href":"/api-reference-v1/leads-api/update"},{"title":"List leads/customers","openapi":"openapi-leads GET /list","href":"/api-reference-v1/leads-api/list"},{"title":"Show leads and customers details","openapi":"openapi-leads GET /show","href":"/api-reference-v1/leads-api/show"},{"title":"Delete lead/customer","openapi":"openapi-leads DELETE /delete","href":"/api-reference-v1/leads-api/delete"}]},{"group":"Promoters","pages":[{"title":"Create a new promoter","openapi":"openapi-promoters POST /create","href":"/api-reference-v1/promoters-api/create"},{"title":"Modify existing promoter","openapi":"openapi-promoters PUT /update","href":"/api-reference-v1/promoters-api/update"},{"title":"List promoters","openapi":"openapi-promoters GET /list","href":"/api-reference-v1/promoters-api/list"},{"title":"Show promoter details and balance","openapi":"openapi-promoters GET /show","href":"/api-reference-v1/promoters-api/show-details"},{"title":"Move/switch a promoter from one campaign to another","openapi":"openapi-promoters POST /move_to_campaign","description":"This endpoint will change the promoter's campaign to another one, keeping the referral ID the same (the affiliate won’t need to update the referral link). It serves the same function as moving the promoter to another campaign from the UI.More details on how it works can be found [here](https://help.firstpromoter.com/en/articles/2509650-moving-promoters-from-one-campaign-to-another).\u003cbr/>\u003cbr/>You can identify promoters by: `id`, `cust_id`, `auth_token`, `promoter_email` or `ref_id`(referral id).\u003cTip> **HTTP Request** \u003cbr/> `POST https://firstpromoter.com/api/v1/promoters/move_to_campaign` \u003c/Tip>","href":"/api-reference-v1/promoters-api/move-to-campaign"},{"title":"Add a promoter to a campaign","openapi":"openapi-promoters POST /add_to_campaign","href":"/api-reference-v1/promoters-api/add-to-campaign"},{"title":"Reset promoter's authentication token","openapi":"openapi-promoters PUT /refresh_token","description":"Resetting the authentication token (`auth_token`), which is used to automatically sign in your promoters (if you use this feature), is not required but can enhance the security of the promoter dashboard. You can set up a cron job to call the API endpoint and store the new auth_token from the response. \u003cbr/>\u003cbr/>You can identify promoters by id, cust_id, or auth_token; only one is required.\u003cTip> **HTTP Request** \u003cbr/> `PUT https://firstpromoter.com/api/v1/promoters/refresh_token` \u003c/Tip>","href":"/api-reference-v1/promoters-api/refresh-token"},{"title":"Delete a promoter","openapi":"openapi-promoters DELETE /delete","href":"/api-reference-v1/promoters-api/delete"}]},{"group":"Rewards","pages":[{"title":"Create new reward","openapi":"openapi-rewards POST /create","href":"/api-reference-v1/rewards-api/create"},{"title":"List rewards and commissions","openapi":"openapi-rewards GET /list","href":"/api-reference-v1/rewards-api/list"},{"title":"Update a reward or commission","openapi":"openapi-rewards PUT /update","href":"/api-reference-v1/rewards-api/update"}]},{"group":"Payouts","pages":[{"title":"List payouts","openapi":"openapi-payouts GET /list","href":"/api-reference-v1/payouts-api/list"},{"title":"Create a new payout","openapi":"openapi-payouts POST /create","href":"/api-reference-v1/payouts-api/create"},{"title":"Change payouts status","openapi":"openapi-payouts PUT /update","href":"/api-reference-v1/payouts-api/update"}]},{"group":"Reports","pages":[{"title":"Overview reports","openapi":"openapi-reports GET /overview","href":"/api-reference-v1/reports-api/overview"},{"title":"Campaign reports","openapi":"openapi-reports GET /campaigns","href":"/api-reference-v1/reports-api/campaign"},{"title":"Promoter reports","openapi":"openapi-reports GET /promoters","href":"/api-reference-v1/reports-api/promoter"}]}]}]},{"anchor":"API Reference","icon":"webhook","href":"https://docs.firstpromoter.com/api-reference-v1/introduction"},{"anchor":"Help Center","icon":"square-question","href":"https://help.firstpromoter.com/en/"}]}]},"basePath":"","title":"Add a promoter to a campaign - FirstPromoter Docs","buildId":"dpl_9VVk5y1P8k1ATeJguVngy9Q3cmbD","deploymentId":"dpl_9VVk5y1P8k1ATeJguVngy9Q3cmbD","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DX1Meug0.js","utils-B_OMIQVC.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-ChxhRPMa.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CuKvD8Iv.js","snippetPresets-C5d7p2hp.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CfHcE8m4.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C1zZV314.js","shallow-CmQhqCJn.js","getApiPlaygroundDisplay-YRo9s1O7.js","CodeSnippet-RN1MTdfk.js","CodeSnippets-DKLPHxJA.js","Page-BAvA99GL.js","getPastedJson-bz0M41mU.js","icon-CsmhpPrv.js","MethodPill-CNGsVE77.js","DuplicateIcon-DilfU_Z2.js","createIcon-BdsYzQck.js","DynamicMarkdown-CbqEDjbV.js","SectionHeading-O6hXpFCN.js","axios-vUo_bRtp.js","Markdown-nKm-uidQ.js","clsx-ClVdStUn.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CIQkMg3R.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-ImrFS4Fy.js"]}