There are two ways to manage your users: the Label Dashboard and the API. In the future we’ll expand this API to also manage your brands, but as of today its primary functionality is for managing your users.
All API endpoints are authenticated using an API key passed in the X-API-Key header. This agency api key can be found in the profile tab of the white label admin’s account.
X-API-Key: your-ageny-api-key
Do not mistake this for the Brand API Key from the Brand Context.
{"docsConfig":{"$schema":"https://mintlify.com/docs.json","theme":"mint","name":"Starter Kits","colors":{"primary":"#630dff","light":"#9962fc","dark":"#630dff"},"favicon":"logo/brandblast_square_logo.svg","logo":{"light":"https://mintcdn.com/brandblastinc/fcvki2wL7a2-MFh5/logo/brandblast_api_logo_dark.svg?fit=max\u0026auto=format\u0026n=fcvki2wL7a2-MFh5\u0026q=85\u0026s=3a48cf44d6199a823ab2a4dc81eed42a","dark":"https://mintcdn.com/brandblastinc/fcvki2wL7a2-MFh5/logo/brandblast_api_logo_light.svg?fit=max\u0026auto=format\u0026n=fcvki2wL7a2-MFh5\u0026q=85\u0026s=ff83c0391a8f314ed6a677311ad8939c"},"navbar":{"links":[{"label":"Support","href":"mailto:info@brandblast.ai"}],"primary":{"type":"button","label":"Dashboard","href":"https://dashboard.brandblast.ai"}},"footer":{"socials":{"x":"https://x.com/brandblastai"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"brandblastinc","hasAudioNarration":false,"actualSubdomain":"brandblastinc","customDomains":["docs.brandblast.ai"],"gitSource":{"type":"github","owner":"ianscott313","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a20c5c89ed471492517ec24","collectionId":"d0c5f3f9-a1f5-435e-8d15-e994da58a175","schemaVersion":"v2"},"entitlements":{},"buildId":"6a20c5c89ed471492517ec24:success","clientVersion":"0.0.3964","searchFilterCounts":[{"language":"default","tag":"Endpoint Examples","count":3},{"language":"default","tag":"API Reference","count":1}]},"assistantConfig":{},"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":"editor-v7-file-tree","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":"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":"pause-universal-search-reconcile","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":"per-site-search-delta","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":"editor-private-page-search","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":"editor-nav-generations","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":"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":"byok-sep-25","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":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","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}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/introduction","slug":"/api-reference/introduction","pageMetadata":{"title":"Introduction","description":"Manage your white label via API","href":"/api-reference/introduction","hidden":false},"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: \"Manage your white label via API\"\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={a:`a`,code:`code`,p:`p`,pre:`pre`,span:`span`,..._provideComponents(),...props.components},{CodeBlock,Heading,Note,Warning}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(Note,{children:_jsx(_components.p,{children:`If you’re not a white label, this documentation does not apply to you. All API endpoints require an Agency-level API Key`})}),`\n`,_jsx(Heading,{level:`2`,id:`welcome`,children:`Welcome`}),`\n`,_jsxs(_components.p,{children:[`There are two ways to manage your users: `,_jsx(_components.a,{href:`https://dashboard.brandblast.ai`,children:`the Label Dashboard`}),` and `,_jsx(_components.a,{href:`https://docs.brandblast.ai`,children:`the API`}),`. In the future we’ll expand this API to also manage your brands, but as of today its primary functionality is for managing your users.`]}),`\n`,_jsx(Heading,{level:`2`,id:`authentication`,children:`Authentication`}),`\n`,_jsx(_components.p,{children:`All API endpoints are authenticated using an API key passed in the X-API-Key header. This agency api key can be found in the profile tab of the white label admin’s account.`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`1`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`X-API-Key: your-ageny-api-key`})}),`\n`]})})}),`\n`,_jsx(Warning,{children:_jsx(_components.p,{children:`Do not mistake this for the Brand API Key from the Brand Context.`})})]})}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":{"config":{},"pageMetadata":{"title":"Introduction","description":"Manage your white label via API","href":"/api-reference/introduction","hidden":false}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Welcome","slug":"welcome","depth":2,"children":[]},{"title":"Authentication","slug":"authentication","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"brandblastinc","siteName":"Starter Kits","title":"Introduction - Starter Kits","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-01-07T03:55:46.423Z","originalFileLocation":"api-reference/introduction.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=\"Manage your white label via API\">\u003cmeta data-mint-head name=\"application-name\" content=\"Starter Kits\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/brandblastinc/jeDgc34Opse_5IB_/_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/brandblastinc/jeDgc34Opse_5IB_/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/brandblastinc/jeDgc34Opse_5IB_/_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/brandblastinc/jeDgc34Opse_5IB_/_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/brandblastinc/jeDgc34Opse_5IB_/_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/brandblastinc/jeDgc34Opse_5IB_/_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/brandblastinc/jeDgc34Opse_5IB_/_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/brandblastinc/jeDgc34Opse_5IB_/_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/brandblastinc/jeDgc34Opse_5IB_/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Introduction - Starter Kits\">\u003cmeta data-mint-head property=\"og:description\" content=\"Manage your white label via API\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Starter Kits\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.brandblast.ai/api-reference/introduction\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://brandblastinc.mintlify.app/_mintlify/api/og/v2?division=API+Reference\u0026amp;title=Introduction\u0026amp;description=Manage+your+white+label+via+API\u0026amp;theme=32c04783c478d03a74bef363\u0026amp;signature=92c6271117c7d254dabac2f659cd6ef40d2481d5e489bfdb0953bc0a337bf171\">\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=\"Introduction - Starter Kits\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Manage your white label via API\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://brandblastinc.mintlify.app/_mintlify/api/og/v2?division=API+Reference\u0026amp;title=Introduction\u0026amp;description=Manage+your+white+label+via+API\u0026amp;theme=32c04783c478d03a74bef363\u0026amp;signature=92c6271117c7d254dabac2f659cd6ef40d2481d5e489bfdb0953bc0a337bf171\">\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/brandblastinc/jeDgc34Opse_5IB_/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Starter Kits\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#630dff\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.brandblast.ai/api-reference/introduction\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/introduction.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.brandblast.ai/#organization\",\"name\":\"Starter Kits\",\"url\":\"https://docs.brandblast.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/brandblastinc/fcvki2wL7a2-MFh5/logo/brandblast_api_logo_dark.svg?fit=max\u0026auto=format\u0026n=fcvki2wL7a2-MFh5\u0026q=85\u0026s=3a48cf44d6199a823ab2a4dc81eed42a\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.brandblast.ai#website\",\"name\":\"Starter Kits\",\"url\":\"https://docs.brandblast.ai\",\"publisher\":{\"@id\":\"https://docs.brandblast.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.brandblast.ai/api-reference/introduction#webpage\",\"url\":\"https://docs.brandblast.ai/api-reference/introduction\",\"name\":\"Introduction\",\"description\":\"Manage your white label via API\",\"dateModified\":\"2026-01-07T03:55:46.423Z\",\"isPartOf\":{\"@id\":\"https://docs.brandblast.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.brandblast.ai/api-reference/introduction#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.brandblast.ai/api-reference/introduction#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Starter Kits\",\"item\":\"https://docs.brandblast.ai\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Introduction\",\"item\":\"https://docs.brandblast.ai/api-reference/introduction\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.brandblast.ai/api-reference/introduction#article\",\"headline\":\"Introduction\",\"name\":\"Introduction\",\"description\":\"Manage your white label via API\",\"url\":\"https://docs.brandblast.ai/api-reference/introduction\",\"mainEntityOfPage\":{\"@id\":\"https://docs.brandblast.ai/api-reference/introduction#webpage\"},\"dateModified\":\"2026-01-07T03:55:46.423Z\",\"publisher\":{\"@id\":\"https://docs.brandblast.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.brandblast.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Starter Kits\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Starter Kits","nav":{"global":null,"groups":[{"group":"API Reference","pages":[{"title":"Introduction","href":"/api-reference/introduction"}]},{"group":"Endpoint Examples","pages":[{"title":"Create User","openapi":"post /v1/createUser","description":"Create a new user on your white label tool. This does not notify the new user in any way.","href":"/api-reference/endpoint/createUser"},{"title":"Delete User","openapi":"post /v1/deleteUser","href":"/api-reference/endpoint/deleteUser"},{"title":"Reset User Password","openapi":"post /v1/resetUserPassword","href":"/api-reference/endpoint/resetUserPassword"}]}]},"title":"Introduction - Starter Kits","buildId":"dpl_HcHmUS6i3UwswnTHJUEdcTtwfdTQ","deploymentId":"dpl_HcHmUS6i3UwswnTHJUEdcTtwfdTQ","dynamics":[],"chunks":[]}
