API endpoints for customer referral programs. Track referring customers, referred sign-ups, and reward both parties.
The refer-a-friend API manages customer-to-customer referral programs. Unlike affiliate programs (partner → customer), refer-a-friend programs let your existing customers refer new customers and earn rewards.
Key differences from affiliate programs
Concept
Affiliate programs
Refer-a-friend programs
Referrer
Partner
Referring customer
New sign-up
Customer
Referred customer
Cookie name
partnero_partner
partnero_referral
Identifier field
partner.key
referring_customer.key
Transaction fields
partner + customer
customer + referred_customer
Available endpoints
Customers
Create, list, update, and manage referring and referred customers
Transactions
Track purchases from referred customers
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Partnero","colors":{"primary":"#134E4A","light":"#134E4A","dark":"#0D9488"},"logo":{"light":"https://mintcdn.com/partnero/gINf_F3u_8GmW16y/images/partnero-black.svg?fit=max\u0026auto=format\u0026n=gINf_F3u_8GmW16y\u0026q=85\u0026s=a61ae64c8a722513b3eb0564bc371392","dark":"https://mintcdn.com/partnero/7W6berVyUt7cGwZs/images/partnero-white.png?fit=max\u0026auto=format\u0026n=7W6berVyUt7cGwZs\u0026q=85\u0026s=ad0f2c11e5d97e1a44089c942b90c6af"},"favicon":"https://mintcdn.com/partnero/gINf_F3u_8GmW16y/images/partnero-symbol.svg?fit=max\u0026auto=format\u0026n=gINf_F3u_8GmW16y\u0026q=85\u0026s=15596439022c16abf73457f39e239e85","api":{},"navbar":{"links":[{"href":"mailto:[email protected]","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.partnero.com"}},"footer":{"socials":{}},"styling":{"codeblocks":"system","latex":true},"contextual":{"options":["copy","chatgpt","claude","cursor","vscode"],"display":"header"},"metadata":{"timestamp":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"partnero","hasAudioNarration":false,"actualSubdomain":"partnero","customDomains":["docs.partnero.com"],"gitSource":{"type":"github","owner":"partnero","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"agentFeedback":true,"thumbs":true},"entitlements":{},"buildId":"6aedc496e0f593fc3df2b346","clientVersion":"0.0.4167","searchFilterCounts":[{"language":"default","tag":"Knowledge Base","count":236},{"language":"default","tag":"API reference","count":73},{"language":"default","tag":"Guides","count":59},{"language":"default","tag":"Partner portal","count":41},{"language":"default","tag":"Documentation","count":30},{"language":"default","tag":"Newsletter referral","count":27},{"language":"default","tag":"Refer-a-Friend","count":21},{"language":"default","tag":"Getting started","count":19},{"language":"default","tag":"Partner management","count":19},{"language":"default","tag":"Payout management","count":17}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","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":"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":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/refer-a-friend/overview","slug":"/api-reference/refer-a-friend/overview","pageMetadata":{"title":"Refer-a-friend API overview","sidebarTitle":"Overview","description":"API endpoints for customer referral programs. Track referring customers, referred sign-ups, and reward both parties.","href":"/api-reference/refer-a-friend/overview"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"API endpoints for customer referral programs. Track referring customers, referred sign-ups, and reward both parties.\"\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,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{Card,CardGroup,Heading,Table}=_components;if(!Card)_missingMdxReference(`Card`,true);if(!CardGroup)_missingMdxReference(`CardGroup`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`The refer-a-friend API manages customer-to-customer referral programs. Unlike affiliate programs (partner → customer), refer-a-friend programs let your existing customers refer new customers and earn rewards.`}),`\n`,_jsx(Heading,{level:`2`,id:`key-differences-from-affiliate-programs`,children:`Key differences from affiliate programs`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Concept`}),_jsx(_components.th,{children:`Affiliate programs`}),_jsx(_components.th,{children:`Refer-a-friend programs`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Referrer`}),_jsx(_components.td,{children:`Partner`}),_jsx(_components.td,{children:`Referring customer`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`New sign-up`}),_jsx(_components.td,{children:`Customer`}),_jsx(_components.td,{children:`Referred customer`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Cookie name`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`partnero_partner`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`partnero_referral`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Identifier field`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`partner.key`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`referring_customer.key`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Transaction fields`}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`partner`}),` + `,_jsx(_components.code,{children:`customer`})]}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`customer`}),` + `,_jsx(_components.code,{children:`referred_customer`})]})]})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`available-endpoints`,children:`Available endpoints`}),`\n`,_jsxs(CardGroup,{cols:2,children:[_jsx(Card,{title:`Customers`,icon:`users`,href:`/api-reference/refer-a-friend/customers`,children:_jsx(_components.p,{children:`Create, list, update, and manage referring and referred customers`})}),_jsx(Card,{title:`Transactions`,icon:`receipt`,href:`/api-reference/refer-a-friend/transactions`,children:_jsx(_components.p,{children:`Track purchases from referred customers`})})]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"codeStyling":"system","config":{},"pageMetadata":{"title":"Refer-a-friend API overview","sidebarTitle":"Overview","description":"API endpoints for customer referral programs. Track referring customers, referred sign-ups, and reward both parties.","href":"/api-reference/refer-a-friend/overview"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Key differences from affiliate programs","slug":"key-differences-from-affiliate-programs","depth":2,"children":[]},{"title":"Available endpoints","slug":"available-endpoints","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"partnero","siteName":"Partnero","title":"Refer-a-friend API overview - Partnero","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-02-09T11:10:20.046Z","originalFileLocation":"api-reference/refer-a-friend/overview.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=\"API endpoints for customer referral programs. Track referring customers, referred sign-ups, and reward both parties.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Partnero\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/partnero/Sa9xWNFgYCZSChdd/_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/partnero/Sa9xWNFgYCZSChdd/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/partnero/Sa9xWNFgYCZSChdd/_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/partnero/Sa9xWNFgYCZSChdd/_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/partnero/Sa9xWNFgYCZSChdd/_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/partnero/Sa9xWNFgYCZSChdd/_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/partnero/Sa9xWNFgYCZSChdd/_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/partnero/Sa9xWNFgYCZSChdd/_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/partnero/Sa9xWNFgYCZSChdd/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Refer-a-friend API overview - Partnero\">\u003cmeta data-mint-head property=\"og:description\" content=\"API endpoints for customer referral programs. Track referring customers, referred sign-ups, and reward both parties.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Partnero\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.partnero.com/api-reference/refer-a-friend/overview\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://partnero.mintlify.site/_mintlify/api/og/v2?division=Refer-a-friend\u0026amp;title=Refer-a-friend+API+overview\u0026amp;description=API+endpoints+for+customer+referral+programs.+Track+referring+customers%2C+referred+sign-ups%2C+and+reward+both+parties.\u0026amp;theme=dd577e376cfcfab166ab7c93\u0026amp;signature=2debd8a1fa2c6cb6ed70bdd4543848baedab3ea9dc57d3262731be265b1c291c\">\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=\"Refer-a-friend API overview - Partnero\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"API endpoints for customer referral programs. Track referring customers, referred sign-ups, and reward both parties.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://partnero.mintlify.site/_mintlify/api/og/v2?division=Refer-a-friend\u0026amp;title=Refer-a-friend+API+overview\u0026amp;description=API+endpoints+for+customer+referral+programs.+Track+referring+customers%2C+referred+sign-ups%2C+and+reward+both+parties.\u0026amp;theme=dd577e376cfcfab166ab7c93\u0026amp;signature=2debd8a1fa2c6cb6ed70bdd4543848baedab3ea9dc57d3262731be265b1c291c\">\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/partnero/Sa9xWNFgYCZSChdd/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Partnero\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#134E4A\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.partnero.com/api-reference/refer-a-friend/overview\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/refer-a-friend/overview.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.partnero.com/#organization\",\"name\":\"Partnero\",\"url\":\"https://docs.partnero.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/partnero/gINf_F3u_8GmW16y/images/partnero-black.svg?fit=max\u0026auto=format\u0026n=gINf_F3u_8GmW16y\u0026q=85\u0026s=a61ae64c8a722513b3eb0564bc371392\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.partnero.com#website\",\"name\":\"Partnero\",\"url\":\"https://docs.partnero.com\",\"publisher\":{\"@id\":\"https://docs.partnero.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.partnero.com/api-reference/refer-a-friend/overview#webpage\",\"url\":\"https://docs.partnero.com/api-reference/refer-a-friend/overview\",\"name\":\"Refer-a-friend API overview\",\"description\":\"API endpoints for customer referral programs. Track referring customers, referred sign-ups, and reward both parties.\",\"dateModified\":\"2026-02-09T11:10:20.046Z\",\"isPartOf\":{\"@id\":\"https://docs.partnero.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.partnero.com/api-reference/refer-a-friend/overview#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.partnero.com/api-reference/refer-a-friend/overview#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Partnero\",\"item\":\"https://docs.partnero.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Refer-a-friend API overview\",\"item\":\"https://docs.partnero.com/api-reference/refer-a-friend/overview\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.partnero.com/api-reference/refer-a-friend/overview#article\",\"headline\":\"Refer-a-friend API overview\",\"name\":\"Refer-a-friend API overview\",\"description\":\"API endpoints for customer referral programs. Track referring customers, referred sign-ups, and reward both parties.\",\"url\":\"https://docs.partnero.com/api-reference/refer-a-friend/overview\",\"mainEntityOfPage\":{\"@id\":\"https://docs.partnero.com/api-reference/refer-a-friend/overview#webpage\"},\"dateModified\":\"2026-02-09T11:10:20.046Z\",\"publisher\":{\"@id\":\"https://docs.partnero.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.partnero.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Partnero\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Partnero\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/refer-a-friend/overview.md","siteName":"Partnero","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":""}]},{"tab":"Knowledge Base","pages":[{"title":"Knowledge Base","href":"/knowledge-base/overview"}]},{"tab":"Guides","pages":[{"title":"Guides","href":"/integrations/overview"}]},{"tab":"API reference","icon":"square-terminal","groups":[{"group":"Overview","pages":[{"title":"Partnero REST API reference","sidebarTitle":"Introduction","href":"/api-reference/introduction"},{"title":"API authentication","sidebarTitle":"Authentication","href":"/api-reference/authentication"}]},{"group":"Program","pages":[{"title":"Get program details","sidebarTitle":"Get","api":"GET /v1/program","href":"/api-reference/program/overview"},{"title":"Update program","sidebarTitle":"Update","api":"PUT /v1/program","href":"/api-reference/program/update"},{"title":"Delete program","sidebarTitle":"Delete","api":"DELETE /v1/program","href":"/api-reference/program/delete"}]},{"group":"Partners","pages":[{"title":"Partners API overview","sidebarTitle":"Overview","href":"/api-reference/partners/overview"},{"title":"List partners","sidebarTitle":"List","api":"GET /v1/partners","href":"/api-reference/partners/list"},{"title":"Get partner","sidebarTitle":"Get","api":"GET /v1/partners/{id}","href":"/api-reference/partners/get"},{"title":"Create partner","sidebarTitle":"Create","api":"POST /v1/partners","href":"/api-reference/partners/create"},{"title":"Update partner","sidebarTitle":"Update","api":"PUT /v1/partners/{id}","href":"/api-reference/partners/update"},{"title":"Delete partner","sidebarTitle":"Delete","api":"DELETE /v1/partners/{id}","href":"/api-reference/partners/delete"},{"title":"Archive partner","sidebarTitle":"Archive","api":"POST /v1/partners/{id}/archive","href":"/api-reference/partners/archive"},{"title":"Restore archived partner","sidebarTitle":"Restore","api":"POST /v1/partners/{id}/revoke-archive","href":"/api-reference/partners/restore"},{"title":"Approve partner","sidebarTitle":"Approve","api":"POST /v1/partners/{id}/approve","href":"/api-reference/partners/approve"},{"title":"Reject partner","sidebarTitle":"Reject","api":"POST /v1/partners/{id}/reject","href":"/api-reference/partners/reject"},{"title":"Create sign-in URL","sidebarTitle":"Sign-in URL","api":"POST /v1/partners/{id}/sign-in-url","href":"/api-reference/partners/sign-in-url"},{"title":"Add reward","sidebarTitle":"Add reward","api":"POST /v1/partners/{id}/reward","href":"/api-reference/partners/add-reward"}]},{"group":"Customers","pages":[{"title":"Customers API overview","sidebarTitle":"Overview","href":"/api-reference/customers/overview"},{"title":"List customers","sidebarTitle":"List","api":"GET /v1/customers","href":"/api-reference/customers/list"},{"title":"Get customer","sidebarTitle":"Get","api":"GET /v1/customers/{key}","href":"/api-reference/customers/get"},{"title":"Create customer","sidebarTitle":"Create","api":"POST /v1/customers","href":"/api-reference/customers/create"},{"title":"Update customer","sidebarTitle":"Update","api":"PUT /v1/customers/{key}","href":"/api-reference/customers/update"},{"title":"Delete customer","sidebarTitle":"Delete","api":"DELETE /v1/customers/{key}","href":"/api-reference/customers/delete"},{"title":"Suspend customer","sidebarTitle":"Suspend","api":"POST /v1/customers/{key}/suspend","href":"/api-reference/customers/suspend"},{"title":"Approve customer","sidebarTitle":"Approve","api":"POST /v1/customers/{key}/approve","href":"/api-reference/customers/approve"}]},{"group":"Transactions","pages":[{"title":"Transactions API overview","sidebarTitle":"Overview","href":"/api-reference/transactions/overview"},{"title":"List transactions","sidebarTitle":"List","api":"GET /v1/transactions","href":"/api-reference/transactions/list"},{"title":"Get transaction","sidebarTitle":"Get","api":"GET /v1/transactions/{key}","href":"/api-reference/transactions/get"},{"title":"Create transaction","sidebarTitle":"Create","api":"POST /v1/transactions","href":"/api-reference/transactions/create"},{"title":"Delete transaction","sidebarTitle":"Delete","api":"DELETE /v1/transactions/{key}","href":"/api-reference/transactions/delete"},{"title":"Archive transaction","sidebarTitle":"Archive","api":"POST /v1/transactions/{key}/archive","href":"/api-reference/transactions/archive"},{"title":"Restore archived transaction","sidebarTitle":"Restore","api":"POST /v1/transactions/{key}/revoke-archive","href":"/api-reference/transactions/restore"}]},{"group":"Payout requests","pages":[{"title":"Payout requests API overview","sidebarTitle":"Overview","href":"/api-reference/payout-requests/overview"},{"title":"List payout requests","sidebarTitle":"List","api":"GET /v1/payout_requests","href":"/api-reference/payout-requests/list"},{"title":"Get payout request","sidebarTitle":"Get","api":"GET /v1/payout_requests/{id}","href":"/api-reference/payout-requests/get"},{"title":"Create payout request","sidebarTitle":"Create","api":"POST /v1/payout_requests","href":"/api-reference/payout-requests/create"},{"title":"Approve payout request","sidebarTitle":"Approve","api":"POST /v1/payout_requests/{id}/approve","href":"/api-reference/payout-requests/approve"},{"title":"Mark payout request as paid","sidebarTitle":"Mark as paid","api":"POST /v1/payout_requests/{id}/mark_as_paid","href":"/api-reference/payout-requests/mark-as-paid"}]},{"group":"Leads","pages":[{"title":"Leads API overview","sidebarTitle":"Overview","href":"/api-reference/leads/overview"},{"title":"List leads","sidebarTitle":"List","api":"GET /v1/leads","href":"/api-reference/leads/list"},{"title":"Get lead","sidebarTitle":"Get","api":"GET /v1/leads/{id}","href":"/api-reference/leads/get"},{"title":"Create lead API","sidebarTitle":"Create","api":"POST /v1/leads","href":"/api-reference/leads/create"},{"title":"Convert lead","sidebarTitle":"Convert","api":"GET /v1/leads/convert","href":"/api-reference/leads/convert"},{"title":"Delete lead","sidebarTitle":"Delete","api":"DELETE /v1/leads/{id}","href":"/api-reference/leads/delete"}]},{"group":"Referral links","pages":[{"title":"Referral links API overview","sidebarTitle":"Overview","href":"/api-reference/referral-links/overview"},{"title":"List referral links","sidebarTitle":"List","api":"GET /v1/partners/{id}/referral_links","href":"/api-reference/referral-links/list"},{"title":"Get referral link","sidebarTitle":"Get","api":"GET /v1/partner_referral_links/{id}","href":"/api-reference/referral-links/get"},{"title":"Create referral link","sidebarTitle":"Create","api":"POST /v1/partner_referral_links","href":"/api-reference/referral-links/create"},{"title":"Update referral link","sidebarTitle":"Update","api":"PUT /v1/partner_referral_links/{id}","href":"/api-reference/referral-links/update"},{"title":"Delete referral link","sidebarTitle":"Delete","api":"DELETE /v1/partner_referral_links/{id}","href":"/api-reference/referral-links/delete"}]},{"group":"Coupons","pages":[{"title":"Coupons API overview","sidebarTitle":"Overview","href":"/api-reference/coupons/overview"},{"title":"List coupons","sidebarTitle":"List","api":"GET /v1/coupons","href":"/api-reference/coupons/list"},{"title":"Get coupon","sidebarTitle":"Get","api":"GET /v1/coupons/{uuid_code}","href":"/api-reference/coupons/get"},{"title":"Create coupon API","sidebarTitle":"Create","api":"POST /v1/coupons","href":"/api-reference/coupons/create"},{"title":"Update coupon","sidebarTitle":"Update","api":"PUT /v1/coupons","href":"/api-reference/coupons/update"},{"title":"Delete coupon","sidebarTitle":"Delete","api":"DELETE /v1/coupons/{uuid_code}","href":"/api-reference/coupons/delete"}]},{"group":"Promotion codes","pages":[{"title":"Promotion codes API overview","sidebarTitle":"Overview","href":"/api-reference/promotion-codes/overview"},{"title":"List promotion codes","sidebarTitle":"List","api":"GET /v1/promotion-codes","href":"/api-reference/promotion-codes/list"},{"title":"Get promotion code","sidebarTitle":"Get","api":"GET /v1/promotion-codes/{code}","href":"/api-reference/promotion-codes/get"},{"title":"Create promotion code","sidebarTitle":"Create","api":"POST /v1/promotion-codes","href":"/api-reference/promotion-codes/create"},{"title":"Update promotion code","sidebarTitle":"Update","api":"PUT /v1/promotion-codes","href":"/api-reference/promotion-codes/update"},{"title":"Delete promotion code","sidebarTitle":"Delete","api":"DELETE /v1/promotion-codes","href":"/api-reference/promotion-codes/delete"}]},{"group":"Webhooks","pages":[{"title":"Webhooks API overview","sidebarTitle":"Overview","href":"/api-reference/webhooks/overview"},{"title":"List webhooks","sidebarTitle":"List","api":"GET /v1/webhooks","href":"/api-reference/webhooks/list"},{"title":"Create webhook","sidebarTitle":"Create","api":"POST /v1/webhooks","href":"/api-reference/webhooks/create"},{"title":"Update webhook","sidebarTitle":"Update","api":"PUT /v1/webhooks/{key}","href":"/api-reference/webhooks/update"},{"title":"Delete webhook","sidebarTitle":"Delete","api":"DELETE /v1/webhooks/{key}","description":"Delete a webhook subscription","href":"/api-reference/webhooks/delete"}]},{"group":"Refer-a-friend","pages":[{"title":"Refer-a-friend API overview","sidebarTitle":"Overview","href":"/api-reference/refer-a-friend/overview"},{"title":"Referral customers","sidebarTitle":"Customers","api":"POST /v1/customers","description":"Create and manage customers in refer-a-friend programs","href":"/api-reference/refer-a-friend/customers"},{"title":"Referral transactions","sidebarTitle":"Transactions","api":"POST /v1/transactions","href":"/api-reference/refer-a-friend/transactions"}]},{"group":"Newsletter referral","pages":[{"title":"Newsletter referral overview","sidebarTitle":"Overview","href":"/api-reference/newsletter/overview"},{"title":"Newsletter subscribers","sidebarTitle":"Subscribers","api":"POST /v1/subscribers","href":"/api-reference/newsletter/subscribers"},{"title":"Newsletter program","sidebarTitle":"Program","api":"GET /v1/program","href":"/api-reference/newsletter/program"}]}]}]},"basePath":"","title":"Refer-a-friend API overview - Partnero","buildId":"dpl_9RFrWkXdFTJCytfx6jAofvAaEXr6","deploymentId":"dpl_9RFrWkXdFTJCytfx6jAofvAaEXr6","dynamics":[],"chunks":[]}