MailPigeon API uses token-based authentication. A token is generated for you when you create a
new project. You can find your token in the Code tab of your project.
Token generated have write permissions by default. This enables you to collect submissions. It is important that you keep this private so as not to allow people collect submissions to your project
{"docsConfig":{"$schema":"https://mintlify.com/docs.json","theme":"mint","name":"MailPigeon Docs","colors":{"primary":"#5451D4","light":"#AE87FF","dark":"#0D001D"},"favicon":"/favicon.png","logo":{"dark":"https://mintlify.s3-us-west-1.amazonaws.com/mailpigeon/logo/dark.svg","light":"https://mintlify.s3-us-west-1.amazonaws.com/mailpigeon/logo/light.svg"},"appearance":{"default":"dark","strict":null},"background":{"image":"https://mintlify.s3-us-west-1.amazonaws.com/mailpigeon/images/background.svg","decoration":null,"color":{"light":null,"dark":"#000000"}},"navbar":{"links":[{"label":"Support","href":"mailto:hi@mailpigeon.app"}],"primary":{"type":"button","label":"Try out Demo","href":"https://mailpigeon-front.vercel.app/"}},"footer":{"socials":{"twitter":"https://twitter.com/mailpigeonapp","github":"https://github.com/mailpigeonapp","producthunt":"https://www.producthunt.com/@sofua"}},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"mailpigeon","hasAudioNarration":false,"actualSubdomain":"mailpigeon","customDomains":["docs.mailpigeon.app"],"gitSource":{"type":"github","owner":"mailpigeonapp","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"entitlements":{},"buildId":"6ae91d29cd3faed8ded34770:success","clientVersion":"0.0.4102","searchFilterCounts":[{"language":"default","tag":"Documentation","count":13},{"language":"default","tag":"Overview","count":4},{"language":"default","tag":"Knowledge Base","count":4},{"language":"default","tag":"API Reference","count":2},{"language":"default","tag":"Features","count":2},{"language":"default","tag":"API Documentation","count":1},{"language":"default","tag":"Endpoints","count":1},{"language":"default","tag":"Getting Started","count":1},{"language":"default","tag":"SDK Reference","count":1}]},"assistantConfig":{},"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":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/authentication","slug":"/api-reference/authentication","pageMetadata":{"title":"Authentication","description":"MailPigeon API Authentication","icon":"key","href":"/api-reference/authentication"},"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: \"MailPigeon API Authentication\"\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`,pre:`pre`,span:`span`,strong:`strong`,..._provideComponents(),...props.components},{CodeBlock,Heading}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`2`,id:`authentication`,children:`Authentication`}),`\n`,_jsxs(_components.p,{children:[`MailPigeon API uses token-based authentication. A token is generated for you when you create a\nnew project. You can find your token in the `,_jsx(_components.strong,{children:`Code`}),` tab of your project.`]}),`\n`,_jsx(CodeBlock,{numberOfLines:`1`,language:`javascript`,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:`javascript`,children:_jsxs(_components.code,{language:`javascript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'Authorization'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'Bearer \u003cyour_api_token>'`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`3`,id:`permissions`,children:`Permissions`}),`\n`,_jsx(_components.p,{children:`Token generated have write permissions by default. This enables you to collect submissions. It is important that you keep this private so as not to allow people collect submissions to your project`})]})}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":"Authentication","description":"MailPigeon API Authentication","icon":"key","href":"/api-reference/authentication"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Authentication","slug":"authentication","depth":2,"children":[{"title":"Permissions","slug":"permissions","depth":3,"children":[]}]}],"codeExamples":{}},"jsLinks":[],"subdomain":"mailpigeon","siteName":"MailPigeon Docs","title":"Authentication - MailPigeon Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"originalFileLocation":"api-reference/authentication.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=\"dark\"}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=\"MailPigeon API Authentication\">\u003cmeta data-mint-head name=\"application-name\" content=\"MailPigeon Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/mailpigeon/_generated/favicon/apple-touch-icon.png?v=3\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/mailpigeon/_generated/favicon/favicon-32x32.png?v=3\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/mailpigeon/_generated/favicon/favicon-16x16.png?v=3\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/mailpigeon/_generated/favicon/favicon.ico?v=3\">\u003cmeta data-mint-head property=\"og:title\" content=\"Authentication - MailPigeon Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"MailPigeon API Authentication\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"MailPigeon Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.mailpigeon.app/api-reference/authentication\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://mailpigeon.mintlify.site/_mintlify/api/og/v2?division=API+Documentation\u0026amp;title=Authentication\u0026amp;description=MailPigeon+API+Authentication\u0026amp;theme=f84ac7c6cf740ddc6647606f\u0026amp;signature=5c3ecbf1cf6b4a96992e8e4cfda2814c677d3635f5edace3e1e4bebd9c0a88c6\">\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=\"Authentication - MailPigeon Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"MailPigeon API Authentication\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://mailpigeon.mintlify.site/_mintlify/api/og/v2?division=API+Documentation\u0026amp;title=Authentication\u0026amp;description=MailPigeon+API+Authentication\u0026amp;theme=f84ac7c6cf740ddc6647606f\u0026amp;signature=5c3ecbf1cf6b4a96992e8e4cfda2814c677d3635f5edace3e1e4bebd9c0a88c6\">\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=\"https://mintlify.s3.us-west-1.amazonaws.com/mailpigeon/_generated/favicon/browserconfig.xml?v=3\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"MailPigeon Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#5451D4\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.mailpigeon.app/api-reference/authentication\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/authentication.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.mailpigeon.app/#organization\",\"name\":\"MailPigeon Docs\",\"url\":\"https://docs.mailpigeon.app\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintlify.s3-us-west-1.amazonaws.com/mailpigeon/logo/light.svg\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.mailpigeon.app#website\",\"name\":\"MailPigeon Docs\",\"url\":\"https://docs.mailpigeon.app\",\"publisher\":{\"@id\":\"https://docs.mailpigeon.app/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.mailpigeon.app/api-reference/authentication#webpage\",\"url\":\"https://docs.mailpigeon.app/api-reference/authentication\",\"name\":\"Authentication\",\"description\":\"MailPigeon API Authentication\",\"isPartOf\":{\"@id\":\"https://docs.mailpigeon.app#website\"},\"breadcrumb\":{\"@id\":\"https://docs.mailpigeon.app/api-reference/authentication#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.mailpigeon.app/api-reference/authentication#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"MailPigeon Docs\",\"item\":\"https://docs.mailpigeon.app\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Authentication\",\"item\":\"https://docs.mailpigeon.app/api-reference/authentication\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.mailpigeon.app/api-reference/authentication#article\",\"headline\":\"Authentication\",\"name\":\"Authentication\",\"description\":\"MailPigeon API Authentication\",\"url\":\"https://docs.mailpigeon.app/api-reference/authentication\",\"mainEntityOfPage\":{\"@id\":\"https://docs.mailpigeon.app/api-reference/authentication#webpage\"},\"publisher\":{\"@id\":\"https://docs.mailpigeon.app/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.mailpigeon.app#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"MailPigeon Docs\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"MailPigeon Docs\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/authentication.md","siteName":"MailPigeon Docs","nav":{"global":null,"anchors":[{"anchor":"Documentation","icon":"book-open","tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/overview/contributing"}]},{"tab":"API Reference","groups":[{"group":"API Documentation","pages":[{"title":"Authentication","icon":"key","href":"/api-reference/authentication"}]},{"group":"Endpoints","pages":[{"title":"Submit","description":"This endpoint submits validates and saves your form submissions. Assuming you have a form set up with the fields - ```name```, ```email```, ```phone```, ```enquiry``` and ```message```, you would send a POST request to this endpoint with the following body ","api":"POST https://api.mailpigeon.app/api/v1/submit","href":"/api-reference/endpoint/submit"}]}]}]},{"anchor":"Documentation","icon":"book-open","pages":[{"title":"Documentation","href":"/introduction"}]},{"anchor":"Community","href":"https://discord.gg/7JqfvbJ4","icon":"discord"},{"anchor":"Knowledge Base","icon":"books","pages":[{"title":"Knowledge Base","href":"/knowledge-base/http"}]}]},"basePath":"","title":"Authentication - MailPigeon Docs","buildId":"dpl_596ePT575z4qnAFksq1biRW97aLY","deploymentId":"dpl_596ePT575z4qnAFksq1biRW97aLY","dynamics":[],"chunks":[]}
