Your customer's user ID inside your application/system for the promoter. It will be available in the webhooks to identify the promoter in your system if you subscribe for FirstPromoter webhooks.
Customer promo code from your billing provider to assign 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) can use on the checkout form/page.
The ID of the campaign to assign the promoter to. On the campaigns sections you can see the id as 'camp_id' query parameter on 'Promoter Sign Up page URL'. If there is no 'camp_id' it means the campaign is the default campaign and this parameter is not required.
A temporary password promoters can use to log in to their dashboard if you don't use authentication tokens(auth_token) to sign promoters in automatically.
You can set up a custom landing page url for this promoter. The referral id will be appended to it, unless the 'url_tracking' parameter(below) is used.
Set true to enable direct url tracking feature. FirstPromoter will do the tracking based on landing_url(above) without requiring the referral id to be appended to the url. The landing_url needs to be unique for each promoter. Default is false.
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":""},"entitlements":{},"buildId":"6aedb2dbad97e8452b1fe618","clientVersion":"0.0.4094","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":"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":"editor-metadata","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},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference-v1/promoters-api/update","slug":"/api-reference-v1/promoters-api/update","pageMetadata":{"title":"Modify existing promoter","openapi":"openapi-promoters PUT /update","description":"You can identify promoters by: `id`, `email`, `cust_id`, `auth_token` or `ref_id`(referral id). You need to pass at least one of these parameters.","href":"/api-reference-v1/promoters-api/update"},"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 ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"You can identify promoters by: \", _jsx(_components.code, {\n children: \"id\"\n }), \", \", _jsx(_components.code, {\n children: \"email\"\n }), \", \", _jsx(_components.code, {\n children: \"cust_id\"\n }), \", \", _jsx(_components.code, {\n children: \"auth_token\"\n }), \" or \", _jsx(_components.code, {\n children: \"ref_id\"\n }), \"(referral id). You need to pass at least one of these parameters.\"]\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};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}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":"Modify existing promoter","openapi":"openapi-promoters PUT /update","description":"You can identify promoters by: `id`, `email`, `cust_id`, `auth_token` or `ref_id`(referral id). You need to pass at least one of these parameters.","href":"/api-reference-v1/promoters-api/update"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/firstpromoter/8ad42af542d542c7/downloadables/fpr-prox.js"],"openApiReferenceData":{"operation":{"description":"You can identify promoters by: `id`, `email`, `cust_id`, `auth_token` or `ref_id`(referral id). You need to pass at least one of these parameters.","parameters":["052e18e7-e771-4533-b0b7-48b2c57f7f99","eba4e803-0345-4987-9bcf-7f0a478456ad","32304f47-f5ac-4151-8a88-9ec3ad0a7715","779999f9-f56e-4309-827e-6d54d428d03e","ce01403e-c5dd-4613-a9b5-c6faee9e0a0c","468868ed-58db-4b5c-842c-c0ac65ecf691","60ffe82a-9de4-4b0d-a2b5-d4109ac05662","9751f361-6f11-4de5-8d47-9992536aee0e","89e69d80-5584-428b-a12b-b86840746dac","f3bd7c27-2707-45e4-b033-88cd656b90bf","0a4c1fef-ef5a-4ab1-ac55-2a4da9bb5525","388af90f-9844-449d-9774-2c90d0d8cd88","cf734db6-b1ab-49e1-8ebf-01bf0acc20e3","f5e5353b-79c8-4366-9b81-a2d1c36237f9","b508d56b-48a3-4255-a402-6b5c94a04139","51f2b9db-bef6-4ea3-a7b7-d13f709245d5","ae02266f-6d74-4d48-9909-155e87cfeb17","62d9c7cb-0940-4c91-aa78-23bfc2e3955f","fd303d39-69a1-4f55-95bd-b034196d3cc4","936b1a88-3fee-4e83-9b6a-9597181b0c4d","1aae3239-e843-463b-b16d-661086702875","4f8dce2b-309e-49de-8802-e882d20e8688","8fbfb4ab-35e3-40de-8792-cb26394e7488","94ecc96b-38cc-4186-9e51-6861ac18e4cf","ee597900-f5ea-419a-b4b0-d1d009a82088","59d3fd56-3fc9-4add-a0b1-7370f33834ad","42429ff2-88bb-4a6a-be78-275963ee269e","6c85c0b1-a2e0-45de-a593-4fbb288b388b"],"responses":{"200":"afb995d0-379e-41ca-b457-575c2cc0b8ee","401":"1466cc8f-4b94-4d63-918b-ff47dde59413","404":"2c446587-4761-4fee-8655-d05d575e4a7f","422":"e9860965-11c4-497a-a43c-a2425367e559"},"method":"put","type":"path","servers":["cf343685-35f1-4bf3-bc4e-8859f920d6d8"],"security":["269911f4-0f00-42c0-8c6f-e9436c156c27"],"path":"/update","baseUrlOptions":["https://firstpromoter.com/api/v1/promoters"],"title":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"052e18e7-e771-4533-b0b7-48b2c57f7f99":{"name":"id","in":"query","required":false,"description":"`Required if email is not provided.` The promoter's ID inside FirstPromoter.","schema":{"type":"string","isRequired":false,"description":"`Required if email is not provided.` The promoter's ID inside FirstPromoter.","uniqueKey":"","typeLabel":"string"}},"eba4e803-0345-4987-9bcf-7f0a478456ad":{"name":"email","in":"query","required":false,"description":"`Required if id is not provided.` The promoter's email address.","schema":{"type":"string","format":"email","isRequired":false,"description":"`Required if id is not provided.` The promoter's email address.","uniqueKey":"","typeLabel":"string\u003cemail>"}},"32304f47-f5ac-4151-8a88-9ec3ad0a7715":{"name":"first_name","in":"query","description":"Promoter's first name","schema":{"type":"string","description":"Promoter's first name","uniqueKey":"","typeLabel":"string"}},"779999f9-f56e-4309-827e-6d54d428d03e":{"name":"last_name","in":"query","description":"Promoter's last name","schema":{"type":"string","description":"Promoter's last name","uniqueKey":"","typeLabel":"string"}},"ce01403e-c5dd-4613-a9b5-c6faee9e0a0c":{"name":"cust_id","in":"query","description":"Your customer's user ID inside your application/system for the promoter. It will be available in the webhooks to identify the promoter in your system if you subscribe for FirstPromoter webhooks.","schema":{"type":"string","description":"Your customer's user ID inside your application/system for the promoter. It will be available in the webhooks to identify the promoter in your system if you subscribe for FirstPromoter webhooks.","uniqueKey":"","typeLabel":"string"}},"468868ed-58db-4b5c-842c-c0ac65ecf691":{"name":"new_cust_id","in":"query","description":"Your customer's new user ID","schema":{"type":"string","description":"Your customer's new user ID","uniqueKey":"","typeLabel":"string"}},"60ffe82a-9de4-4b0d-a2b5-d4109ac05662":{"name":"ref_id","in":"query","description":"Referral ID. If this is blank an ID is assigned based on the first name. Can be only `lower-case letters`, `numbers`, `-`(hyphen) and `_`(underscore)","schema":{"type":"string","description":"Referral ID. If this is blank an ID is assigned based on the first name. Can be only `lower-case letters`, `numbers`, `-`(hyphen) and `_`(underscore)","uniqueKey":"","typeLabel":"string"}},"9751f361-6f11-4de5-8d47-9992536aee0e":{"name":"new_ref_id","in":"query","description":"The new referral ID. Can be only `lower-case letters`, `numbers`, `-`(hyphen) and `_`(underscore)","schema":{"type":"string","description":"The new referral ID. Can be only `lower-case letters`, `numbers`, `-`(hyphen) and `_`(underscore)","uniqueKey":"","typeLabel":"string"}},"89e69d80-5584-428b-a12b-b86840746dac":{"name":"auth_token","in":"query","description":"Authetication token generated when the promoter was created","schema":{"type":"string","description":"Authetication token generated when the promoter was created","uniqueKey":"","typeLabel":"string"}},"f3bd7c27-2707-45e4-b033-88cd656b90bf":{"name":"promo_code","in":"query","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`","schema":{"type":"string","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`","uniqueKey":"","typeLabel":"string"}},"0a4c1fef-ef5a-4ab1-ac55-2a4da9bb5525":{"name":"customer_promo_code","in":"query","description":"Customer promo code from your billing provider to assign 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) can use on the checkout form/page.","schema":{"type":"string","description":"Customer promo code from your billing provider to assign 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) can use on the checkout form/page.","uniqueKey":"","typeLabel":"string"}},"388af90f-9844-449d-9774-2c90d0d8cd88":{"name":"campaign_id","in":"query","description":"The ID of the campaign to assign the promoter to. On the campaigns sections you can see the id as 'camp_id' query parameter on 'Promoter Sign Up page URL'. If there is no 'camp_id' it means the campaign is the default campaign and this parameter is not required.","schema":{"type":"string","description":"The ID of the campaign to assign the promoter to. On the campaigns sections you can see the id as 'camp_id' query parameter on 'Promoter Sign Up page URL'. If there is no 'camp_id' it means the campaign is the default campaign and this parameter is not required.","uniqueKey":"","typeLabel":"string"}},"cf734db6-b1ab-49e1-8ebf-01bf0acc20e3":{"name":"temp_password","in":"query","description":"A temporary password promoters can use to log in to their dashboard if you don't use authentication tokens(auth_token) to sign promoters in automatically.","schema":{"type":"string","description":"A temporary password promoters can use to log in to their dashboard if you don't use authentication tokens(auth_token) to sign promoters in automatically.","uniqueKey":"","typeLabel":"string"}},"f5e5353b-79c8-4366-9b81-a2d1c36237f9":{"name":"landing_url","in":"query","description":"You can set up a custom landing page url for this promoter. The referral id will be appended to it, unless the 'url_tracking' parameter(below) is used.","schema":{"type":"string","description":"You can set up a custom landing page url for this promoter. The referral id will be appended to it, unless the 'url_tracking' parameter(below) is used.","uniqueKey":"","typeLabel":"string"}},"b508d56b-48a3-4255-a402-6b5c94a04139":{"name":"url_tracking","in":"query","description":"Set `true` to enable direct url tracking feature. FirstPromoter will do the tracking based on `landing_url`(above) without requiring the referral id to be appended to the url. The `landing_url` needs to be unique for each promoter. Default is `false`. ","schema":{"type":"string","description":"Set `true` to enable direct url tracking feature. FirstPromoter will do the tracking based on `landing_url`(above) without requiring the referral id to be appended to the url. The `landing_url` needs to be unique for each promoter. Default is `false`. ","uniqueKey":"","typeLabel":"string"}},"51f2b9db-bef6-4ea3-a7b7-d13f709245d5":{"name":"website","in":"query","description":"Promoter's website ","schema":{"type":"string","description":"Promoter's website ","uniqueKey":"","typeLabel":"string"}},"ae02266f-6d74-4d48-9909-155e87cfeb17":{"name":"paypal_email","in":"query","description":"Promoter's Paypal email address","schema":{"type":"string","description":"Promoter's Paypal email address","uniqueKey":"","typeLabel":"string"}},"62d9c7cb-0940-4c91-aa78-23bfc2e3955f":{"name":"avatar_url","in":"query","description":"URL of the profile picture promoters can see on their dashboard","schema":{"type":"string","description":"URL of the profile picture promoters can see on their dashboard","uniqueKey":"","typeLabel":"string"}},"fd303d39-69a1-4f55-95bd-b034196d3cc4":{"name":"parent_promoter_email","in":"query","description":"Parent promoter email when promoter is a sub-affiliate","schema":{"type":"string","description":"Parent promoter email when promoter is a sub-affiliate","uniqueKey":"","typeLabel":"string"}},"936b1a88-3fee-4e83-9b6a-9597181b0c4d":{"name":"linkedin_url","in":"query","description":"Promoter's linkedin url","schema":{"type":"string","description":"Promoter's linkedin url","uniqueKey":"","typeLabel":"string"}},"1aae3239-e843-463b-b16d-661086702875":{"name":"twitter_url","in":"query","description":"Promoter's twitter url","schema":{"type":"string","description":"Promoter's twitter url","uniqueKey":"","typeLabel":"string"}},"4f8dce2b-309e-49de-8802-e882d20e8688":{"name":"facebook_url","in":"query","description":"Promoter's facebook url","schema":{"type":"string","description":"Promoter's facebook url","uniqueKey":"","typeLabel":"string"}},"8fbfb4ab-35e3-40de-8792-cb26394e7488":{"name":"instagram_url","in":"query","description":"Promoter's instagram url","schema":{"type":"string","description":"Promoter's instagram url","uniqueKey":"","typeLabel":"string"}},"94ecc96b-38cc-4186-9e51-6861ac18e4cf":{"name":"youtube_url","in":"query","description":"Promoter's youtube url","schema":{"type":"string","description":"Promoter's youtube url","uniqueKey":"","typeLabel":"string"}},"ee597900-f5ea-419a-b4b0-d1d009a82088":{"name":"country","in":"query","description":"Promoter's country","schema":{"type":"string","description":"Promoter's country","uniqueKey":"","typeLabel":"string"}},"59d3fd56-3fc9-4add-a0b1-7370f33834ad":{"name":"phone_number","in":"query","description":"Promoter's phone number","schema":{"type":"string","description":"Promoter's phone number","uniqueKey":"","typeLabel":"string"}},"42429ff2-88bb-4a6a-be78-275963ee269e":{"name":"address","in":"query","description":"Promoter's address","schema":{"type":"string","description":"Promoter's address","uniqueKey":"","typeLabel":"string"}},"6c85c0b1-a2e0-45de-a593-4fbb288b388b":{"name":"note","in":"query","description":"A note/description of promoter","schema":{"type":"string","description":"A note/description of promoter","uniqueKey":"","typeLabel":"string"}}},"responses":{"afb995d0-379e-41ca-b457-575c2cc0b8ee":{"description":"Success 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[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":123,"status":"approved","cust_id":"\u003cstring>","email":"\u003cstring>","created_at":"\u003cstring>","temp_password":"\u003cstring>","default_promotion_id":128833,"pref":"\u003cstring>","default_ref_id":"\u003cstring>","note":"\u003cstring>","w8_form_url":"\u003cstring>","w9_form_url":"\u003cstring>","parent_promoter_id":"\u003cstring>","earnings_balance":{"cash":3000,"credits":300,"discount_per":30},"current_balance":{"cash":1000,"credits":200,"discount_per":15},"paid_balance":{"cash":2000,"credits":100,"discount_per":15},"auth_token":"\u003cstring>","profile":{"first_name":"\u003cstring>","last_name":"\u003cstring>","website":"\u003cstring>","company_name":"\u003cstring>","phone_number":"\u003cstring>","address":"\u003cstring>","vat_id":"\u003cstring>","country":"\u003cstring>","paypal_email":"\u003cstring>","avatar_url":"\u003cstring>","description":"\u003cstring>","social_accounts":{"twitter":{"url":"\u003cstring>"},"youtube":{"url":"\u003cstring>"},"facebook":{"url":"\u003cstring>"},"linkedin":{"url":"\u003cstring>"},"instagram":{"url":"\u003cstring>"}}},"promotions":[{"id":123,"status":"\u003cstring>","ref_id":"\u003cstring>","promo_code":"\u003cstring>","customer_promo_code":"\u003cstring>","target_reached_at":{},"promoter_id":123,"campaign_id":123,"referral_link":"\u003cstring>","current_offer":{"id":123,"name":"\u003cstring>","amount":123,"unit":"\u003cstring>","default_promo_code":"\u003cstring>"},"current_referral_reward":{"id":123,"amount":123,"unit":"\u003cstring>","name":"\u003cstring>","per_of_sale":123,"default_promo_code":"\u003cstring>"},"current_promotion_reward":{},"current_target_reward":{},"campaign_name":"\u003cstring>","hidden":true,"visitors_count":123,"leads_count":123,"customers_count":123,"refunds_count":123,"cancellations_count":123,"sales_count":123,"sales_total":123,"refunds_total":123,"active_customers_count":123}],"custom_fields":{},"promo_codes":[{"id":123,"code":"\u003cstring>","reward":{"id":123,"name":"\u003cstring>"}}]}}},"exampleType":"generated"}},"exampleType":"generated"},"1466cc8f-4b94-4d63-918b-ff47dde59413":{"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"},"2c446587-4761-4fee-8655-d05d575e4a7f":{"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"},"e9860965-11c4-497a-a43c-a2425367e559":{"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, promoter_email or promo_code"},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"You need to find the promoter either by id, cust_id, auth_token, ref_id, promoter_email or promo_code"}}},"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":"Modify existing promoter - FirstPromoter Docs","navMaps":{"firstHrefInVersion":{"v2":{"href":"/api-reference-v2/api-admin/promoters/get-available-promoters","matchLevel":2},"v1":{"href":"/api-reference-v1/promoters-api/update","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-05-21T17:16:13.239Z","originalFileLocation":"api-reference-v1/promoters-api/update.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=\"You can identify promoters by: id, email, cust_id, auth_token or ref_id(referral id). You need to pass at least one of these parameters.\">\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=\"Modify existing promoter - FirstPromoter Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"You can identify promoters by: id, email, cust_id, auth_token or ref_id(referral id). You need to pass at least one of these parameters.\">\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/update\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://firstpromoter.mintlify.site/_mintlify/api/og/v2?division=Promoters\u0026amp;title=Modify+existing+promoter\u0026amp;description=You+can+identify+promoters+by%3A+%60id%60%2C+%60email%60%2C+%60cust_id%60%2C+%60auth_token%60+or+%60ref_id%60%28referral+id%29.+You+need+to+pass+at+least+one+of+these+parameters.\u0026amp;theme=fff9650e72028c28308bb6bc\u0026amp;signature=e3d382a881eae6bf5ce4e5f6345888bc4c88eaf1b8721ddd7b647663d21bb2ca\">\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=\"Modify existing promoter - FirstPromoter Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"You can identify promoters by: id, email, cust_id, auth_token or ref_id(referral id). You need to pass at least one of these parameters.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://firstpromoter.mintlify.site/_mintlify/api/og/v2?division=Promoters\u0026amp;title=Modify+existing+promoter\u0026amp;description=You+can+identify+promoters+by%3A+%60id%60%2C+%60email%60%2C+%60cust_id%60%2C+%60auth_token%60+or+%60ref_id%60%28referral+id%29.+You+need+to+pass+at+least+one+of+these+parameters.\u0026amp;theme=fff9650e72028c28308bb6bc\u0026amp;signature=e3d382a881eae6bf5ce4e5f6345888bc4c88eaf1b8721ddd7b647663d21bb2ca\">\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/update\">\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/update.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/update#webpage\",\"url\":\"https://docs.firstpromoter.com/api-reference-v1/promoters-api/update\",\"name\":\"Modify existing promoter\",\"description\":\"You can identify promoters by: id, email, cust_id, auth_token or ref_id(referral id). You need to pass at least one of these parameters.\",\"dateModified\":\"2026-05-21T17:16:13.239Z\",\"isPartOf\":{\"@id\":\"https://docs.firstpromoter.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.firstpromoter.com/api-reference-v1/promoters-api/update#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.firstpromoter.com/api-reference-v1/promoters-api/update#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Promoters\",\"item\":\"https://docs.firstpromoter.com/api-reference-v1/promoters-api/create\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Modify existing promoter\",\"item\":\"https://docs.firstpromoter.com/api-reference-v1/promoters-api/update\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.firstpromoter.com/api-reference-v1/promoters-api/update#apireference\",\"headline\":\"Modify existing promoter\",\"name\":\"Modify existing promoter\",\"description\":\"You can identify promoters by: id, email, cust_id, auth_token or ref_id(referral id). You need to pass at least one of these parameters.\",\"url\":\"https://docs.firstpromoter.com/api-reference-v1/promoters-api/update\",\"mainEntityOfPage\":{\"@id\":\"https://docs.firstpromoter.com/api-reference-v1/promoters-api/update#webpage\"},\"dateModified\":\"2026-05-21T17:16:13.239Z\",\"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","description":"Use this endpoint to create new promoters using the API. The response will return the newly added promoter as JSON. Probably the most important value from the response is `auth_token`, which is a unique key auto-generated on creation and can be used to automatically log in your promoters to their dashboard. [Learn more](https://help.firstpromoter.com/faq/how-to-embed-the-promoter-dashboard-inside-your-website-and-log-your-users-in-automatically). \u003cNote> If this call is successful and you enabled `Promoter sign up accepted` emails for the campaign, it will start sending emails to the promoter. To skip the emails, set the `skip_email_notification` parameter to `true`\u003c/Note>\u003cTip>**HTTP Request** \u003cbr/>\u003cbr/> `POST https://firstpromoter.com/api/v1/promoters/create`\u003c/Tip>","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","description":"Use this endpoint to list your promoters using the API. The response will return the promoters as JSON array.\u003cNote> Pagination details are held on response headers. Add `--include` option on `curl` request to see the pagination details format and links to next pages.\u003c/Note>\u003cTip>**HTTP Request** \u003cbr/> `GET https://firstpromoter.com/api/v1/promoters/list`\u003c/Tip>","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","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","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":"Modify existing promoter - FirstPromoter Docs","buildId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","deploymentId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C-hEh3I2.js","utils-CnF4QiUD.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C7PVNbel.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-8ytevL2A.js","snippetPresets-BT1alx3v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BLXC0i_W.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CyLIGI9_.js","shallow-DC0lGVIW.js","getApiPlaygroundDisplay-CgDQ85tN.js","CodeSnippet-6-I-Gpv9.js","CodeSnippets-BAk1kDdu.js","Page-C945cI-W.js","getPastedJson-B276RuWN.js","icon-BqP8etTm.js","MethodPill-DM6sbxG1.js","DuplicateIcon-PyJglOaE.js","createIcon-CMeOMAc_.js","DynamicMarkdown-BoyYAA8K.js","SectionHeading-DAYv3gvZ.js","axios-vUo_bRtp.js","Markdown-BhTTmazV.js","clsx-CR-RHrVC.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CBUH0-zX.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BmARFYNC.js"]}