CINXE.COM

<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><link rel="preload" href="/api/fern-docs/search" as="fetch" crossorigin="anonymous"/><link rel="preload" href="/api/fern-docs/auth/api-key-injection" as="fetch" crossorigin="anonymous"/><meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no"/><title>Getting Started — beehiiv | Developer Documentation</title><meta name="robots" content="index,follow"/><meta name="description" content="beehiiv is the newsletter platform built for growth."/><meta name="theme-color" content="#ffffff"/><meta property="og:title" content="Getting Started — beehiiv | Developer Documentation"/><meta property="og:description" content="beehiiv is the newsletter platform built for growth."/><meta property="og:url" content="https://developers.beehiiv.com/welcome/getting-started"/><meta property="og:site_name" content="beehiiv | Developer Documentation"/><link rel="canonical" href="https://developers.beehiiv.com/welcome/getting-started"/><link rel="icon" href="https://fdr-prod-docs-files-public.s3.amazonaws.com/https://beehiiv.docs.buildwithfern.com/2024-11-19T22:24:11.626Z/assets/favicon.png" crossorigin="anonymous"/><link rel="preload" href="https://fdr-prod-docs-files-public.s3.amazonaws.com/https://beehiiv.docs.buildwithfern.com/2024-11-19T22:24:11.626Z/assets/fonts/Satoshi-Regular.woff2" as="font" type="font/woff2" crossorigin="anonymous"/><link rel="preload" href="https://fdr-prod-docs-files-public.s3.amazonaws.com/https://beehiiv.docs.buildwithfern.com/2024-11-19T22:24:11.626Z/assets/fonts/Satoshi-Medium.woff2" as="font" type="font/woff2" crossorigin="anonymous"/><link rel="preload" href="https://fdr-prod-docs-files-public.s3.amazonaws.com/https://beehiiv.docs.buildwithfern.com/2024-11-19T22:24:11.626Z/assets/fonts/MonaspaceNeon-Regular.woff2" as="font" type="font/woff2" crossorigin="anonymous"/><link rel="preload" href="https://fdr-prod-docs-files-public.s3.amazonaws.com/https://beehiiv.docs.buildwithfern.com/2024-11-19T22:24:11.626Z/assets/fonts/Satoshi-Bold.woff2" as="font" type="font/woff2" crossorigin="anonymous"/><script type="application/ld+json" id="jsonld-breadcrumb">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"beehiiv | Developer Documentation","item":"https://developers.beehiiv.com"},{"@type":"ListItem","position":2,"name":"Welcome","item":"https://developers.beehiiv.com/welcome"},{"@type":"ListItem","position":3,"name":"Getting Started","item":"https://developers.beehiiv.com/welcome/getting-started"}]}</script><link rel="preload" href="https://fdr-prod-docs-files-public.s3.amazonaws.com/https://beehiiv.docs.buildwithfern.com/2024-11-19T22:24:11.626Z/assets/logo-light-mode.svg" as="image" fetchpriority="high"/><link rel="preload" href="https://fdr-prod-docs-files-public.s3.amazonaws.com/https://beehiiv.docs.buildwithfern.com/2024-11-19T22:24:11.626Z/assets/logo-dark-mode.svg" as="image" fetchpriority="high"/><meta name="next-head-count" content="21"/><link href="https://cdn.jsdelivr.net/npm/katex@0.16.8/dist/katex.min.css" rel="stylesheet"/><script id="theme-script" data-nscript="beforeInteractive">(e=>{let t=document.documentElement;function r(e){t.classList.remove("light","dark"),t.classList.add(e),t.style.colorScheme=e}if(1===e.length)r(e[0]);else try{let t=localStorage.getItem("theme")??"system",n=e.length>0&&"system"===t?window.matchMedia("(prefers-color-scheme: dark)").matches?"dark":"light":t;r(n)}catch{}})(["light","dark"])</script><link rel="preload" href="https://app.buildwithfern.com/_next/static/css/1103334acde7ea9a.css?dpl=dpl_DkijRL5jksJiuHTh6qBbyJwCn7aP" as="style"/><link rel="stylesheet" href="https://app.buildwithfern.com/_next/static/css/1103334acde7ea9a.css?dpl=dpl_DkijRL5jksJiuHTh6qBbyJwCn7aP" data-n-g=""/><noscript data-n-css=""></noscript><script defer="" nomodule="" src="https://app.buildwithfern.com/_next/static/chunks/polyfills-78c92fac7aa8fdd8.js?dpl=dpl_DkijRL5jksJiuHTh6qBbyJwCn7aP"></script><script defer="" src="https://app.buildwithfern.com/_next/static/chunks/45bb0db8.463a392675fecfb0.js?dpl=dpl_DkijRL5jksJiuHTh6qBbyJwCn7aP"></script><script defer="" src="https://app.buildwithfern.com/_next/static/chunks/92e66809.393f81705c519a34.js?dpl=dpl_DkijRL5jksJiuHTh6qBbyJwCn7aP"></script><script defer="" src="https://app.buildwithfern.com/_next/static/chunks/5c43899a.2673b772923f6203.js?dpl=dpl_DkijRL5jksJiuHTh6qBbyJwCn7aP"></script><script defer="" src="https://app.buildwithfern.com/_next/static/chunks/a9a52c4b.5695eaf1729d3df7.js?dpl=dpl_DkijRL5jksJiuHTh6qBbyJwCn7aP"></script><script defer="" src="https://app.buildwithfern.com/_next/static/chunks/4109.7da31d9a7bac1166.js?dpl=dpl_DkijRL5jksJiuHTh6qBbyJwCn7aP"></script><script defer="" src="https://app.buildwithfern.com/_next/static/chunks/503.4b4794aa221dcd82.js?dpl=dpl_DkijRL5jksJiuHTh6qBbyJwCn7aP"></script><script defer="" src="https://app.buildwithfern.com/_next/static/chunks/3447.6f9ab57044baea4b.js?dpl=dpl_DkijRL5jksJiuHTh6qBbyJwCn7aP"></script><script defer="" src="https://app.buildwithfern.com/_next/static/chunks/4755.1ec06dab54756d22.js?dpl=dpl_DkijRL5jksJiuHTh6qBbyJwCn7aP"></script><script defer="" src="https://app.buildwithfern.com/_next/static/chunks/f136264b.fe05aaa57e22d479.js?dpl=dpl_DkijRL5jksJiuHTh6qBbyJwCn7aP"></script><script defer="" src="https://app.buildwithfern.com/_next/static/chunks/9545.8f3bda0401752b8f.js?dpl=dpl_DkijRL5jksJiuHTh6qBbyJwCn7aP"></script><script defer="" src="https://app.buildwithfern.com/_next/static/chunks/3585.1d5e8c9bce458c76.js?dpl=dpl_DkijRL5jksJiuHTh6qBbyJwCn7aP"></script><script defer="" src="https://app.buildwithfern.com/_next/static/chunks/5021.5c019027db7f9be7.js?dpl=dpl_DkijRL5jksJiuHTh6qBbyJwCn7aP"></script><script defer="" src="https://app.buildwithfern.com/_next/static/chunks/8030.d2a30a3f9e74f7ab.js?dpl=dpl_DkijRL5jksJiuHTh6qBbyJwCn7aP"></script><script defer="" src="https://app.buildwithfern.com/_next/static/chunks/4708.6160ea73dd823d24.js?dpl=dpl_DkijRL5jksJiuHTh6qBbyJwCn7aP"></script><script defer="" src="https://app.buildwithfern.com/_next/static/chunks/1273.0aac8c2e1444461a.js?dpl=dpl_DkijRL5jksJiuHTh6qBbyJwCn7aP"></script><script defer="" src="https://app.buildwithfern.com/_next/static/chunks/8560.ccbf0d64c7276f3f.js?dpl=dpl_DkijRL5jksJiuHTh6qBbyJwCn7aP"></script><script defer="" src="https://app.buildwithfern.com/_next/static/chunks/7650.29c4fb4b225b0096.js?dpl=dpl_DkijRL5jksJiuHTh6qBbyJwCn7aP"></script><script defer="" src="https://app.buildwithfern.com/_next/static/chunks/2997.259172a65cb90e82.js?dpl=dpl_DkijRL5jksJiuHTh6qBbyJwCn7aP"></script><script defer="" src="https://app.buildwithfern.com/_next/static/chunks/a20b1002.4488a96695dd3fd2.js?dpl=dpl_DkijRL5jksJiuHTh6qBbyJwCn7aP"></script><script defer="" src="https://app.buildwithfern.com/_next/static/chunks/6948.91b74062c3dcc640.js?dpl=dpl_DkijRL5jksJiuHTh6qBbyJwCn7aP"></script><script defer="" src="https://app.buildwithfern.com/_next/static/chunks/2704.006c3369c123bf07.js?dpl=dpl_DkijRL5jksJiuHTh6qBbyJwCn7aP"></script><script defer="" src="https://app.buildwithfern.com/_next/static/chunks/8470.1318fee5dd5c1610.js?dpl=dpl_DkijRL5jksJiuHTh6qBbyJwCn7aP"></script><script defer="" src="https://app.buildwithfern.com/_next/static/chunks/797.5a7a23f823a3a934.js?dpl=dpl_DkijRL5jksJiuHTh6qBbyJwCn7aP"></script><script defer="" src="https://app.buildwithfern.com/_next/static/chunks/8762.0d84b4c110483ab3.js?dpl=dpl_DkijRL5jksJiuHTh6qBbyJwCn7aP"></script><script defer="" src="https://app.buildwithfern.com/_next/static/chunks/3188.36c65f7462ee14ce.js?dpl=dpl_DkijRL5jksJiuHTh6qBbyJwCn7aP"></script><script defer="" src="https://app.buildwithfern.com/_next/static/chunks/9914.0e3331ef4c2dc27e.js?dpl=dpl_DkijRL5jksJiuHTh6qBbyJwCn7aP"></script><script defer="" src="https://app.buildwithfern.com/_next/static/chunks/652.753edf6e65e2a996.js?dpl=dpl_DkijRL5jksJiuHTh6qBbyJwCn7aP"></script><script defer="" src="https://app.buildwithfern.com/_next/static/chunks/5644.cca9e7a3e3aa01f0.js?dpl=dpl_DkijRL5jksJiuHTh6qBbyJwCn7aP"></script><script defer="" src="https://app.buildwithfern.com/_next/static/chunks/2645.367bd4807c496a87.js?dpl=dpl_DkijRL5jksJiuHTh6qBbyJwCn7aP"></script><script defer="" src="https://app.buildwithfern.com/_next/static/chunks/712.ec81e391df3ec295.js?dpl=dpl_DkijRL5jksJiuHTh6qBbyJwCn7aP"></script><script defer="" src="https://app.buildwithfern.com/_next/static/chunks/5632.3fdbfab268970093.js?dpl=dpl_DkijRL5jksJiuHTh6qBbyJwCn7aP"></script><script src="https://app.buildwithfern.com/_next/static/chunks/webpack-448659aa799147b9.js?dpl=dpl_DkijRL5jksJiuHTh6qBbyJwCn7aP" defer=""></script><script src="https://app.buildwithfern.com/_next/static/chunks/framework-3e09921de8f407d1.js?dpl=dpl_DkijRL5jksJiuHTh6qBbyJwCn7aP" defer=""></script><script src="https://app.buildwithfern.com/_next/static/chunks/main-ccb45e2ab6be065f.js?dpl=dpl_DkijRL5jksJiuHTh6qBbyJwCn7aP" defer=""></script><script src="https://app.buildwithfern.com/_next/static/chunks/pages/_app-9675a950e1ac202f.js?dpl=dpl_DkijRL5jksJiuHTh6qBbyJwCn7aP" defer=""></script><script src="https://app.buildwithfern.com/_next/static/chunks/7492-19adca7aa4dcec74.js?dpl=dpl_DkijRL5jksJiuHTh6qBbyJwCn7aP" defer=""></script><script src="https://app.buildwithfern.com/_next/static/chunks/2954-4ce274c25ff8d11b.js?dpl=dpl_DkijRL5jksJiuHTh6qBbyJwCn7aP" defer=""></script><script src="https://app.buildwithfern.com/_next/static/chunks/9839-deec862238bb93ab.js?dpl=dpl_DkijRL5jksJiuHTh6qBbyJwCn7aP" defer=""></script><script src="https://app.buildwithfern.com/_next/static/chunks/5706-622f90476bb6a806.js?dpl=dpl_DkijRL5jksJiuHTh6qBbyJwCn7aP" defer=""></script><script src="https://app.buildwithfern.com/_next/static/chunks/pages/static/%5Bdomain%5D/%5B%5B...slug%5D%5D-8cea23ca5eb85aa9.js?dpl=dpl_DkijRL5jksJiuHTh6qBbyJwCn7aP" defer=""></script><script src="https://app.buildwithfern.com/_next/static/IMGUkSREhQWPdfVC54F72/_buildManifest.js?dpl=dpl_DkijRL5jksJiuHTh6qBbyJwCn7aP" defer=""></script><script src="https://app.buildwithfern.com/_next/static/IMGUkSREhQWPdfVC54F72/_ssgManifest.js?dpl=dpl_DkijRL5jksJiuHTh6qBbyJwCn7aP" defer=""></script><style id="__jsx-2541007312"> :root { --typography-body-font-family: 'Satoshi', -apple-system,BlinkMacSystemFont,Segoe UI,Roboto,Oxygen,Ubuntu,Cantarell,Open Sans,Helvetica Neue,sans-serif; --typography-heading-font-family: 'Satoshi', -apple-system,BlinkMacSystemFont,Segoe UI,Roboto,Oxygen,Ubuntu,Cantarell,Open Sans,Helvetica Neue,sans-serif; --typography-code-font-family: 'Monospace Neon', ui-monospace,SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,monospace; --spacing-page-width: 88rem; --spacing-content-width: 40rem; --spacing-content-wide-width: 60.5rem; --spacing-sidebar-width: 18rem; --spacing-header-height: 4rem; --spacing-header-height-padded: 5rem; --spacing-header-height-real: 4rem; --grayscale-1: var(--mauve-1); --grayscale-2: var(--mauve-2); --grayscale-3: var(--mauve-3); --grayscale-4: var(--mauve-4); --grayscale-5: var(--mauve-5); --grayscale-6: var(--mauve-6); --grayscale-7: var(--mauve-7); --grayscale-8: var(--mauve-8); --grayscale-9: var(--mauve-9); --grayscale-10: var(--mauve-10); --grayscale-11: var(--mauve-11); --grayscale-12: var(--mauve-12); --grayscale-a1: var(--mauve-a1); --grayscale-a2: var(--mauve-a2); --grayscale-a3: var(--mauve-a3); --grayscale-a4: var(--mauve-a4); --grayscale-a5: var(--mauve-a5); --grayscale-a6: var(--mauve-a6); --grayscale-a7: var(--mauve-a7); --grayscale-a8: var(--mauve-a8); --grayscale-a9: var(--mauve-a9); --grayscale-a10: var(--mauve-a10); --grayscale-a11: var(--mauve-a11); --grayscale-a12: var(--mauve-a12); --accent-1: #fdfdff; --accent-2: #f7f9ff; --accent-3: #eef2ff; --accent-4: #e1e9ff; --accent-5: #d2deff; --accent-6: #c1d0ff; --accent-7: #abbdfd; --accent-8: #8da2f6; --accent-9: #3a43c8; --accent-10: #2f31b6; --accent-11: #4655ce; --accent-12: #212a63; --accent-a1: #0000ff02; --accent-a2: #0040ff08; --accent-a3: #003cff11; --accent-a4: #0044ff1e; --accent-a5: #0044ff2d; --accent-a6: #003eff3e; --accent-a7: #0037f954; --accent-a8: #002feb72; --accent-a9: #000cb8c5; --accent-a10: #0003a6d0; --accent-a11: #0015bcb9; --accent-a12: #000a4cde; --accent-surface: #f5f8ffcc; --gray-surface: #ffffffcc; --accent: 58, 67, 200; --accent-aa: 58, 67, 200; --accent-aaa: 58, 67, 200; --accent-tinted: 51, 59, 182; --background: 255, 255, 255; --accent-contrast: 255, 255, 255; --bg-color-card: rgba(255, 255, 255, 0.7); --sidebar-background: transparent; --header-background: rgb(255, 255, 255); --border: rgb(215, 217, 246); --border-concealed: rgb(215, 217, 246); --body-text: 0, 0, 0; --body-text-inverted: 255, 255, 255; } @media (max-width: 1024px) { :root { --spacing-header-height: 4rem; --spacing-header-height-padded: 5rem; } } :is(.dark) { --grayscale-1: var(--slate-1); --grayscale-2: var(--slate-2); --grayscale-3: var(--slate-3); --grayscale-4: var(--slate-4); --grayscale-5: var(--slate-5); --grayscale-6: var(--slate-6); --grayscale-7: var(--slate-7); --grayscale-8: var(--slate-8); --grayscale-9: var(--slate-9); --grayscale-10: var(--slate-10); --grayscale-11: var(--slate-11); --grayscale-12: var(--slate-12); --grayscale-a1: var(--slate-a1); --grayscale-a2: var(--slate-a2); --grayscale-a3: var(--slate-a3); --grayscale-a4: var(--slate-a4); --grayscale-a5: var(--slate-a5); --grayscale-a6: var(--slate-a6); --grayscale-a7: var(--slate-a7); --grayscale-a8: var(--slate-a8); --grayscale-a9: var(--slate-a9); --grayscale-a10: var(--slate-a10); --grayscale-a11: var(--slate-a11); --grayscale-a12: var(--slate-a12); --accent-1: #10101b; --accent-2: #161623; --accent-3: #232341; --accent-4: #2d2e4d; --accent-5: #383858; --accent-6: #424364; --accent-7: #505173; --accent-8: #606285; --accent-9: #d7d9f4; --accent-10: #cdcfea; --accent-11: #b0b3da; --accent-12: #dddffa; --accent-a1: #d9000005; --accent-a2: #f485a90b; --accent-a3: #9c81fd29; --accent-a4: #a598fc37; --accent-a5: #b4a5fe43; --accent-a6: #b6aefd51; --accent-a7: #bdb8fd62; --accent-a8: #c2c1fd76; --accent-a9: #e1e3fff3; --accent-a10: #e0e1fee8; --accent-a11: #cfd2fed6; --accent-a12: #e1e3fefa; --accent-surface: color(display-p3 0.1176 0.102 0.1569 / 0.5); --gray-surface: color(display-p3 0 0 0 / 5%); --accent: 215, 217, 244; --accent-aa: 215, 217, 244; --accent-aaa: 215, 217, 244; --accent-tinted: 235, 236, 249; --background: 12, 17, 29; --accent-contrast: 31, 31, 52; --bg-color-card: rgba(9, 13, 22, 0.5); --bg-color-card-solid: rgb(10, 15, 25); --sidebar-background: transparent; --header-background: rgb(12, 17, 29); --border: rgb(255, 255, 255); --border-concealed: rgb(255, 255, 255); --body-text: 255, 255, 255; --body-text-inverted: 0, 0, 0; } @font-face { font-family: 'Satoshi'; src: url('https://fdr-prod-docs-files-public.s3.amazonaws.com/https://beehiiv.docs.buildwithfern.com/2024-11-19T22:24:11.626Z/assets/fonts/Satoshi-Regular.woff2') format('woff2'); font-weight: 400; font-style: normal; font-display: swap; } @font-face { font-family: 'Satoshi'; src: url('https://fdr-prod-docs-files-public.s3.amazonaws.com/https://beehiiv.docs.buildwithfern.com/2024-11-19T22:24:11.626Z/assets/fonts/Satoshi-Medium.woff2') format('woff2'); font-weight: 500; font-style: normal; font-display: swap; } @font-face { font-family: 'Satoshi'; src: url('https://fdr-prod-docs-files-public.s3.amazonaws.com/https://beehiiv.docs.buildwithfern.com/2024-11-19T22:24:11.626Z/assets/fonts/Satoshi-Bold.woff2') format('woff2'); font-weight: 600; font-style: normal; font-display: swap; } @font-face { font-family: 'Monospace Neon'; src: url('https://fdr-prod-docs-files-public.s3.amazonaws.com/https://beehiiv.docs.buildwithfern.com/2024-11-19T22:24:11.626Z/assets/fonts/MonaspaceNeon-Regular.woff2') format('woff2'); font-weight: 400; font-style: normal; font-display: swap; } html { background-color: #ffffff; } html.dark { background-color: #0c111d; } .fern-button:not(.disabled).filled.primary:hover { background-color: #ff5ec4 !important; } .fern-button:not(.disabled).outlined.primary:hover { background-color: #ff5ec4 !important; color: white !important; } .fern-button:not(.disabled).outlined.primary:hover svg { color: white !important; } .text-green-400 { color: #00824d !important; } .fern-endpoint-content p { font-size: 16px !important; line-height: 2 !important; } .fern-sidebar-link-text { font-weight: 600 !important; } .fern-header-right-menu { font-weight: 600 !important; } </style><style id="__jsx-3067142618">:root{ --header-offset: 64px}@media(max-width:1024px){:root{--header-offset:64px}}</style></head><body class="antialiased"><div id="__next"><div class="fern-background dark:from-transparent"></div><div id="fern-docs" class="fern-container fern-theme-default"><header id="fern-header" role="banner"><div class="fern-header-container width-before-scroll-bar has-background-light has-background-dark" data-border="hide"><div class="clipped-background"><div class="h-screen opacity-60 dark:opacity-80 fern-background dark:from-transparent"></div></div><div class="fern-header"><nav aria-label="primary" class="fern-header-content mx-auto max-w-page-width"><div class="relative flex h-full min-w-fit flex-1 shrink-0 items-center gap-2 py-1"><div class="flex items-center gap-2"><a target="_blank" rel="noreferrer" href="https://www.beehiiv.com/"><div class="fern-logo-container"><img alt="beehiiv | Developer Documentation" fetchpriority="high" loading="eager" width="118.78281622911695" height="30" decoding="async" data-nimg="1" class="fern-logo-light" style="color:transparent;height:30px" src="https://fdr-prod-docs-files-public.s3.amazonaws.com/https://beehiiv.docs.buildwithfern.com/2024-11-19T22:24:11.626Z/assets/logo-light-mode.svg"/><img alt="beehiiv | Developer Documentation" fetchpriority="high" loading="eager" width="118.78281622911695" height="30" decoding="async" data-nimg="1" class="fern-logo-dark" style="color:transparent;height:30px" src="https://fdr-prod-docs-files-public.s3.amazonaws.com/https://beehiiv.docs.buildwithfern.com/2024-11-19T22:24:11.626Z/assets/logo-dark-mode.svg"/></div></a></div></div><div class="fern-header-right-menu"><div class="lg-menu"><span class="fern-button-group"><a tabindex="0" aria-disabled="false" data-state="off" class="group cursor-pointer fern-button minimal normal" href="https://developers.beehiiv.com/auth"><span class="fern-button-content"><span class="fern-button-text">Login</span></span></a><a tabindex="0" aria-disabled="false" data-state="off" class="group cursor-pointer fern-button filled normal primary" target="_blank" rel="noreferrer" href="https://www.beehiiv.com/pricing?"><span class="fern-button-content"><span class="fern-button-text">Start trial</span></span></a><a tabindex="0" aria-disabled="false" data-state="off" class="group cursor-pointer fern-button outlined normal primary" target="_blank" rel="noreferrer" href="https://www.beehiiv.com/demo/form?"><span class="fern-button-content"><span class="fern-button-text">Get a demo</span><svg width="1.5em" height="1.5em" viewBox="0 0 24 24" stroke-width="1.5" fill="none" xmlns="http://www.w3.org/2000/svg" color="currentColor" class="!size-icon transition-transform group-hover:translate-x-0.5"><path d="M3 12L21 12M21 12L12.5 3.5M21 12L12.5 20.5" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path></svg></span></a><button tabindex="0" data-state="closed" aria-disabled="false" title="toggle theme" type="button" aria-haspopup="dialog" aria-expanded="false" aria-controls="radix-:R9t4u6:" class="fern-theme-button fern-button minimal normal primary rounded square"><span class="fern-button-content"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="fern-theme-button-icon !size-icon max-lg:!size-icon-md"><circle cx="12" cy="12" r="5"></circle><line x1="12" y1="1" x2="12" y2="3"></line><line x1="12" y1="21" x2="12" y2="23"></line><line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line><line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line><line x1="1" y1="12" x2="3" y2="12"></line><line x1="21" y1="12" x2="23" y2="12"></line><line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line><line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line></svg></span></button></span></div><div class="max-lg-menu"><button tabindex="0" data-state="closed" aria-disabled="false" title="toggle theme" type="button" aria-haspopup="dialog" aria-expanded="false" aria-controls="radix-:Rat4u6:" class="fern-theme-button fern-button minimal large primary rounded square"><span class="fern-button-content"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="fern-theme-button-icon !size-icon max-lg:!size-icon-md"><circle cx="12" cy="12" r="5"></circle><line x1="12" y1="1" x2="12" y2="3"></line><line x1="12" y1="21" x2="12" y2="23"></line><line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line><line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line><line x1="1" y1="12" x2="3" y2="12"></line><line x1="21" y1="12" x2="23" y2="12"></line><line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line><line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line></svg></span></button><button tabindex="0" data-state="off" aria-disabled="false" class="fern-button minimal large rounded square"><span class="fern-button-content"><svg width="1.5em" height="1.5em" stroke-width="1.5" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" color="currentColor" class="!size-icon-md"><path d="M3 5H21" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path><path d="M3 12H21" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path><path d="M3 19H21" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path></svg></span></button></div></div></nav></div></div></header><style> .fern-sidebar-container { border-right-width: 0px; border-left-width: 0px; } :is(.dark) .fern-sidebar-container { border-right-width: 0px; border-left-width: 0px; } </style><div class="fern-body"><nav aria-label="secondary" class="fern-sidebar-container desktop"><div class="flex flex-col px-4 lg:pt-4" data-border="hide"><div class="fern-sidebar-searchbar-container"><button id="fern-search-button" class="fern-search-bar w-full" disabled=""><span class="search-placeholder"><svg width="1.5em" height="1.5em" viewBox="0 0 24 24" stroke-width="1.5" fill="none" xmlns="http://www.w3.org/2000/svg" color="currentColor" class="size-icon-md"><path d="M17 17L21 21" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path><path d="M3 11C3 15.4183 6.58172 19 11 19C13.213 19 15.2161 18.1015 16.6644 16.6493C18.1077 15.2022 19 13.2053 19 11C19 6.58172 15.4183 3 11 3C6.58172 3 3 6.58172 3 11Z" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path></svg><span>Search...</span></span><kbd class="keyboard-shortcut-hint">/</kbd></button></div></div><div dir="ltr" class="fern-scroll-area flex-1" style="position:relative;--radix-scroll-area-corner-width:0px;--radix-scroll-area-corner-height:0px"><style>[data-radix-scroll-area-viewport]{scrollbar-width:none;-ms-overflow-style:none;-webkit-overflow-scrolling:touch;}[data-radix-scroll-area-viewport]::-webkit-scrollbar{display:none}</style><div data-radix-scroll-area-viewport="" class="fern-scroll-area-viewport group/sidebar fern-sidebar-content" data-scrollbars="vertical" style="overflow-x:hidden;overflow-y:hidden"><div style="min-width:100%;display:table"><ul class="fern-sidebar-group"><li class="mt-6"><div class="fern-sidebar-heading"><span class="fern-sidebar-heading-content">Welcome</span></div><ul class="fern-sidebar-group"><li><div class="fern-sidebar-link-container" data-state="active"><a class="fern-sidebar-link" href="/welcome/getting-started"><span class="fern-sidebar-link-content"><span class="fern-sidebar-link-text">Getting Started</span></span></a></div></li><li><div class="fern-sidebar-link-container" data-state="inactive"><a class="fern-sidebar-link" href="/welcome/create-an-api-key"><span class="fern-sidebar-link-content"><span class="fern-sidebar-link-text">Create an API Key</span></span></a></div></li><li><div class="fern-sidebar-link-container" data-state="inactive"><a class="fern-sidebar-link" href="/welcome/no-code-integrations"><span class="fern-sidebar-link-content"><span class="fern-sidebar-link-text">No-Code Integrations</span></span></a></div></li></ul></li><li class="mt-6"><div class="fern-sidebar-link-container" data-state="inactive"><a class="font-semibold !text-text-default fern-sidebar-link" href="/webhooks"><span class="fern-sidebar-link-content"><span class="fern-sidebar-link-text">Webhooks</span></span></a></div><ul class="fern-sidebar-group"><li><div data-state="closed"><div class="fern-sidebar-link-container" data-state="inactive"><button class="fern-sidebar-link"><span class="fern-sidebar-link-content"><span class="fern-sidebar-link-text">Post</span></span><span class="fern-sidebar-link-expand opacity-50 transition-opacity group-hover:opacity-80" data-state="inactive"><svg width="1.5em" height="1.5em" stroke-width="1.5" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" color="currentColor" class="size-icon-md lg:size-icon -rotate-90"><path d="M6 9L12 15L18 9" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path></svg></span></button></div></div></li><li><div data-state="closed"><div class="fern-sidebar-link-container" data-state="inactive"><button class="fern-sidebar-link"><span class="fern-sidebar-link-content"><span class="fern-sidebar-link-text">Subscription</span></span><span class="fern-sidebar-link-expand opacity-50 transition-opacity group-hover:opacity-80" data-state="inactive"><svg width="1.5em" height="1.5em" stroke-width="1.5" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" color="currentColor" class="size-icon-md lg:size-icon -rotate-90"><path d="M6 9L12 15L18 9" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path></svg></span></button></div></div></li><li><div data-state="closed"><div class="fern-sidebar-link-container" data-state="inactive"><button class="fern-sidebar-link"><span class="fern-sidebar-link-content"><span class="fern-sidebar-link-text">Survey</span></span><span class="fern-sidebar-link-expand opacity-50 transition-opacity group-hover:opacity-80" data-state="inactive"><svg width="1.5em" height="1.5em" stroke-width="1.5" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" color="currentColor" class="size-icon-md lg:size-icon -rotate-90"><path d="M6 9L12 15L18 9" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path></svg></span></button></div></div></li></ul></li><li class="mt-6"><div class="fern-sidebar-heading"><span class="fern-sidebar-heading-content">API Reference</span></div><ul class="fern-sidebar-group"><li><div data-state="closed"><div class="fern-sidebar-link-container" data-state="inactive"><button class="fern-sidebar-link"><span class="fern-sidebar-link-content"><span class="fern-sidebar-link-text">Automation Journeys</span></span><span class="fern-sidebar-link-expand opacity-50 transition-opacity group-hover:opacity-80" data-state="inactive"><svg width="1.5em" height="1.5em" stroke-width="1.5" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" color="currentColor" class="size-icon-md lg:size-icon -rotate-90"><path d="M6 9L12 15L18 9" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path></svg></span></button></div></div></li><li><div data-state="closed"><div class="fern-sidebar-link-container" data-state="inactive"><button class="fern-sidebar-link"><span class="fern-sidebar-link-content"><span class="fern-sidebar-link-text">Automations</span></span><span class="fern-sidebar-link-expand opacity-50 transition-opacity group-hover:opacity-80" data-state="inactive"><svg width="1.5em" height="1.5em" stroke-width="1.5" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" color="currentColor" class="size-icon-md lg:size-icon -rotate-90"><path d="M6 9L12 15L18 9" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path></svg></span></button></div></div></li><li><div data-state="closed"><div class="fern-sidebar-link-container" data-state="inactive"><button class="fern-sidebar-link"><span class="fern-sidebar-link-content"><span class="fern-sidebar-link-text">Bulk Subscription Updates</span></span><span class="fern-sidebar-link-expand opacity-50 transition-opacity group-hover:opacity-80" data-state="inactive"><svg width="1.5em" height="1.5em" stroke-width="1.5" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" color="currentColor" class="size-icon-md lg:size-icon -rotate-90"><path d="M6 9L12 15L18 9" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path></svg></span></button></div></div></li><li><div data-state="closed"><div class="fern-sidebar-link-container" data-state="inactive"><button class="fern-sidebar-link"><span class="fern-sidebar-link-content"><span class="fern-sidebar-link-text">Custom Fields</span></span><span class="fern-sidebar-link-expand opacity-50 transition-opacity group-hover:opacity-80" data-state="inactive"><svg width="1.5em" height="1.5em" stroke-width="1.5" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" color="currentColor" class="size-icon-md lg:size-icon -rotate-90"><path d="M6 9L12 15L18 9" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path></svg></span></button></div></div></li><li><div data-state="closed"><div class="fern-sidebar-link-container" data-state="inactive"><button class="fern-sidebar-link"><span class="fern-sidebar-link-content"><span class="fern-sidebar-link-text">Posts</span></span><span class="fern-sidebar-link-expand opacity-50 transition-opacity group-hover:opacity-80" data-state="inactive"><svg width="1.5em" height="1.5em" stroke-width="1.5" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" color="currentColor" class="size-icon-md lg:size-icon -rotate-90"><path d="M6 9L12 15L18 9" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path></svg></span></button></div></div></li><li><div data-state="closed"><div class="fern-sidebar-link-container" data-state="inactive"><button class="fern-sidebar-link"><span class="fern-sidebar-link-content"><span class="fern-sidebar-link-text">Publications</span></span><span class="fern-sidebar-link-expand opacity-50 transition-opacity group-hover:opacity-80" data-state="inactive"><svg width="1.5em" height="1.5em" stroke-width="1.5" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" color="currentColor" class="size-icon-md lg:size-icon -rotate-90"><path d="M6 9L12 15L18 9" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path></svg></span></button></div></div></li><li><div data-state="closed"><div class="fern-sidebar-link-container" data-state="inactive"><button class="fern-sidebar-link"><span class="fern-sidebar-link-content"><span class="fern-sidebar-link-text">Referral Program</span></span><span class="fern-sidebar-link-expand opacity-50 transition-opacity group-hover:opacity-80" data-state="inactive"><svg width="1.5em" height="1.5em" stroke-width="1.5" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" color="currentColor" class="size-icon-md lg:size-icon -rotate-90"><path d="M6 9L12 15L18 9" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path></svg></span></button></div></div></li><li><div data-state="closed"><div class="fern-sidebar-link-container" data-state="inactive"><button class="fern-sidebar-link"><span class="fern-sidebar-link-content"><span class="fern-sidebar-link-text">Segments</span></span><span class="fern-sidebar-link-expand opacity-50 transition-opacity group-hover:opacity-80" data-state="inactive"><svg width="1.5em" height="1.5em" stroke-width="1.5" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" color="currentColor" class="size-icon-md lg:size-icon -rotate-90"><path d="M6 9L12 15L18 9" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path></svg></span></button></div></div></li><li><div data-state="closed"><div class="fern-sidebar-link-container" data-state="inactive"><button class="fern-sidebar-link"><span class="fern-sidebar-link-content"><span class="fern-sidebar-link-text">Subscriptions</span></span><span class="fern-sidebar-link-expand opacity-50 transition-opacity group-hover:opacity-80" data-state="inactive"><svg width="1.5em" height="1.5em" stroke-width="1.5" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" color="currentColor" class="size-icon-md lg:size-icon -rotate-90"><path d="M6 9L12 15L18 9" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path></svg></span></button></div></div></li><li><div data-state="closed"><div class="fern-sidebar-link-container" data-state="inactive"><button class="fern-sidebar-link"><span class="fern-sidebar-link-content"><span class="fern-sidebar-link-text">Subscription Tags</span></span><span class="fern-sidebar-link-expand opacity-50 transition-opacity group-hover:opacity-80" data-state="inactive"><svg width="1.5em" height="1.5em" stroke-width="1.5" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" color="currentColor" class="size-icon-md lg:size-icon -rotate-90"><path d="M6 9L12 15L18 9" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path></svg></span></button></div></div></li><li><div data-state="closed"><div class="fern-sidebar-link-container" data-state="inactive"><button class="fern-sidebar-link"><span class="fern-sidebar-link-content"><span class="fern-sidebar-link-text">Tiers</span></span><span class="fern-sidebar-link-expand opacity-50 transition-opacity group-hover:opacity-80" data-state="inactive"><svg width="1.5em" height="1.5em" stroke-width="1.5" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" color="currentColor" class="size-icon-md lg:size-icon -rotate-90"><path d="M6 9L12 15L18 9" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path></svg></span></button></div></div></li><li><div data-state="closed"><div class="fern-sidebar-link-container" data-state="inactive"><button class="fern-sidebar-link"><span class="fern-sidebar-link-content"><span class="fern-sidebar-link-text">Webhooks</span></span><span class="fern-sidebar-link-expand opacity-50 transition-opacity group-hover:opacity-80" data-state="inactive"><svg width="1.5em" height="1.5em" stroke-width="1.5" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" color="currentColor" class="size-icon-md lg:size-icon -rotate-90"><path d="M6 9L12 15L18 9" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path></svg></span></button></div></div></li></ul></li></ul><div class="border-concealed list-none -mx-4 border-t p-4 mt-4 lg:hidden"><a tabindex="0" aria-disabled="false" data-state="off" class="w-full fern-button minimal normal" href="https://developers.beehiiv.com/auth"><span class="fern-button-content"><span class="fern-button-text">Login</span></span></a><a tabindex="0" aria-disabled="false" data-state="off" class="w-full mt-2 fern-button filled normal primary" target="_blank" rel="noreferrer" href="https://www.beehiiv.com/pricing?"><span class="fern-button-content"><span class="fern-button-text">Start trial</span></span></a><a tabindex="0" aria-disabled="false" data-state="off" class="w-full mt-2 fern-button outlined normal primary" target="_blank" rel="noreferrer" href="https://www.beehiiv.com/demo/form?"><span class="fern-button-content"><span class="fern-button-text">Get a demo</span><svg width="1.5em" height="1.5em" viewBox="0 0 24 24" stroke-width="1.5" fill="none" xmlns="http://www.w3.org/2000/svg" color="currentColor" class="!size-icon"><path d="M3 12L21 12M21 12L12.5 3.5M21 12L12.5 20.5" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path></svg></span></a></div></div></div></div></nav><div class="fern-main"><main class="fern-guide-layout"><aside class="fern-layout-toc"></aside><article class="fern-layout-content max-w-content-width"><header class="mb-8"><div class="space-y-1"><div><span class="fern-breadcrumb"><a class="fern-breadcrumb-item" href="/welcome/getting-started">Welcome</a></span></div><h1 class="fern-page-heading"><p>Getting Started</p></h1></div><div class="mt-2 leading-7 prose-p:t-muted"><p>beehiiv is the newsletter platform built for <em>growth</em>.</p></div></header><div class="max-w-full prose dark:prose-invert prose-h1:mt-[1.5em] first:prose-h1:mt-0 break-words"><p>Harness beehiiv’s API to enrich your user records with custom fields from external forms, manage lists and segmentation programmatically, and integrate your beehiiv publication more closely with advertising platforms.</p> <div class="grid gap-4 sm:gap-6 my-6 first:mt-0 grid-cols-1 sm:grid-cols-2"><a class="fern-card interactive text-base border p-6 not-prose rounded-xl relative block" href="/api-reference"><div class="flex items-start space-y-3 flex-col"><span class="card-icon fa-icon" style="mask-image:url("https://icons.ferndocs.com/solid/code.svg");mask-repeat:no-repeat;mask-position:center center;-webkit-mask-image:url("https://icons.ferndocs.com/solid/code.svg");-webkit-mask-repeat:no-repeat;-webkit-mask-position:center center;width:32px;height:32px"></span><div class="space-y-1"><div class="t-default text-base font-semibold">API Reference</div></div></div></a><a class="fern-card interactive text-base border p-6 not-prose rounded-xl relative block" href="/welcome/create-an-api-key"><div class="flex items-start space-y-3 flex-col"><span class="card-icon fa-icon" style="mask-image:url("https://icons.ferndocs.com/solid/key.svg");mask-repeat:no-repeat;mask-position:center center;-webkit-mask-image:url("https://icons.ferndocs.com/solid/key.svg");-webkit-mask-repeat:no-repeat;-webkit-mask-position:center center;width:32px;height:32px"></span><div class="space-y-1"><div class="t-default text-base font-semibold">Create an API Key</div></div></div></a><a class="fern-card interactive text-base border p-6 not-prose rounded-xl relative block" target="_blank" rel="noreferrer" href="https://app.beehiiv.com/signup"><div class="flex items-start space-y-3 flex-col"><span class="card-icon fa-icon" style="mask-image:url("https://icons.ferndocs.com/solid/user-plus.svg");mask-repeat:no-repeat;mask-position:center center;-webkit-mask-image:url("https://icons.ferndocs.com/solid/user-plus.svg");-webkit-mask-repeat:no-repeat;-webkit-mask-position:center center;width:32px;height:32px"></span><div class="space-y-1"><div class="t-default text-base font-semibold">Sign up for beehiiv</div></div></div></a><a class="fern-card interactive text-base border p-6 not-prose rounded-xl relative block" target="_blank" rel="noreferrer" href="https://blog.beehiiv.com/"><div class="flex items-start space-y-3 flex-col"><span class="card-icon fa-icon" style="mask-image:url("https://icons.ferndocs.com/solid/newspaper.svg");mask-repeat:no-repeat;mask-position:center center;-webkit-mask-image:url("https://icons.ferndocs.com/solid/newspaper.svg");-webkit-mask-repeat:no-repeat;-webkit-mask-position:center center;width:32px;height:32px"></span><div class="space-y-1"><div class="t-default text-base font-semibold">Blog</div></div></div></a></div> <p>Looking for support? Inspiration? Check out our other resources:</p> <ul class="list-outside list-disc space-y-2 mb-3"> <li class=""><a class="fern-mdx-link" target="_blank" rel="noreferrer" href="https://support.beehiiv.com/hc/en-us">Knowledge Base<svg width="1.5em" height="1.5em" viewBox="0 0 24 24" stroke-width="1.5" fill="none" xmlns="http://www.w3.org/2000/svg" color="currentColor" class="external-link-icon"><path d="M21 3L15 3M21 3L12 12M21 3V9" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path><path d="M21 13V19C21 20.1046 20.1046 21 19 21H5C3.89543 21 3 20.1046 3 19V5C3 3.89543 3.89543 3 5 3H11" stroke="currentColor" stroke-linecap="round"></path></svg></a>: Product support, documentation, and assistance.</li> <li class=""><a class="fern-mdx-link" target="_blank" rel="noreferrer" href="https://www.youtube.com/channel/UCI80tsW3wYNGEJLxwJo42vw">Tutorials<svg width="1.5em" height="1.5em" viewBox="0 0 24 24" stroke-width="1.5" fill="none" xmlns="http://www.w3.org/2000/svg" color="currentColor" class="external-link-icon"><path d="M21 3L15 3M21 3L12 12M21 3V9" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path><path d="M21 13V19C21 20.1046 20.1046 21 19 21H5C3.89543 21 3 20.1046 3 19V5C3 3.89543 3.89543 3 5 3H11" stroke="currentColor" stroke-linecap="round"></path></svg></a>: Archive of video tutorials.</li> <li class=""><a class="fern-mdx-link" target="_blank" rel="noreferrer" href="https://www.beehiiv.com/courses/newsletter-xp">Course<svg width="1.5em" height="1.5em" viewBox="0 0 24 24" stroke-width="1.5" fill="none" xmlns="http://www.w3.org/2000/svg" color="currentColor" class="external-link-icon"><path d="M21 3L15 3M21 3L12 12M21 3V9" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path><path d="M21 13V19C21 20.1046 20.1046 21 19 21H5C3.89543 21 3 20.1046 3 19V5C3 3.89543 3.89543 3 5 3H11" stroke="currentColor" stroke-linecap="round"></path></svg></a>: How to build, scale, and monetize your newsletter.</li> <li class=""><a class="fern-mdx-link" target="_blank" rel="noreferrer" href="https://blog.beehiiv.com/">Blog<svg width="1.5em" height="1.5em" viewBox="0 0 24 24" stroke-width="1.5" fill="none" xmlns="http://www.w3.org/2000/svg" color="currentColor" class="external-link-icon"><path d="M21 3L15 3M21 3L12 12M21 3V9" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path><path d="M21 13V19C21 20.1046 20.1046 21 19 21H5C3.89543 21 3 20.1046 3 19V5C3 3.89543 3.89543 3 5 3H11" stroke="currentColor" stroke-linecap="round"></path></svg></a>: Best practices to help scale your newsletter.</li> <li class=""><a class="fern-mdx-link" target="_blank" rel="noreferrer" href="https://app.beehiiv.com/?new_support_ticket">Submit a support ticket<svg width="1.5em" height="1.5em" viewBox="0 0 24 24" stroke-width="1.5" fill="none" xmlns="http://www.w3.org/2000/svg" color="currentColor" class="external-link-icon"><path d="M21 3L15 3M21 3L12 12M21 3V9" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path><path d="M21 13V19C21 20.1046 20.1046 21 19 21H5C3.89543 21 3 20.1046 3 19V5C3 3.89543 3.89543 3 5 3H11" stroke="currentColor" stroke-linecap="round"></path></svg></a></li> </ul></div><footer class="mt-12"><div class="flex sm:justify-between max-sm:flex-col gap-4"><div><div><div class="flex items-center justify-start flex-wrap gap-4"><span class="t-muted text-sm font-medium">Was this page helpful?</span><span class="fern-button-group"><button tabindex="0" data-state="closed" aria-disabled="false" type="button" aria-haspopup="dialog" aria-expanded="false" aria-controls="radix-:R35t8u6:" class="fern-button outlined normal"><span class="fern-button-content"><svg width="1.5em" height="1.5em" stroke-width="1.5" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" color="currentColor" class=""><path d="M16.4724 20H4.1C3.76863 20 3.5 19.7314 3.5 19.4V9.6C3.5 9.26863 3.76863 9 4.1 9H6.86762C7.57015 9 8.22116 8.6314 8.5826 8.02899L11.293 3.51161C11.8779 2.53688 13.2554 2.44422 13.9655 3.33186C14.3002 3.75025 14.4081 4.30635 14.2541 4.81956L13.2317 8.22759C13.1162 8.61256 13.4045 9 13.8064 9H18.3815C19.7002 9 20.658 10.254 20.311 11.5262L18.4019 18.5262C18.1646 19.3964 17.3743 20 16.4724 20Z" stroke="currentColor" stroke-linecap="round"></path><path d="M7 20L7 9" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path></svg><span class="fern-button-text">Yes</span></span></button><button tabindex="0" data-state="closed" aria-disabled="false" aria-selected="false" data-selected="false" type="button" aria-haspopup="dialog" aria-expanded="false" aria-controls="radix-:R55t8u6:" class="fern-button outlined normal"><span class="fern-button-content"><svg width="1.5em" height="1.5em" stroke-width="1.5" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" color="currentColor" class=""><path d="M16.4724 3.5H4.1C3.76863 3.5 3.5 3.76863 3.5 4.1V13.9C3.5 14.2314 3.76863 14.5 4.1 14.5H6.86762C7.57015 14.5 8.22116 14.8686 8.5826 15.471L11.293 19.9884C11.8779 20.9631 13.2554 21.0558 13.9655 20.1681C14.3002 19.7497 14.4081 19.1937 14.2541 18.6804L13.2317 15.2724C13.1162 14.8874 13.4045 14.5 13.8064 14.5H18.3815C19.7002 14.5 20.658 13.246 20.311 11.9738L18.4019 4.97376C18.1646 4.10364 17.3743 3.5 16.4724 3.5Z" stroke="currentColor" stroke-linecap="round"></path><path d="M7 14.5L7 3.5" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path></svg><span class="fern-button-text">No</span></span></button></span></div></div></div></div><div class="not-prose grid grid-cols-1"><a class="fern-card interactive my-12 flex flex-1 items-center rounded-xl p-6" href="/welcome/create-an-api-key"><div class="flex-1"><div class="text-base font-semibold">Create an API Key</div></div><span class="sm-4 t-muted inline-flex items-center gap-2 py-2.5 text-sm sm:border-default sm:ml-6 sm:border-l sm:pl-6"><span class="hidden leading-none sm:inline">Up Next</span><svg width="1.5em" height="1.5em" stroke-width="1.5" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" color="currentColor" class="size-icon"><path d="M9 6L15 12L9 18" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path></svg></span></a></div><div class="w-fit mx-auto my-8"><span data-state="closed"><a class="inline-flex items-baseline gap-1" target="_blank" rel="noreferrer" href="https://buildwithfern.com/?utm_campaign=buildWith&utm_medium=docs&utm_source=developers.beehiiv.com"><span class="text-xs t-muted whitespace-nowrap">Built with</span><svg viewBox="0 0 604 164" fill="none" xmlns="http://www.w3.org/2000/svg" class="aspect-[604/164] -mt-0.5 h-3.5 transition"><path fill-rule="evenodd" clip-rule="evenodd" d="M295.294 0H255.861H255.836C234.047 0 221.437 11.4661 221.437 33.483V47.2372H193.242V75.2033H221.437V160.5H253.547V75.2033H288.404V47.2372H253.547V37.3728C253.547 30.7118 257.208 27.9661 263.87 27.9661H295.294V0ZM345.26 43.8081C311.777 43.8081 288.844 67.1979 288.844 103.198H288.87C288.87 139.884 311.802 163.96 346.43 163.96C375.311 163.96 392.727 149.291 399.388 126.816H366.591C363.591 133.02 356.955 137.367 346.633 137.367C331.277 137.367 321.87 129.562 320.497 115.35H400.761C401.219 110.545 401.447 106.401 401.447 102.283C401.447 66.2826 378.744 43.8081 345.26 43.8081ZM369.108 90.5877V91.0453H320.269C321.184 77.7487 329.675 69.0284 345.26 69.0284C360.845 69.0284 369.108 77.7487 369.108 90.5877ZM412.668 47.2321H440.863V67.1898C443.609 54.3508 452.787 47.2321 467.227 47.2321H487.414V51.122C487.414 64.4186 476.634 75.1982 463.338 75.1982C450.727 75.1982 444.753 81.6304 444.753 94.4694V160.52H412.642V47.2321H412.668ZM526.939 47.24H498.744H498.719V160.503H530.829V96.0789C530.829 81.6382 539.321 72.6891 552.16 72.6891C564.999 72.6891 571.889 80.0366 571.889 95.1637V160.528H604V91.7315C604 61.7061 586.559 43.8078 558.821 43.8078C545.753 43.8078 533.601 48.8417 526.939 58.7061V47.24Z" class="fill-grayscale-a10"></path><path d="M149.383 80.2222C138.594 71.101 122.341 67.4445 107.936 78.0925C107.273 78.5747 106.449 77.751 106.952 77.1081C110.367 72.7082 114.325 67.9668 117.519 63.2053C120.774 58.3233 125.636 54.8275 131.241 53.1198C161.076 44.079 152.116 0 152.116 0C152.116 0 106.027 2.97342 111.713 42.7329C112.657 49.3829 110.889 56.1535 106.731 61.4374C101.628 67.8865 95.7008 74.0543 91.4014 78.5144C90.4973 79.4386 88.9705 78.5546 89.3321 77.309C93.4909 63.3058 96.5246 41.648 82.1195 27.685L61.848 10.849L57.9504 15.9922C46.3581 31.2812 49.7534 52.8385 65.0625 64.4108C73.8422 71.0407 77.8201 78.2533 77.1973 86.169C76.8156 90.9104 74.6659 95.3505 71.4514 98.8663C65.4041 105.496 59.7586 112.608 55.3989 120.846C54.7962 121.991 53.0483 121.549 53.1086 120.243C53.7314 106.641 52.4255 75.983 29.5221 65.0336L3.88635 55.1289L1.89737 61.0556C-4.55174 80.182 5.99588 100.614 25.1021 107.104C41.7171 112.749 47.6439 123.457 43.6458 139.51C43.465 140.092 40.572 156.627 40.9738 163.96H59.3969C60.0198 152.589 71.9536 145.115 82.3003 149.756C85.2135 151.062 88.207 152.93 91.2809 155.341C107.755 168.32 132.025 165.246 144.983 148.752L148.68 144.05L125.375 127.315C109.383 114.738 88.0463 120.424 72.255 131.192C70.929 132.096 69.2414 130.65 69.9847 129.203C89.0709 91.7542 113.883 91.8346 123.607 100.152C135.4 110.238 153.261 108.429 163.266 96.5961L166.139 93.2007L149.363 80.2222H149.383Z" class="fill-grayscale-a10"></path></svg></a></span></div></footer></article></main></div></div><footer id="fern-footer"></footer></div></div><script id="__NEXT_DATA__" type="application/json">{"props":{"pageProps":{"baseUrl":{"domain":"developers.beehiiv.com"},"layout":{"contentWidth":{"type":"rem","value":40},"sidebarWidth":{"type":"rem","value":18},"searchbarPlacement":"SIDEBAR","tabsPlacement":"SIDEBAR","contentAlignment":"CENTER","headerPosition":"FIXED","disableHeader":false},"title":"beehiiv | Developer Documentation","favicon":"6e9e0b50-7293-442b-97c9-942e7b8069a3","colors":{"light":{"accentPrimary":{"r":58,"g":67,"b":200,"a":1},"logo":"db566130-c0a8-4f45-b051-1a6d5fab3e9a","background":{"type":"solid","r":255,"g":255,"b":255,"a":1},"border":{"r":215,"g":217,"b":246,"a":1},"headerBackground":{"r":255,"g":255,"b":255,"a":1}},"dark":{"accentPrimary":{"r":215,"g":217,"b":244,"a":1},"logo":"6ebe1206-6848-4f88-a530-2594e3ace162","background":{"type":"solid","r":12,"g":17,"b":29,"a":1},"border":{"r":255,"g":255,"b":255,"a":1},"headerBackground":{"r":12,"g":17,"b":29,"a":1}}},"js":{"files":[]},"navbarLinks":[{"type":"minimal","href":"https://developers.beehiiv.com/auth","text":"Login"},{"type":"filled","href":"https://www.beehiiv.com/pricing?","text":"Start trial"},{"type":"primary","href":"https://www.beehiiv.com/demo/form?","text":"Get a demo"}],"logoHeight":30,"logoHref":"https://www.beehiiv.com/","files":{"5475b15e-149d-4c60-9e0f-2fa75ae42781":{"type":"url","url":"https://fdr-prod-docs-files-public.s3.amazonaws.com/https://beehiiv.docs.buildwithfern.com/2024-11-19T22:24:11.626Z/assets/fonts/Satoshi-Regular.woff2"},"05c6dd84-6f87-420b-8c07-881f5bdc84c5":{"type":"url","url":"https://fdr-prod-docs-files-public.s3.amazonaws.com/https://beehiiv.docs.buildwithfern.com/2024-11-19T22:24:11.626Z/assets/fonts/Satoshi-Medium.woff2"},"66dcb895-7e6f-4be4-929b-e9edf3f6dca2":{"type":"url","url":"https://fdr-prod-docs-files-public.s3.amazonaws.com/https://beehiiv.docs.buildwithfern.com/2024-11-19T22:24:11.626Z/assets/fonts/Satoshi-Bold.woff2"},"df02da38-4c9f-40d9-b7e8-dbe2ec36f95b":{"type":"url","url":"https://fdr-prod-docs-files-public.s3.amazonaws.com/https://beehiiv.docs.buildwithfern.com/2024-11-19T22:24:11.626Z/assets/fonts/MonaspaceNeon-Regular.woff2"},"6ebe1206-6848-4f88-a530-2594e3ace162":{"type":"image","width":1659,"height":419,"url":"https://fdr-prod-docs-files-public.s3.amazonaws.com/https://beehiiv.docs.buildwithfern.com/2024-11-19T22:24:11.626Z/assets/logo-dark-mode.svg"},"db566130-c0a8-4f45-b051-1a6d5fab3e9a":{"type":"image","width":1659,"height":419,"url":"https://fdr-prod-docs-files-public.s3.amazonaws.com/https://beehiiv.docs.buildwithfern.com/2024-11-19T22:24:11.626Z/assets/logo-light-mode.svg"},"6e9e0b50-7293-442b-97c9-942e7b8069a3":{"type":"image","width":999,"height":999,"url":"https://fdr-prod-docs-files-public.s3.amazonaws.com/https://beehiiv.docs.buildwithfern.com/2024-11-19T22:24:11.626Z/assets/favicon.png"}},"content":{"slug":"welcome/getting-started","title":{"engine":"next-mdx-remote","code":"\"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: \"Getting Started\"\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":{},"jsxRefs":[]},"subtitle":{"engine":"next-mdx-remote","code":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n em: \"em\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"beehiiv is the newsletter platform built for \", _jsx(_components.em, {\n children: \"growth\"\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};\n","frontmatter":{},"scope":{},"jsxRefs":[]},"tableOfContents":[],"content":{"engine":"next-mdx-remote","code":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n a: \"a\",\n li: \"li\",\n p: \"p\",\n ul: \"ul\",\n ..._provideComponents(),\n ...props.components\n }, {Card, Cards} = _components;\n if (!Card) _missingMdxReference(\"Card\", true);\n if (!Cards) _missingMdxReference(\"Cards\", true);\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Harness beehiiv’s API to enrich your user records with custom fields from external forms,\\nmanage lists and segmentation programmatically, and integrate your beehiiv publication\\nmore closely with advertising platforms.\"\n }), \"\\n\", _jsxs(Cards, {\n children: [_jsx(Card, {\n title: \"API Reference\",\n icon: \"fa-solid fa-code\",\n href: \"/api-reference\"\n }), _jsx(Card, {\n title: \"Create an API Key\",\n icon: \"fa-solid fa-key\",\n href: \"/welcome/create-an-api-key\"\n }), _jsx(Card, {\n title: \"Sign up for beehiiv\",\n icon: \"fa-solid fa-user-plus\",\n href: \"https://app.beehiiv.com/signup\"\n }), _jsx(Card, {\n title: \"Blog\",\n icon: \"fa-solid fa-newspaper\",\n href: \"https://blog.beehiiv.com/\"\n })]\n }), \"\\n\", _jsx(_components.p, {\n children: \"Looking for support? Inspiration? Check out our other resources:\"\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.a, {\n href: \"https://support.beehiiv.com/hc/en-us\",\n children: \"Knowledge Base\"\n }), \": Product support, documentation, and assistance.\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.a, {\n href: \"https://www.youtube.com/channel/UCI80tsW3wYNGEJLxwJo42vw\",\n children: \"Tutorials\"\n }), \": Archive of video tutorials.\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.a, {\n href: \"https://www.beehiiv.com/courses/newsletter-xp\",\n children: \"Course\"\n }), \": How to build, scale, and monetize your newsletter.\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.a, {\n href: \"https://blog.beehiiv.com/\",\n children: \"Blog\"\n }), \": Best practices to help scale your newsletter.\"]\n }), \"\\n\", _jsx(_components.li, {\n children: _jsx(_components.a, {\n href: \"https://app.beehiiv.com/?new_support_ticket\",\n children: \"Submit a support ticket\"\n })\n }), \"\\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":{"subtitle":"beehiiv is the newsletter platform built for _growth_."},"scope":{},"jsxRefs":["Cards","Card"]},"breadcrumb":[{"title":"Welcome","pointsTo":"welcome/getting-started"}],"neighbors":{"prev":null,"next":{"slug":"welcome/create-an-api-key","title":"Create an API Key"}},"hasAside":false,"type":"markdown-page","apis":{},"endpointIdsToSlugs":{}},"navigation":{"tabs":[],"versions":[],"sidebar":{"type":"sidebarRoot","id":"root.uv","children":[{"type":"section","id":"root.uv.welcome","children":[{"type":"page","id":"root.uv.welcome.getting-started","title":"Getting Started","slug":"welcome/getting-started","hidden":false,"pageId":"docs/pages/getting-started/getting-started.mdx"},{"type":"page","id":"root.uv.welcome.create-an-api-key","title":"Create an API Key","slug":"welcome/create-an-api-key","hidden":false,"pageId":"docs/pages/getting-started/create-an-api-key.mdx"},{"type":"page","id":"root.uv.welcome.no-code-integrations","title":"No-Code Integrations","slug":"welcome/no-code-integrations","hidden":false,"pageId":"docs/pages/getting-started/no-code-integrations.mdx"}],"title":"Welcome","slug":"welcome","hidden":false,"pointsTo":"welcome/getting-started","collapsed":false},{"type":"apiReference","paginated":false,"showErrors":false,"hideTitle":false,"children":[{"type":"apiPackage","id":"a2302659-8446-4257-9249-887fe248f4ad:subpackage_post","children":[{"type":"webhook","id":"a2302659-8446-4257-9249-887fe248f4ad:subpackage_post.sent","title":"Post Sent","slug":"webhooks/post/sent","apiDefinitionId":"a2302659-8446-4257-9249-887fe248f4ad","method":"POST","webhookId":"subpackage_post.sent"}],"title":"Post","slug":"webhooks/post","pointsTo":"webhooks/post/sent","apiDefinitionId":"a2302659-8446-4257-9249-887fe248f4ad"},{"type":"apiPackage","id":"a2302659-8446-4257-9249-887fe248f4ad:subpackage_subscription","children":[{"type":"webhook","id":"a2302659-8446-4257-9249-887fe248f4ad:subpackage_subscription.created","title":"Subscription Created","slug":"webhooks/subscription/created","apiDefinitionId":"a2302659-8446-4257-9249-887fe248f4ad","method":"POST","webhookId":"subpackage_subscription.created"},{"type":"webhook","id":"a2302659-8446-4257-9249-887fe248f4ad:subpackage_subscription.confirmed","title":"Subscription Confirmed","slug":"webhooks/subscription/confirmed","apiDefinitionId":"a2302659-8446-4257-9249-887fe248f4ad","method":"POST","webhookId":"subpackage_subscription.confirmed"},{"type":"webhook","id":"a2302659-8446-4257-9249-887fe248f4ad:subpackage_subscription.deleted","title":"Subscription Deleted","slug":"webhooks/subscription/deleted","apiDefinitionId":"a2302659-8446-4257-9249-887fe248f4ad","method":"POST","webhookId":"subpackage_subscription.deleted"},{"type":"webhook","id":"a2302659-8446-4257-9249-887fe248f4ad:subpackage_subscription.upgraded","title":"Subscription Upgraded","slug":"webhooks/subscription/upgraded","apiDefinitionId":"a2302659-8446-4257-9249-887fe248f4ad","method":"POST","webhookId":"subpackage_subscription.upgraded"},{"type":"webhook","id":"a2302659-8446-4257-9249-887fe248f4ad:subpackage_subscription.downgraded","title":"Subscription Downgraded","slug":"webhooks/subscription/downgraded","apiDefinitionId":"a2302659-8446-4257-9249-887fe248f4ad","method":"POST","webhookId":"subpackage_subscription.downgraded"},{"type":"webhook","id":"a2302659-8446-4257-9249-887fe248f4ad:subpackage_subscription.tier_added","title":"Subscription Tier Added","slug":"webhooks/subscription/tier-added","apiDefinitionId":"a2302659-8446-4257-9249-887fe248f4ad","method":"POST","webhookId":"subpackage_subscription.tier_added"},{"type":"webhook","id":"a2302659-8446-4257-9249-887fe248f4ad:subpackage_subscription.tier_deleted","title":"Subscription Tier Deleted","slug":"webhooks/subscription/tier-deleted","apiDefinitionId":"a2302659-8446-4257-9249-887fe248f4ad","method":"POST","webhookId":"subpackage_subscription.tier_deleted"}],"title":"Subscription","slug":"webhooks/subscription","pointsTo":"webhooks/subscription/created","apiDefinitionId":"a2302659-8446-4257-9249-887fe248f4ad"},{"type":"apiPackage","id":"a2302659-8446-4257-9249-887fe248f4ad:subpackage_survey","children":[{"type":"webhook","id":"a2302659-8446-4257-9249-887fe248f4ad:subpackage_survey.submitted","title":"Survey Response Submitted","slug":"webhooks/survey/submitted","apiDefinitionId":"a2302659-8446-4257-9249-887fe248f4ad","method":"POST","webhookId":"subpackage_survey.submitted"}],"title":"Survey","slug":"webhooks/survey","pointsTo":"webhooks/survey/submitted","apiDefinitionId":"a2302659-8446-4257-9249-887fe248f4ad"}],"title":"Webhooks","slug":"webhooks","id":"a2302659-8446-4257-9249-887fe248f4ad","overviewPageId":"docs/pages/webhooks/webhooks-summary.mdx","apiDefinitionId":"a2302659-8446-4257-9249-887fe248f4ad"},{"type":"apiReference","paginated":false,"showErrors":true,"hideTitle":false,"children":[{"type":"apiPackage","id":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d:subpackage_automationJourneys","children":[{"type":"endpoint","id":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d:endpoint_automationJourneys.create","title":"Add subscription to an automation","slug":"api-reference/automation-journeys/create","apiDefinitionId":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d","method":"POST","endpointId":"endpoint_automationJourneys.create","isResponseStream":false},{"type":"endpoint","id":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d:endpoint_automationJourneys.index","title":"List automation journeys","slug":"api-reference/automation-journeys/index","apiDefinitionId":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d","method":"GET","endpointId":"endpoint_automationJourneys.index","isResponseStream":false},{"type":"endpoint","id":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d:endpoint_automationJourneys.show","title":"Get automation journey","slug":"api-reference/automation-journeys/show","apiDefinitionId":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d","method":"GET","endpointId":"endpoint_automationJourneys.show","isResponseStream":false}],"title":"Automation Journeys","slug":"api-reference/automation-journeys","pointsTo":"api-reference/automation-journeys/create","apiDefinitionId":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d"},{"type":"apiPackage","id":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d:subpackage_automations","children":[{"type":"endpoint","id":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d:endpoint_automations.index","title":"List automations","slug":"api-reference/automations/index","apiDefinitionId":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d","method":"GET","endpointId":"endpoint_automations.index","isResponseStream":false},{"type":"endpoint","id":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d:endpoint_automations.show","title":"Get automation","slug":"api-reference/automations/show","apiDefinitionId":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d","method":"GET","endpointId":"endpoint_automations.show","isResponseStream":false}],"title":"Automations","slug":"api-reference/automations","pointsTo":"api-reference/automations/index","apiDefinitionId":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d"},{"type":"apiPackage","id":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d:subpackage_bulkSubscriptionUpdates","children":[{"type":"endpoint","id":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d:endpoint_bulkSubscriptionUpdates.index","title":"List subscription updates","slug":"api-reference/bulk-subscription-updates/index","apiDefinitionId":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d","method":"GET","endpointId":"endpoint_bulkSubscriptionUpdates.index","isResponseStream":false},{"type":"endpoint","id":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d:endpoint_bulkSubscriptionUpdates.show","title":"Get subscription update","slug":"api-reference/bulk-subscription-updates/show","apiDefinitionId":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d","method":"GET","endpointId":"endpoint_bulkSubscriptionUpdates.show","isResponseStream":false},{"type":"endpoint","id":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d:endpoint_bulkSubscriptionUpdates.put","title":"Update subscriptions","slug":"api-reference/bulk-subscription-updates/put","apiDefinitionId":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d","method":"PUT","endpointId":"endpoint_bulkSubscriptionUpdates.put","isResponseStream":false},{"type":"endpoint","id":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d:endpoint_bulkSubscriptionUpdates.patch","title":"Update subscriptions","slug":"api-reference/bulk-subscription-updates/patch","canonicalSlug":"api-reference/bulk-subscription-updates/put","apiDefinitionId":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d","method":"PATCH","endpointId":"endpoint_bulkSubscriptionUpdates.patch","isResponseStream":false},{"type":"endpoint","id":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d:endpoint_bulkSubscriptionUpdates.put-status","title":"Update subscriptions' status","slug":"api-reference/bulk-subscription-updates/put-status","apiDefinitionId":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d","method":"PUT","endpointId":"endpoint_bulkSubscriptionUpdates.put-status","isResponseStream":false},{"type":"endpoint","id":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d:endpoint_bulkSubscriptionUpdates.patch-status","title":"Update subscriptions' status","slug":"api-reference/bulk-subscription-updates/patch-status","canonicalSlug":"api-reference/bulk-subscription-updates/put-status","apiDefinitionId":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d","method":"PATCH","endpointId":"endpoint_bulkSubscriptionUpdates.patch-status","isResponseStream":false}],"title":"Bulk Subscription Updates","slug":"api-reference/bulk-subscription-updates","pointsTo":"api-reference/bulk-subscription-updates/index","apiDefinitionId":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d"},{"type":"apiPackage","id":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d:subpackage_customFields","children":[{"type":"endpoint","id":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d:endpoint_customFields.create","title":"Create custom field","slug":"api-reference/custom-fields/create","apiDefinitionId":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d","method":"POST","endpointId":"endpoint_customFields.create","isResponseStream":false},{"type":"endpoint","id":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d:endpoint_customFields.show","title":"Get custom field","slug":"api-reference/custom-fields/show","apiDefinitionId":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d","method":"GET","endpointId":"endpoint_customFields.show","isResponseStream":false},{"type":"endpoint","id":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d:endpoint_customFields.index","title":"List custom fields","slug":"api-reference/custom-fields/index","apiDefinitionId":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d","method":"GET","endpointId":"endpoint_customFields.index","isResponseStream":false},{"type":"endpoint","id":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d:endpoint_customFields.put","title":"Update custom field","slug":"api-reference/custom-fields/put","apiDefinitionId":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d","method":"PUT","endpointId":"endpoint_customFields.put","isResponseStream":false},{"type":"endpoint","id":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d:endpoint_customFields.patch","title":"Update custom field","slug":"api-reference/custom-fields/patch","canonicalSlug":"api-reference/custom-fields/put","apiDefinitionId":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d","method":"PATCH","endpointId":"endpoint_customFields.patch","isResponseStream":false},{"type":"endpoint","id":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d:endpoint_customFields.delete","title":"Delete custom field","slug":"api-reference/custom-fields/delete","apiDefinitionId":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d","method":"DELETE","endpointId":"endpoint_customFields.delete","isResponseStream":false}],"title":"Custom Fields","slug":"api-reference/custom-fields","pointsTo":"api-reference/custom-fields/create","apiDefinitionId":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d"},{"type":"apiPackage","id":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d:subpackage_posts","children":[{"type":"endpoint","id":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d:endpoint_posts.index","title":"List posts","slug":"api-reference/posts/index","apiDefinitionId":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d","method":"GET","endpointId":"endpoint_posts.index","isResponseStream":false},{"type":"endpoint","id":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d:endpoint_posts.show","title":"Get post","slug":"api-reference/posts/show","apiDefinitionId":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d","method":"GET","endpointId":"endpoint_posts.show","isResponseStream":false},{"type":"endpoint","id":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d:endpoint_posts.delete","title":"Delete post","slug":"api-reference/posts/delete","apiDefinitionId":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d","method":"DELETE","endpointId":"endpoint_posts.delete","isResponseStream":false}],"title":"Posts","slug":"api-reference/posts","pointsTo":"api-reference/posts/index","apiDefinitionId":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d"},{"type":"apiPackage","id":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d:subpackage_publications","children":[{"type":"endpoint","id":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d:endpoint_publications.index","title":"List publications","slug":"api-reference/publications/index","apiDefinitionId":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d","method":"GET","endpointId":"endpoint_publications.index","isResponseStream":false},{"type":"endpoint","id":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d:endpoint_publications.show","title":"Get publication","slug":"api-reference/publications/show","apiDefinitionId":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d","method":"GET","endpointId":"endpoint_publications.show","isResponseStream":false}],"title":"Publications","slug":"api-reference/publications","pointsTo":"api-reference/publications/index","apiDefinitionId":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d"},{"type":"apiPackage","id":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d:subpackage_referralProgram","children":[{"type":"endpoint","id":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d:endpoint_referralProgram.show","title":"Get referral program","slug":"api-reference/referral-program/show","apiDefinitionId":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d","method":"GET","endpointId":"endpoint_referralProgram.show","isResponseStream":false}],"title":"Referral Program","slug":"api-reference/referral-program","pointsTo":"api-reference/referral-program/show","apiDefinitionId":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d"},{"type":"apiPackage","id":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d:subpackage_segments","children":[{"type":"endpoint","id":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d:endpoint_segments.index","title":"List segments","slug":"api-reference/segments/index","apiDefinitionId":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d","method":"GET","endpointId":"endpoint_segments.index","isResponseStream":false},{"type":"endpoint","id":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d:endpoint_segments.show","title":"Get segment","slug":"api-reference/segments/show","apiDefinitionId":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d","method":"GET","endpointId":"endpoint_segments.show","isResponseStream":false},{"type":"endpoint","id":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d:endpoint_segments.expand_results","title":"List segment subscribers","slug":"api-reference/segments/expand-results","apiDefinitionId":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d","method":"GET","endpointId":"endpoint_segments.expand_results","isResponseStream":false},{"type":"endpoint","id":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d:endpoint_segments.delete","title":"Delete segment","slug":"api-reference/segments/delete","apiDefinitionId":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d","method":"DELETE","endpointId":"endpoint_segments.delete","isResponseStream":false}],"title":"Segments","slug":"api-reference/segments","pointsTo":"api-reference/segments/index","apiDefinitionId":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d"},{"type":"apiPackage","id":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d:subpackage_subscriptions","children":[{"type":"endpoint","id":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d:endpoint_subscriptions.create","title":"Create subscription","slug":"api-reference/subscriptions/create","apiDefinitionId":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d","method":"POST","endpointId":"endpoint_subscriptions.create","isResponseStream":false},{"type":"endpoint","id":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d:endpoint_subscriptions.index","title":"List subscriptions","slug":"api-reference/subscriptions/index","apiDefinitionId":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d","method":"GET","endpointId":"endpoint_subscriptions.index","isResponseStream":false},{"type":"endpoint","id":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d:endpoint_subscriptions.get-by-email","title":"Get subscription by email","slug":"api-reference/subscriptions/get-by-email","apiDefinitionId":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d","method":"GET","endpointId":"endpoint_subscriptions.get-by-email","isResponseStream":false},{"type":"endpoint","id":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d:endpoint_subscriptions.get-by-id","title":"Get subscription by ID","slug":"api-reference/subscriptions/get-by-id","apiDefinitionId":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d","method":"GET","endpointId":"endpoint_subscriptions.get-by-id","isResponseStream":false},{"type":"endpoint","id":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d:endpoint_subscriptions.put","title":"Update subscription","slug":"api-reference/subscriptions/put","apiDefinitionId":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d","method":"PUT","endpointId":"endpoint_subscriptions.put","isResponseStream":false},{"type":"endpoint","id":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d:endpoint_subscriptions.patch","title":"Update subscription","slug":"api-reference/subscriptions/patch","canonicalSlug":"api-reference/subscriptions/put","apiDefinitionId":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d","method":"PATCH","endpointId":"endpoint_subscriptions.patch","isResponseStream":false},{"type":"endpoint","id":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d:endpoint_subscriptions.delete","title":"Delete subscription","slug":"api-reference/subscriptions/delete","apiDefinitionId":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d","method":"DELETE","endpointId":"endpoint_subscriptions.delete","isResponseStream":false}],"title":"Subscriptions","slug":"api-reference/subscriptions","pointsTo":"api-reference/subscriptions/create","apiDefinitionId":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d"},{"type":"apiPackage","id":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d:subpackage_subscriptionTags","children":[{"type":"endpoint","id":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d:endpoint_subscriptionTags.create","title":"Add subscription tag","slug":"api-reference/subscription-tags/create","apiDefinitionId":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d","method":"POST","endpointId":"endpoint_subscriptionTags.create","isResponseStream":false}],"title":"Subscription Tags","slug":"api-reference/subscription-tags","pointsTo":"api-reference/subscription-tags/create","apiDefinitionId":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d"},{"type":"apiPackage","id":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d:subpackage_tiers","children":[{"type":"endpoint","id":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d:endpoint_tiers.create","title":"Create a tier","slug":"api-reference/tiers/create","apiDefinitionId":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d","method":"POST","endpointId":"endpoint_tiers.create","isResponseStream":false},{"type":"endpoint","id":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d:endpoint_tiers.index","title":"List tiers","slug":"api-reference/tiers/index","apiDefinitionId":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d","method":"GET","endpointId":"endpoint_tiers.index","isResponseStream":false},{"type":"endpoint","id":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d:endpoint_tiers.show","title":"Get tier","slug":"api-reference/tiers/show","apiDefinitionId":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d","method":"GET","endpointId":"endpoint_tiers.show","isResponseStream":false},{"type":"endpoint","id":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d:endpoint_tiers.put","title":"Update a tier","slug":"api-reference/tiers/put","apiDefinitionId":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d","method":"PUT","endpointId":"endpoint_tiers.put","isResponseStream":false},{"type":"endpoint","id":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d:endpoint_tiers.patch","title":"Update a tier","slug":"api-reference/tiers/patch","canonicalSlug":"api-reference/tiers/put","apiDefinitionId":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d","method":"PATCH","endpointId":"endpoint_tiers.patch","isResponseStream":false}],"title":"Tiers","slug":"api-reference/tiers","pointsTo":"api-reference/tiers/create","apiDefinitionId":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d"},{"type":"apiPackage","id":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d:subpackage_webhooks","children":[{"type":"endpoint","id":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d:endpoint_webhooks.create","title":"Create a webhook","slug":"api-reference/webhooks/create","apiDefinitionId":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d","method":"POST","endpointId":"endpoint_webhooks.create","isResponseStream":false},{"type":"endpoint","id":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d:endpoint_webhooks.index","title":"List webhooks","slug":"api-reference/webhooks/index","apiDefinitionId":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d","method":"GET","endpointId":"endpoint_webhooks.index","isResponseStream":false},{"type":"endpoint","id":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d:endpoint_webhooks.show","title":"Get webhook","slug":"api-reference/webhooks/show","apiDefinitionId":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d","method":"GET","endpointId":"endpoint_webhooks.show","isResponseStream":false},{"type":"endpoint","id":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d:endpoint_webhooks.delete","title":"Delete a webhook","slug":"api-reference/webhooks/delete","apiDefinitionId":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d","method":"DELETE","endpointId":"endpoint_webhooks.delete","isResponseStream":false}],"title":"Webhooks","slug":"api-reference/webhooks","pointsTo":"api-reference/webhooks/create","apiDefinitionId":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d"}],"title":"API Reference","slug":"api-reference","id":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d","apiDefinitionId":"e6de8d1d-41dd-4808-bc69-0aa32cbbff6d","pointsTo":"api-reference/automation-journeys/create"}]},"trailingSlash":false},"featureFlags":{"isApiPlaygroundEnabled":true,"isApiScrollingDisabled":false,"isWhitelabeled":false,"isSeoDisabled":false,"isTocDefaultEnabled":false,"isSnippetTemplatesEnabled":false,"isHttpSnippetsEnabled":true,"isInlineFeedbackEnabled":false,"isDarkCodeEnabled":false,"proxyShouldUseAppBuildwithfernCom":false,"isImageZoomDisabled":false,"useJavaScriptAsTypeScript":false,"alwaysEnableJavaScriptFetch":false,"scrollInContainerEnabled":false,"useMdxBundler":false,"isBatchStreamToggleDisabled":false,"isAuthEnabledInDocs":false,"isAiChatbotEnabledInPreview":false,"isAudioFileDownloadSpanSummary":false,"isDocsLogoTextEnabled":false,"isAudioExampleInternal":false,"usesApplicationJsonInFormDataValue":false,"isBinaryOctetStreamAudioPlayer":false,"hasVoiceIdPlaygroundForm":false,"isCohereTheme":false,"isFileForgeHackEnabled":false,"is404PageHidden":false,"isNewSearchExperienceEnabled":false,"isAuthenticatedPagesDiscoverable":false},"apis":["a2302659-8446-4257-9249-887fe248f4ad","e6de8d1d-41dd-4808-bc69-0aa32cbbff6d"],"seo":{"openGraph":{"siteName":"beehiiv | Developer Documentation"},"twitter":{},"additionalMetaTags":[],"additionalLinkTags":[{"rel":"icon","href":"https://fdr-prod-docs-files-public.s3.amazonaws.com/https://beehiiv.docs.buildwithfern.com/2024-11-19T22:24:11.626Z/assets/favicon.png","crossOrigin":"anonymous"},{"rel":"preload","href":"https://fdr-prod-docs-files-public.s3.amazonaws.com/https://beehiiv.docs.buildwithfern.com/2024-11-19T22:24:11.626Z/assets/fonts/Satoshi-Regular.woff2","as":"font","type":"font/woff2","crossOrigin":"anonymous"},{"rel":"preload","href":"https://fdr-prod-docs-files-public.s3.amazonaws.com/https://beehiiv.docs.buildwithfern.com/2024-11-19T22:24:11.626Z/assets/fonts/Satoshi-Medium.woff2","as":"font","type":"font/woff2","crossOrigin":"anonymous"},{"rel":"preload","href":"https://fdr-prod-docs-files-public.s3.amazonaws.com/https://beehiiv.docs.buildwithfern.com/2024-11-19T22:24:11.626Z/assets/fonts/MonaspaceNeon-Regular.woff2","as":"font","type":"font/woff2","crossOrigin":"anonymous"},{"rel":"preload","href":"https://fdr-prod-docs-files-public.s3.amazonaws.com/https://beehiiv.docs.buildwithfern.com/2024-11-19T22:24:11.626Z/assets/fonts/Satoshi-Bold.woff2","as":"font","type":"font/woff2","crossOrigin":"anonymous"}],"breadcrumbList":{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"beehiiv | Developer Documentation","item":"https://developers.beehiiv.com"},{"@type":"ListItem","position":2,"name":"Welcome","item":"https://developers.beehiiv.com/welcome"},{"@type":"ListItem","position":3,"name":"Getting Started","item":"https://developers.beehiiv.com/welcome/getting-started"}]},"canonical":"https://developers.beehiiv.com/welcome/getting-started","title":"Getting Started","description":"beehiiv is the newsletter platform built for growth.","titleTemplate":"%s — beehiiv | Developer Documentation","noindex":false,"nofollow":false},"fallback":{},"theme":"default","defaultLang":"curl","stylesheet":"\n:root {\n --typography-body-font-family: 'Satoshi', -apple-system,BlinkMacSystemFont,Segoe UI,Roboto,Oxygen,Ubuntu,Cantarell,Open Sans,Helvetica Neue,sans-serif;\n --typography-heading-font-family: 'Satoshi', -apple-system,BlinkMacSystemFont,Segoe UI,Roboto,Oxygen,Ubuntu,Cantarell,Open Sans,Helvetica Neue,sans-serif;\n --typography-code-font-family: 'Monospace Neon', ui-monospace,SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,monospace;\n --spacing-page-width: 88rem;\n --spacing-content-width: 40rem;\n --spacing-content-wide-width: 60.5rem;\n --spacing-sidebar-width: 18rem;\n --spacing-header-height: 4rem;\n --spacing-header-height-padded: 5rem;\n --spacing-header-height-real: 4rem;\n \n --grayscale-1: var(--mauve-1);\n --grayscale-2: var(--mauve-2);\n --grayscale-3: var(--mauve-3);\n --grayscale-4: var(--mauve-4);\n --grayscale-5: var(--mauve-5);\n --grayscale-6: var(--mauve-6);\n --grayscale-7: var(--mauve-7);\n --grayscale-8: var(--mauve-8);\n --grayscale-9: var(--mauve-9);\n --grayscale-10: var(--mauve-10);\n --grayscale-11: var(--mauve-11);\n --grayscale-12: var(--mauve-12);\n --grayscale-a1: var(--mauve-a1);\n --grayscale-a2: var(--mauve-a2);\n --grayscale-a3: var(--mauve-a3);\n --grayscale-a4: var(--mauve-a4);\n --grayscale-a5: var(--mauve-a5);\n --grayscale-a6: var(--mauve-a6);\n --grayscale-a7: var(--mauve-a7);\n --grayscale-a8: var(--mauve-a8);\n --grayscale-a9: var(--mauve-a9);\n --grayscale-a10: var(--mauve-a10);\n --grayscale-a11: var(--mauve-a11);\n --grayscale-a12: var(--mauve-a12);\n --accent-1: #fdfdff;\n --accent-2: #f7f9ff;\n --accent-3: #eef2ff;\n --accent-4: #e1e9ff;\n --accent-5: #d2deff;\n --accent-6: #c1d0ff;\n --accent-7: #abbdfd;\n --accent-8: #8da2f6;\n --accent-9: #3a43c8;\n --accent-10: #2f31b6;\n --accent-11: #4655ce;\n --accent-12: #212a63;\n --accent-a1: #0000ff02;\n --accent-a2: #0040ff08;\n --accent-a3: #003cff11;\n --accent-a4: #0044ff1e;\n --accent-a5: #0044ff2d;\n --accent-a6: #003eff3e;\n --accent-a7: #0037f954;\n --accent-a8: #002feb72;\n --accent-a9: #000cb8c5;\n --accent-a10: #0003a6d0;\n --accent-a11: #0015bcb9;\n --accent-a12: #000a4cde;\n --accent-surface: #f5f8ffcc;\n --gray-surface: #ffffffcc;\n --accent: 58, 67, 200;\n --accent-aa: 58, 67, 200;\n --accent-aaa: 58, 67, 200;\n --accent-tinted: 51, 59, 182;\n --background: 255, 255, 255;\n --accent-contrast: 255, 255, 255;\n --bg-color-card: rgba(255, 255, 255, 0.7);\n --sidebar-background: transparent;\n --header-background: rgb(255, 255, 255);\n --border: rgb(215, 217, 246);\n --border-concealed: rgb(215, 217, 246);\n --body-text: 0, 0, 0;\n --body-text-inverted: 255, 255, 255;\n}\n\n@media (max-width: 1024px) {\n :root {\n --spacing-header-height: 4rem;\n --spacing-header-height-padded: 5rem;\n }\n}\n\n\n:is(.dark) {\n --grayscale-1: var(--slate-1);\n --grayscale-2: var(--slate-2);\n --grayscale-3: var(--slate-3);\n --grayscale-4: var(--slate-4);\n --grayscale-5: var(--slate-5);\n --grayscale-6: var(--slate-6);\n --grayscale-7: var(--slate-7);\n --grayscale-8: var(--slate-8);\n --grayscale-9: var(--slate-9);\n --grayscale-10: var(--slate-10);\n --grayscale-11: var(--slate-11);\n --grayscale-12: var(--slate-12);\n --grayscale-a1: var(--slate-a1);\n --grayscale-a2: var(--slate-a2);\n --grayscale-a3: var(--slate-a3);\n --grayscale-a4: var(--slate-a4);\n --grayscale-a5: var(--slate-a5);\n --grayscale-a6: var(--slate-a6);\n --grayscale-a7: var(--slate-a7);\n --grayscale-a8: var(--slate-a8);\n --grayscale-a9: var(--slate-a9);\n --grayscale-a10: var(--slate-a10);\n --grayscale-a11: var(--slate-a11);\n --grayscale-a12: var(--slate-a12);\n --accent-1: #10101b;\n --accent-2: #161623;\n --accent-3: #232341;\n --accent-4: #2d2e4d;\n --accent-5: #383858;\n --accent-6: #424364;\n --accent-7: #505173;\n --accent-8: #606285;\n --accent-9: #d7d9f4;\n --accent-10: #cdcfea;\n --accent-11: #b0b3da;\n --accent-12: #dddffa;\n --accent-a1: #d9000005;\n --accent-a2: #f485a90b;\n --accent-a3: #9c81fd29;\n --accent-a4: #a598fc37;\n --accent-a5: #b4a5fe43;\n --accent-a6: #b6aefd51;\n --accent-a7: #bdb8fd62;\n --accent-a8: #c2c1fd76;\n --accent-a9: #e1e3fff3;\n --accent-a10: #e0e1fee8;\n --accent-a11: #cfd2fed6;\n --accent-a12: #e1e3fefa;\n --accent-surface: color(display-p3 0.1176 0.102 0.1569 / 0.5);\n --gray-surface: color(display-p3 0 0 0 / 5%);\n --accent: 215, 217, 244;\n --accent-aa: 215, 217, 244;\n --accent-aaa: 215, 217, 244;\n --accent-tinted: 235, 236, 249;\n --background: 12, 17, 29;\n --accent-contrast: 31, 31, 52;\n --bg-color-card: rgba(9, 13, 22, 0.5);\n --bg-color-card-solid: rgb(10, 15, 25);\n --sidebar-background: transparent;\n --header-background: rgb(12, 17, 29);\n --border: rgb(255, 255, 255);\n --border-concealed: rgb(255, 255, 255);\n --body-text: 255, 255, 255;\n --body-text-inverted: 0, 0, 0;\n}\n\n@font-face {\n font-family: 'Satoshi';\n src: url('https://fdr-prod-docs-files-public.s3.amazonaws.com/https://beehiiv.docs.buildwithfern.com/2024-11-19T22:24:11.626Z/assets/fonts/Satoshi-Regular.woff2') format('woff2');\n font-weight: 400;\n font-style: normal;\n font-display: swap;\n}\n\n@font-face {\n font-family: 'Satoshi';\n src: url('https://fdr-prod-docs-files-public.s3.amazonaws.com/https://beehiiv.docs.buildwithfern.com/2024-11-19T22:24:11.626Z/assets/fonts/Satoshi-Medium.woff2') format('woff2');\n font-weight: 500;\n font-style: normal;\n font-display: swap;\n}\n\n@font-face {\n font-family: 'Satoshi';\n src: url('https://fdr-prod-docs-files-public.s3.amazonaws.com/https://beehiiv.docs.buildwithfern.com/2024-11-19T22:24:11.626Z/assets/fonts/Satoshi-Bold.woff2') format('woff2');\n font-weight: 600;\n font-style: normal;\n font-display: swap;\n}\n\n@font-face {\n font-family: 'Monospace Neon';\n src: url('https://fdr-prod-docs-files-public.s3.amazonaws.com/https://beehiiv.docs.buildwithfern.com/2024-11-19T22:24:11.626Z/assets/fonts/MonaspaceNeon-Regular.woff2') format('woff2');\n font-weight: 400;\n font-style: normal;\n font-display: swap;\n}\n\nhtml {\n background-color: #ffffff;\n}\n\nhtml.dark {\n background-color: #0c111d;\n}\n\n\n\n.fern-button:not(.disabled).filled.primary:hover {\n background-color: #ff5ec4 !important;\n}\n\n.fern-button:not(.disabled).outlined.primary:hover {\n background-color: #ff5ec4 !important;\n color: white !important;\n}\n\n.fern-button:not(.disabled).outlined.primary:hover svg {\n color: white !important;\n}\n\n.text-green-400 {\n color: #00824d !important;\n}\n\n.fern-endpoint-content p {\n font-size: 16px !important;\n line-height: 2 !important;\n}\n\n.fern-sidebar-link-text {\n font-weight: 600 !important;\n}\n\n.fern-header-right-menu {\n font-weight: 600 !important;\n}\n\n"},"__N_SSG":true},"page":"/static/[domain]/[[...slug]]","query":{"domain":"developers.beehiiv.com","slug":["welcome","getting-started"]},"buildId":"IMGUkSREhQWPdfVC54F72","assetPrefix":"https://app.buildwithfern.com","isFallback":false,"isExperimentalCompile":false,"dynamicIds":[3447,91273,78294,84820,50712,15632],"gsp":true,"scriptLoader":[]}</script><script>(function(){function c(){var b=a.contentDocument||a.contentWindow.document;if(b){var d=b.createElement('script');d.innerHTML="window.__CF$cv$params={r:'8e71929b2c44897d',t:'MTczMjM2OTI0My4wMDAwMDA='};var a=document.createElement('script');a.nonce='';a.src='/cdn-cgi/challenge-platform/scripts/jsd/main.js';document.getElementsByTagName('head')[0].appendChild(a);";b.getElementsByTagName('head')[0].appendChild(d)}}if(document.body){var a=document.createElement('iframe');a.height=1;a.width=1;a.style.position='absolute';a.style.top=0;a.style.left=0;a.style.border='none';a.style.visibility='hidden';document.body.appendChild(a);if('loading'!==document.readyState)c();else if(window.addEventListener)document.addEventListener('DOMContentLoaded',c);else{var e=document.onreadystatechange||function(){};document.onreadystatechange=function(b){e(b);'loading'!==document.readyState&&(document.onreadystatechange=e,c())}}}})();</script></body></html>