API key passed as a Bearer token in the Authorization header. You can find your API Key on Your FirstPromoter Dashboard. Navigate to Settings → Integrations section → Manage API Keys
Commission split details from the associated referral, when the referral is shared between promoters
{"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-v2/api-admin/commissions/create-a-commission","slug":"/api-reference-v2/api-admin/commissions/create-a-commission","pageMetadata":{"openapi":"openapi-v2-commissions post /commissions","title":"Create a commission","description":"With this endpoint you can create a commission. \n \u003cTip>**HTTP Request** \u003cbr/>`POST https://api.firstpromoter.com/api/v2/company/commissions`\u003c/Tip>","href":"/api-reference-v2/api-admin/commissions/create-a-commission"},"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: [\"With this endpoint you can create a commission.\\n\", _jsxs(Tip, {\n children: [_jsx(_components.strong, {\n children: \"HTTP Request\"\n }), \" \", _jsx(\"br\", {}), _jsx(_components.code, {\n children: \"POST https://api.firstpromoter.com/api/v2/company/commissions\"\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}=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":{"openapi":"openapi-v2-commissions post /commissions","title":"Create a commission","description":"With this endpoint you can create a commission. \n \u003cTip>**HTTP Request** \u003cbr/>`POST https://api.firstpromoter.com/api/v2/company/commissions`\u003c/Tip>","href":"/api-reference-v2/api-admin/commissions/create-a-commission"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/firstpromoter/8ad42af542d542c7/downloadables/fpr-prox.js"],"openApiReferenceData":{"operation":{"summary":"Create a commission","description":"With this endpoint you can create a commission. \n \u003cTip>**HTTP Request** \u003cbr/>`POST https://api.firstpromoter.com/api/v2/company/commissions`\u003c/Tip>","tags":["Commissions"],"parameters":["dc151d7c-1edd-43b7-b3f5-1e20bc1518fe"],"requestBody":"ef84e0b3-3a35-4c3b-b8f1-b8e9d0252816","responses":{"200":"01ddb384-04e9-4ffd-9716-0391fdee189c","401":"79928a1b-07e4-41cb-a44b-54ae4c1851c9","403":"b3b9d2b1-37bf-4d3c-9f0a-1599a6568525"},"method":"post","type":"path","servers":["f3519daa-38e6-4802-99e7-62ee1b274664"],"security":["59a9b293-ff10-4700-8b40-d9eadfc2f4fa"],"path":"/commissions","baseUrlOptions":["https://api.firstpromoter.com/api/v2/company"],"title":"Create a commission","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"dc151d7c-1edd-43b7-b3f5-1e20bc1518fe":{"name":"Account-ID","in":"header","required":true,"description":"Account id. You can find your Account ID on Your FirstPromoter Dashboard. Navigate to Settings → Integrations","schema":{"type":"string","isRequired":true,"description":"Account id. You can find your Account ID on Your FirstPromoter Dashboard. Navigate to Settings → Integrations","uniqueKey":"","typeLabel":"string"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"Sale Commission","required":["commission_type","referral_id","sale_amount"],"properties":{"commission_type":{"type":"string","enum":["sale"],"description":"The commission type","isRequired":true,"uniqueKey":"oneOf.0.commission_type","typeLabel":"enum\u003cstring>"},"referral_id":{"type":"integer","description":"Referral id. Required for sale commission type.","isRequired":true,"uniqueKey":"oneOf.0.referral_id","typeLabel":"integer"},"sale_amount":{"type":"integer","description":"Sale amount in cents. Required for sale commission type.","isRequired":true,"uniqueKey":"oneOf.0.sale_amount","typeLabel":"integer"},"plan_id":{"type":"integer","description":"One of the items id from price_ids","uniqueKey":"oneOf.0.plan_id","typeLabel":"integer"},"event_id":{"type":"string","description":"The ID of the event that generated the sale from billing provider","uniqueKey":"oneOf.0.event_id","typeLabel":"string"},"event_date":{"type":"string","format":"date","description":"The date of the event that generated the sale","uniqueKey":"oneOf.0.event_date","typeLabel":"string\u003cdate>"},"internal_note":{"type":"string","description":"Internal note visible only by the team","uniqueKey":"oneOf.0.internal_note","typeLabel":"string"},"external_note":{"type":"string","description":"External note visible by the promoter","uniqueKey":"oneOf.0.external_note","typeLabel":"string"},"unit":{"type":"string","enum":["cash","credits","points","free_months","mon_discount","discount_per"],"description":"Set the reward unit type","uniqueKey":"oneOf.0.unit","typeLabel":"enum\u003cstring>"},"notify_promoter":{"type":"boolean","description":"If true a notification email is sent to promoter if enabled on Emails section","uniqueKey":"oneOf.0.notify_promoter","typeLabel":"boolean"},"billing_period":{"type":"string","enum":["monthly","yearly","one_time"],"description":"The billing period of the event that generated the sale","uniqueKey":"oneOf.0.billing_period","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.0","typeLabel":"Sale Commission · object"},{"type":"object","title":"Custom Commission","required":["commission_type","promoter_campaign_id","amount"],"properties":{"commission_type":{"type":"string","enum":["custom"],"description":"The commission type","isRequired":true,"uniqueKey":"oneOf.1.commission_type","typeLabel":"enum\u003cstring>"},"promoter_campaign_id":{"type":"integer","description":"PromoterCampaign id. Required for custom commission type. This ID is not the promoter’s ID or the campaign’s ID. It’s the linking record that defines the promoter’s participation in that campaign. You can find this id in each object in the promoter_campaigns array when you get the details of the promoter.","isRequired":true,"uniqueKey":"oneOf.1.promoter_campaign_id","typeLabel":"integer"},"amount":{"type":"integer","description":"Commission amount in cents. Required for custom commission type.","isRequired":true,"uniqueKey":"oneOf.1.amount","typeLabel":"integer"},"event_id":{"type":"string","description":"The ID of the event that generated the sale from billing provider","uniqueKey":"oneOf.1.event_id","typeLabel":"string"},"event_date":{"type":"string","format":"date","description":"The date of the event that generated the sale","uniqueKey":"oneOf.1.event_date","typeLabel":"string\u003cdate>"},"internal_note":{"type":"string","description":"Internal note visible only by the team","uniqueKey":"oneOf.1.internal_note","typeLabel":"string"},"external_note":{"type":"string","description":"External note visible by the promoter","uniqueKey":"oneOf.1.external_note","typeLabel":"string"},"unit":{"type":"string","enum":["cash","credits","points","free_months","mon_discount","discount_per"],"description":"Set the reward unit type","uniqueKey":"oneOf.1.unit","typeLabel":"enum\u003cstring>"},"notify_promoter":{"type":"boolean","description":"If true a notification email is sent to promoter if enabled on Emails section","uniqueKey":"oneOf.1.notify_promoter","typeLabel":"boolean"},"billing_period":{"type":"string","enum":["monthly","yearly","one_time"],"description":"The billing period of the event that generated the sale","uniqueKey":"oneOf.1.billing_period","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.1","typeLabel":"Custom Commission · object"}],"uniqueKey":"","typeLabel":"Sale Commission · object | Custom Commission · object"},"examples":{"Example":{"title":"Example","value":{"commission_type":"sale","referral_id":123,"sale_amount":123,"plan_id":123,"event_id":"\u003cstring>","event_date":"2023-12-25","internal_note":"\u003cstring>","external_note":"\u003cstring>","notify_promoter":true}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"01ddb384-04e9-4ffd-9716-0391fdee189c":{"description":"Successfully retrieved commissions","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"Commission ID","uniqueKey":"items.[INDEX].id","typeLabel":"integer"},"status":{"type":"string","enum":["pending","approved","denied"],"description":"Current status of the commission","uniqueKey":"items.[INDEX].status","typeLabel":"enum\u003cstring>"},"metadata":{"type":"object","description":"Additional metadata about the commission","uniqueKey":"items.[INDEX].metadata","typeLabel":"object"},"is_self_referral":{"oneOf":[{"type":"boolean","description":"Whether this is a self-referral","uniqueKey":"items.[INDEX].is_self_referral.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Whether this is a self-referral","uniqueKey":"items.[INDEX].is_self_referral.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].is_self_referral","typeLabel":"boolean | null"},"commission_type":{"type":"string","enum":["sale","custom"],"description":"Type of commission","uniqueKey":"items.[INDEX].commission_type","typeLabel":"enum\u003cstring>"},"created_by_user_email":{"oneOf":[{"type":"string","description":"Email of the user who created the commission","uniqueKey":"items.[INDEX].created_by_user_email.oneOf.0","typeLabel":"string"},{"type":"null","description":"Email of the user who created the commission","uniqueKey":"items.[INDEX].created_by_user_email.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].created_by_user_email","typeLabel":"string | null"},"created_by_user_at":{"oneOf":[{"type":"string","format":"date-time","description":"Timestamp when the user created the commission","uniqueKey":"items.[INDEX].created_by_user_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Timestamp when the user created the commission","uniqueKey":"items.[INDEX].created_by_user_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].created_by_user_at","typeLabel":"string\u003cdate-time> | null"},"sale_amount":{"type":"integer","description":"Amount of the sale","uniqueKey":"items.[INDEX].sale_amount","typeLabel":"integer"},"original_sale_amount":{"type":"integer","description":"Original amount of the sale","uniqueKey":"items.[INDEX].original_sale_amount","typeLabel":"integer"},"original_sale_currency":{"oneOf":[{"type":"string","description":"Currency of the original sale","uniqueKey":"items.[INDEX].original_sale_currency.oneOf.0","typeLabel":"string"},{"type":"null","description":"Currency of the original sale","uniqueKey":"items.[INDEX].original_sale_currency.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].original_sale_currency","typeLabel":"string | null"},"event_id":{"oneOf":[{"type":"string","description":"ID of the event that generated the commission","uniqueKey":"items.[INDEX].event_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"ID of the event that generated the commission","uniqueKey":"items.[INDEX].event_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].event_id","typeLabel":"string | null"},"plan_id":{"oneOf":[{"type":"string","description":"Plan ID associated with the commission","uniqueKey":"items.[INDEX].plan_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Plan ID associated with the commission","uniqueKey":"items.[INDEX].plan_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].plan_id","typeLabel":"string | null"},"tier":{"type":"integer","description":"Reward tier","uniqueKey":"items.[INDEX].tier","typeLabel":"integer"},"internal_note":{"oneOf":[{"type":"string","description":"Internal note visible only to the team","uniqueKey":"items.[INDEX].internal_note.oneOf.0","typeLabel":"string"},{"type":"null","description":"Internal note visible only to the team","uniqueKey":"items.[INDEX].internal_note.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].internal_note","typeLabel":"string | null"},"external_note":{"oneOf":[{"type":"string","description":"External note visible to the promoter","uniqueKey":"items.[INDEX].external_note.oneOf.0","typeLabel":"string"},{"type":"null","description":"External note visible to the promoter","uniqueKey":"items.[INDEX].external_note.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].external_note","typeLabel":"string | null"},"unit":{"type":"string","enum":["cash","credits","points","free_months","mon_discount","discount_per"],"description":"Unit type for the reward","uniqueKey":"items.[INDEX].unit","typeLabel":"enum\u003cstring>"},"fraud_check":{"oneOf":[{"type":"string","enum":["no_suspicion","same_ip_suspicion","same_promoter_email","ad_source"],"description":"Result of fraud check","uniqueKey":"items.[INDEX].fraud_check.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["no_suspicion","same_ip_suspicion","same_promoter_email","ad_source"],"description":"Result of fraud check","uniqueKey":"items.[INDEX].fraud_check.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].fraud_check","typeLabel":"enum\u003cstring> | null"},"amount":{"type":"integer","description":"Commission amount","uniqueKey":"items.[INDEX].amount","typeLabel":"integer"},"is_paid":{"type":"boolean","description":"Whether the commission has been paid","uniqueKey":"items.[INDEX].is_paid","typeLabel":"boolean"},"is_split":{"type":"boolean","description":"Whether the commission is split among multiple promoters","uniqueKey":"items.[INDEX].is_split","typeLabel":"boolean"},"created_at":{"type":"string","format":"date-time","description":"Creation timestamp","uniqueKey":"items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"status_updated_at":{"oneOf":[{"type":"string","format":"date-time","description":"Last status update timestamp","uniqueKey":"items.[INDEX].status_updated_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Last status update timestamp","uniqueKey":"items.[INDEX].status_updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].status_updated_at","typeLabel":"string\u003cdate-time> | null"},"promoter_campaign":{"type":"object","properties":{"id":{"type":"integer","description":"Promoter campaign ID","uniqueKey":"items.[INDEX].promoter_campaign.id","typeLabel":"integer"},"campaign_id":{"type":"integer","description":"Campaign ID","uniqueKey":"items.[INDEX].promoter_campaign.campaign_id","typeLabel":"integer"},"promoter_id":{"type":"integer","description":"Promoter ID","uniqueKey":"items.[INDEX].promoter_campaign.promoter_id","typeLabel":"integer"},"created_at":{"type":"string","format":"date-time","description":"Creation timestamp","uniqueKey":"items.[INDEX].promoter_campaign.created_at","typeLabel":"string\u003cdate-time>"},"promoter":{"type":"object","properties":{"id":{"type":"integer","description":"Promoter ID","uniqueKey":"items.[INDEX].promoter_campaign.promoter.id","typeLabel":"integer"},"email":{"type":"string","description":"Promoter email","uniqueKey":"items.[INDEX].promoter_campaign.promoter.email","typeLabel":"string"},"name":{"type":"string","description":"Promoter name","uniqueKey":"items.[INDEX].promoter_campaign.promoter.name","typeLabel":"string"}},"uniqueKey":"items.[INDEX].promoter_campaign.promoter","typeLabel":"object"},"campaign":{"type":"object","properties":{"id":{"type":"integer","description":"Campaign ID","uniqueKey":"items.[INDEX].promoter_campaign.campaign.id","typeLabel":"integer"},"name":{"type":"string","description":"Campaign name","uniqueKey":"items.[INDEX].promoter_campaign.campaign.name","typeLabel":"string"},"color":{"oneOf":[{"type":"string","description":"Campaign color","uniqueKey":"items.[INDEX].promoter_campaign.campaign.color.oneOf.0","typeLabel":"string"},{"type":"null","description":"Campaign color","uniqueKey":"items.[INDEX].promoter_campaign.campaign.color.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].promoter_campaign.campaign.color","typeLabel":"string | null"}},"uniqueKey":"items.[INDEX].promoter_campaign.campaign","typeLabel":"object"}},"uniqueKey":"items.[INDEX].promoter_campaign","typeLabel":"object"},"referral":{"oneOf":[{"type":"object","properties":{"id":{"type":"integer","description":"Referral ID","uniqueKey":"items.[INDEX].referral.oneOf.0.id","typeLabel":"integer"},"email":{"type":"string","description":"Referral email","uniqueKey":"items.[INDEX].referral.oneOf.0.email","typeLabel":"string"},"uid":{"type":"string","description":"Referral UID","uniqueKey":"items.[INDEX].referral.oneOf.0.uid","typeLabel":"string"}},"uniqueKey":"items.[INDEX].referral.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"id":{"type":"integer","description":"Referral ID"},"email":{"type":"string","description":"Referral email"},"uid":{"type":"string","description":"Referral UID"}},"uniqueKey":"items.[INDEX].referral.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].referral","typeLabel":"object | null"},"reward":{"type":"object","properties":{"id":{"type":"integer","description":"Reward ID","uniqueKey":"items.[INDEX].reward.id","typeLabel":"integer"},"name":{"type":"string","description":"Reward name","uniqueKey":"items.[INDEX].reward.name","typeLabel":"string"}},"uniqueKey":"items.[INDEX].reward","typeLabel":"object"},"split_details":{"oneOf":[{"type":"object","description":"Commission split details from the associated referral, when the referral is shared between promoters","uniqueKey":"items.[INDEX].split_details.oneOf.0","typeLabel":"object"},{"type":"null","description":"Commission split details from the associated referral, when the referral is shared between promoters","uniqueKey":"items.[INDEX].split_details.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].split_details","typeLabel":"object | null"}},"uniqueKey":"items.[INDEX]","typeLabel":"object"},"uniqueKey":"","typeLabel":"object[]"},"examples":{"Example":{"title":"Example","value":[{"id":123,"status":"pending","metadata":{},"is_self_referral":true,"commission_type":"sale","created_by_user_email":"\u003cstring>","created_by_user_at":"2023-11-07T05:31:56Z","sale_amount":123,"original_sale_amount":123,"original_sale_currency":"\u003cstring>","event_id":"\u003cstring>","plan_id":"\u003cstring>","tier":123,"internal_note":"\u003cstring>","external_note":"\u003cstring>","unit":"cash","fraud_check":"no_suspicion","amount":123,"is_paid":true,"is_split":true,"created_at":"2023-11-07T05:31:56Z","status_updated_at":"2023-11-07T05:31:56Z","promoter_campaign":{"id":123,"campaign_id":123,"promoter_id":123,"created_at":"2023-11-07T05:31:56Z","promoter":{"id":123,"email":"\u003cstring>","name":"\u003cstring>"},"campaign":{"id":123,"name":"\u003cstring>","color":"\u003cstring>"}},"referral":{"id":123,"email":"\u003cstring>","uid":"\u003cstring>"},"reward":{"id":123,"name":"\u003cstring>"},"split_details":{}}]}},"exampleType":"generated"}},"exampleType":"generated"},"79928a1b-07e4-41cb-a44b-54ae4c1851c9":{"description":"Unauthorized — the Bearer access token is missing, invalid, expired, or revoked. No JSON response body is returned.","content":{"application/json":{"schema":{"type":"object","uniqueKey":"","typeLabel":"object"},"example":{},"examples":{"Example":{"title":"Example","value":{}}},"exampleType":"examples"}},"exampleType":"examples"},"b3b9d2b1-37bf-4d3c-9f0a-1599a6568525":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error message","uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","description":"Error code","uniqueKey":"code","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","code":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"59a9b293-ff10-4700-8b40-d9eadfc2f4fa":{"BearerAuth":{"type":"http","scheme":"bearer","description":"API key passed as a Bearer token in the Authorization header. You can find your API Key on Your FirstPromoter Dashboard. Navigate to Settings → Integrations section → Manage API Keys","scopes":[]}}},"servers":{"f3519daa-38e6-4802-99e7-62ee1b274664":{"url":"https://api.firstpromoter.com/api/v2/company"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"API key passed as a Bearer token in the Authorization header. You can find your API Key on Your FirstPromoter Dashboard. Navigate to Settings → Integrations section → Manage API Keys","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"API key passed as a Bearer token in the Authorization header. You can find your API Key on Your FirstPromoter Dashboard. Navigate to Settings → Integrations section → Manage API Keys","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"BearerAuth","name":"Authorization"}],"title":"BearerAuth"}]},"originalFileLocation":"api-reference-v2/api-admin/commissions/openapi-v2-commissions.json"},"subdomain":"firstpromoter","siteName":"FirstPromoter Docs","title":"Create a commission - FirstPromoter Docs","navMaps":{"firstHrefInVersion":{"v2":{"href":"/api-reference-v2/api-admin/commissions/create-a-commission","matchLevel":0},"v1":{"href":"/introduction","matchLevel":4}},"firstHrefInLanguage":{}},"lastModified":"2025-09-24T16:23:41.271Z","originalFileLocation":"api-reference-v2/api-admin/commissions/create-a-commission.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=\"With this endpoint you can create a commission. HTTP Request POST https://api.firstpromoter.com/api/v2/company/commissions\">\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=\"Create a commission - FirstPromoter Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"With this endpoint you can create a commission. HTTP Request POST https://api.firstpromoter.com/api/v2/company/commissions\">\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-v2/api-admin/commissions/create-a-commission\">\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=Commissions\u0026amp;title=Create+a+commission\u0026amp;description=With+this+endpoint+you+can+create+a+commission.+%0A+%3CTip%3E**HTTP+Request**+%3Cbr%2F%3E%60POST+https%3A%2F%2Fapi.firstpromoter.com%2Fapi%2Fv2%2Fcompany%2Fcommissions%60%3C%2FTip%3E\u0026amp;theme=6c5c6938239eba73fb25a5bd\u0026amp;signature=50db9e998fa9cef9ad41104b28fee872d40364fd3daca553730a67462544ef1d\">\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=\"Create a commission - FirstPromoter Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"With this endpoint you can create a commission. HTTP Request POST https://api.firstpromoter.com/api/v2/company/commissions\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://firstpromoter.mintlify.app/_mintlify/api/og/v2?division=Commissions\u0026amp;title=Create+a+commission\u0026amp;description=With+this+endpoint+you+can+create+a+commission.+%0A+%3CTip%3E**HTTP+Request**+%3Cbr%2F%3E%60POST+https%3A%2F%2Fapi.firstpromoter.com%2Fapi%2Fv2%2Fcompany%2Fcommissions%60%3C%2FTip%3E\u0026amp;theme=6c5c6938239eba73fb25a5bd\u0026amp;signature=50db9e998fa9cef9ad41104b28fee872d40364fd3daca553730a67462544ef1d\">\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-v2/api-admin/commissions/create-a-commission\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference-v2/api-admin/commissions/create-a-commission.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-v2/api-admin/commissions/create-a-commission#webpage\",\"url\":\"https://docs.firstpromoter.com/api-reference-v2/api-admin/commissions/create-a-commission\",\"name\":\"Create a commission\",\"description\":\"With this endpoint you can create a commission. HTTP Request POST https://api.firstpromoter.com/api/v2/company/commissions\",\"dateModified\":\"2025-09-24T16:23:41.271Z\",\"isPartOf\":{\"@id\":\"https://docs.firstpromoter.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.firstpromoter.com/api-reference-v2/api-admin/commissions/create-a-commission#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.firstpromoter.com/api-reference-v2/api-admin/commissions/create-a-commission#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Commissions\",\"item\":\"https://docs.firstpromoter.com/api-reference-v2/api-admin/commissions/get-all-commissions\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create a commission\",\"item\":\"https://docs.firstpromoter.com/api-reference-v2/api-admin/commissions/create-a-commission\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.firstpromoter.com/api-reference-v2/api-admin/commissions/create-a-commission#apireference\",\"headline\":\"Create a commission\",\"name\":\"Create a commission\",\"description\":\"With this endpoint you can create a commission. HTTP Request POST https://api.firstpromoter.com/api/v2/company/commissions\",\"url\":\"https://docs.firstpromoter.com/api-reference-v2/api-admin/commissions/create-a-commission\",\"mainEntityOfPage\":{\"@id\":\"https://docs.firstpromoter.com/api-reference-v2/api-admin/commissions/create-a-commission#webpage\"},\"dateModified\":\"2025-09-24T16:23:41.271Z\",\"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","anchors":[{"anchor":"Documentation","icon":"book-open","tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"API Reference","groups":[{"group":"API Documentation","pages":[{"title":"FirstPromoter API v2 Introduction","sidebarTitle":"Introduction","href":"/api-reference-v2/api-admin/introduction"},{"title":"FirstPromoter API v2 Authentication","sidebarTitle":"Authentication","href":"/api-reference-v2/api-admin/authentication"}]},{"group":"Batch Processes","pages":[{"openapi":"openapi-v2-batches get /batch_processes","title":"List in progress batch processes.","href":"/api-reference-v2/api-admin/batches/list-inprogress-batch-processes"},{"openapi":"openapi-v2-batches get /batch_processes/{id}","title":"Show batch process","href":"/api-reference-v2/api-admin/batches/show-batch-process"},{"openapi":"openapi-v2-batches get /batch_processes/progress","title":"Show progress","href":"/api-reference-v2/api-admin/batches/show-progress"}]},{"group":"Tracking Api","pages":[{"title":"Tracking leads and sign-ups","openapi":"openapi-v2-tracking POST /signup","href":"/api-reference-v2/api-admin/tracking-api/leads-and-signups"},{"title":"Tracking sales and commissions","openapi":"openapi-v2-tracking POST /sale","href":"/api-reference-v2/api-admin/tracking-api/sales"},{"title":"Tracking refunds and negative commissions","openapi":"openapi-v2-tracking POST /refund","href":"/api-reference-v2/api-admin/tracking-api/refund"},{"title":"Tracking cancellations","openapi":"openapi-v2-tracking POST /cancellation","href":"/api-reference-v2/api-admin/tracking-api/cancellation"}]},{"group":"Referrals","pages":[{"openapi":"openapi-v2-referrals get /referrals","title":"Get available referrals","href":"/api-reference-v2/api-admin/referrals/get-referrals"},{"openapi":"openapi-v2-referrals get /referrals/{id}","title":"Get referral","href":"/api-reference-v2/api-admin/referrals/get-referral"},{"openapi":"openapi-v2-referrals put /referrals/{id}","title":"Update referral","href":"/api-reference-v2/api-admin/referrals/update-referral"},{"openapi":"openapi-v2-referrals post /referrals/move_to_promoter","title":"Move referrals to promoter","href":"/api-reference-v2/api-admin/referrals/move-referrals-to-promoter"},{"openapi":"openapi-v2-referrals delete /referrals","title":"Delete referrals","href":"/api-reference-v2/api-admin/referrals/delete-referrals"}]},{"group":"Promoters","pages":[{"openapi":"openapi-v2-promoters get /promoters","title":"Get available promoters","href":"/api-reference-v2/api-admin/promoters/get-available-promoters"},{"openapi":"openapi-v2-promoters post /promoters","title":"Create promoter","href":"/api-reference-v2/api-admin/promoters/create-promoter"},{"openapi":"openapi-v2-promoters get /promoters/{id}","title":"Get promoter details","href":"/api-reference-v2/api-admin/promoters/get-promoter-details"},{"openapi":"openapi-v2-promoters put /promoters/{id}","title":"Update promoter","href":"/api-reference-v2/api-admin/promoters/update-promoter"},{"openapi":"openapi-v2-promoters get /promoters/{id}/referral_links","title":"Get promoter referral links","href":"/api-reference-v2/api-admin/promoters/get-promoter-referral-links"},{"openapi":"openapi-v2-promoters get /promoters/{id}/chart_data","title":"Get data used for chart","href":"/api-reference-v2/api-admin/promoters/get-data-used-for-chart"},{"openapi":"openapi-v2-promoters get /promoters/{id}/overview_report","title":"Get reports for promoter overview","href":"/api-reference-v2/api-admin/promoters/get-reports-for-promoter-overview"},{"openapi":"openapi-v2-promoters get /promoters/{id}/traffic_sources_report","title":"Get reports for promoter traffic sources","href":"/api-reference-v2/api-admin/promoters/get-reports-for-promoter-traffic-sources"},{"openapi":"openapi-v2-promoters get /promoters/{id}/urls_report","title":"Get reports for promoter URLs","href":"/api-reference-v2/api-admin/promoters/get-reports-for-promoter-urls"},{"openapi":"openapi-v2-promoters post /promoters/assign_parent","title":"Assign a parent promoter","href":"/api-reference-v2/api-admin/promoters/assign-parent-promoter"},{"openapi":"openapi-v2-promoters post /promoters/add_to_campaign","title":"Add promoters to campaign","href":"/api-reference-v2/api-admin/promoters/add-promoter-to-campaign"},{"openapi":"openapi-v2-promoters post /promoters/move_to_campaign","title":"Move promoters to campaign","href":"/api-reference-v2/api-admin/promoters/move-promoter-to-campaign"},{"openapi":"openapi-v2-promoters post /promoters/accept","title":"Accept promoters","href":"/api-reference-v2/api-admin/promoters/accept-promoters"},{"openapi":"openapi-v2-promoters post /promoters/reject","title":"Reject promoters","href":"/api-reference-v2/api-admin/promoters/reject-promoters"},{"openapi":"openapi-v2-promoters post /promoters/block","title":"Block promoters","href":"/api-reference-v2/api-admin/promoters/block-promoters"},{"openapi":"openapi-v2-promoters post /promoters/archive","title":"Archive promoters","href":"/api-reference-v2/api-admin/promoters/archive-promoters"},{"openapi":"openapi-v2-promoters post /promoters/restore","title":"Restore promoters","href":"/api-reference-v2/api-admin/promoters/restore-unarchived-promoters"}]},{"group":"Promoter Campaigns","pages":[{"openapi":"openapi-v2-promoter-campaigns get /promoter_campaigns","title":"Get available promoter campaigns","href":"/api-reference-v2/api-admin/promoter-campaigns/get-available-promoter-campaigns"},{"openapi":"openapi-v2-promoter-campaigns put /promoter_campaigns/{id}","title":"Update promoter campaign","href":"/api-reference-v2/api-admin/promoter-campaigns/update-promoter-campaign"}]},{"group":"Commissions","pages":[{"openapi":"openapi-v2-commissions get /commissions","title":"Get all commissions","description":"With this endpoint you can list all rewards and commissions assigned to a promotion, promoter, campaign or entire account using the API. \n \u003cTip>**HTTP Request** \u003cbr/>`GET https://api.firstpromoter.com/api/v2/company/commissions`\u003c/Tip>","href":"/api-reference-v2/api-admin/commissions/get-all-commissions"},{"openapi":"openapi-v2-commissions post /commissions","title":"Create a commission","href":"/api-reference-v2/api-admin/commissions/create-a-commission"},{"openapi":"openapi-v2-commissions put /commissions/{id}","title":"Update a commission","description":"With this endpoint you can update a commission. \n \u003cTip>**HTTP Request** \u003cbr/>`PUT https://api.firstpromoter.com/api/v2/company/commissions/{id}`\u003c/Tip>","href":"/api-reference-v2/api-admin/commissions/update-a-commission"},{"openapi":"openapi-v2-commissions post /commissions/approve","title":"Approve commissions","href":"/api-reference-v2/api-admin/commissions/approve-commissions"},{"openapi":"openapi-v2-commissions post /commissions/deny","title":"Deny commissions","href":"/api-reference-v2/api-admin/commissions/deny-commissions"},{"openapi":"openapi-v2-commissions post /commissions/mark_fulfilled","title":"Mark nonmonetary commissions as fulfilled","href":"/api-reference-v2/api-admin/commissions/mark-nonmonetary-commissions-as-fulfilled"},{"openapi":"openapi-v2-commissions post /commissions/mark_unfulfilled","title":"Mark nonmonetary commissions as unfulfilled","href":"/api-reference-v2/api-admin/commissions/mark-nonmonetary-commissions-as-unfulfilled"}]},{"group":"Promo Codes","pages":[{"openapi":"openapi-v2-promocodes get /promo_codes","title":"Get promo codes","href":"/api-reference-v2/api-admin/promo-codes/get-promo-codes"},{"openapi":"openapi-v2-promocodes get /promo_codes/{id}","title":"Get promo code by id","href":"/api-reference-v2/api-admin/promo-codes/get-promo-code-by-id"},{"openapi":"openapi-v2-promocodes post /promo_codes","title":"Create promo code (Stripe Only)","href":"/api-reference-v2/api-admin/promo-codes/create-promo-code"},{"openapi":"openapi-v2-promocodes put /promo_codes/{id}","title":"Update promo code by id","href":"/api-reference-v2/api-admin/promo-codes/update-promo-code-by-id"},{"openapi":"openapi-v2-promocodes delete /promo_codes/{id}","title":"Archive promo code by id","href":"/api-reference-v2/api-admin/promo-codes/archive-promo-code-by-id"}]},{"group":"Payouts","pages":[{"openapi":"openapi-v2-payouts get /payouts","title":"Get all payouts","href":"/api-reference-v2/api-admin/payouts/get-all-payouts"},{"openapi":"openapi-v2-payouts get /payouts/stats","title":"Get payout stats","href":"/api-reference-v2/api-admin/payouts/get-payout-stats"},{"openapi":"openapi-v2-payouts get /payouts/due_stats","title":"Get due payout stats","href":"/api-reference-v2/api-admin/payouts/get-due-payout-stats"},{"openapi":"openapi-v2-payouts get /payouts/group_by_promoters","title":"Get all payouts grouped by promoters","href":"/api-reference-v2/api-admin/payouts/get-all-payouts-grouped-by-promoters"}]},{"group":"Reports","pages":[{"openapi":"openapi-v2-reports get /reports/campaigns","title":"Get reports for campaigns","href":"/api-reference-v2/api-admin/reports/get-reports-for-campaigns"},{"openapi":"openapi-v2-reports get /reports/overview","title":"Get reports for overview","href":"/api-reference-v2/api-admin/reports/get-reports-for-overview"},{"openapi":"openapi-v2-reports get /reports/promoters","title":"Get reports for promoters","href":"/api-reference-v2/api-admin/reports/get-reports-for-promoters"},{"openapi":"openapi-v2-reports get /reports/urls","title":"Get reports for URLs","href":"/api-reference-v2/api-admin/reports/get-reports-for-urls"},{"openapi":"openapi-v2-reports get /reports/traffic_sources","title":"Get reports for traffic sources","href":"/api-reference-v2/api-admin/reports/get-reports-for-traffic-sources"}]}]},{"tab":"Affiliate API Reference","hidden":true,"pages":[{"title":"Affiliate API Reference","href":"/api-reference-v2/api-affiliate/introduction"}]},{"tab":"Advanced API Reference","hidden":true,"pages":[{"title":"Advanced API Reference","href":"/api-reference-v2/api-advanced/introduction"}]}]},{"anchor":"API Reference","icon":"webhook","href":"https://docs.firstpromoter.com/api-reference-v2/api-admin/introduction"},{"anchor":"Help Center","icon":"square-question","href":"https://help.firstpromoter.com/en/"}]},{"version":"v1","pages":[{"title":"v1","href":"/introduction"}]}]},"basePath":"","title":"Create a commission - 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"]}