Meta tags:
description=beehiiv is the newsletter platform built for growth.;

Headings (most frequently used words):

getting, started, create, an, api, key,

Text of the page (most frequently used words):
badge (186), intent (93), minimal (93), outlined (93), info (80), oauth (80), scope (79), read (44), subscription (37), list (36), write (34), get (28), subscriptions (25), newsletter (20), update (17), create (15), warning (14), beta (14), posts (11), post (10), newsletter_lists (10), webhooks (9), api (8), custom (8), tier (8), segments (8), publications (7), tiers (7), automations (7), beehiiv (6), for (6), delete (6), segment (6), custom_fields (6), automation (6), and (5), polls (5), field (5), with (4), the (4), key (4), page (4), your (4), getting (4), started (4), email (4), identify (4), webhook (4), data (4), deletion (4), token (4), support (3), documentation (3), fields (3), lists (3), publication (3), data_deletion (3), condition (3), complimentary (3), access (3), bulk (3), resumed (3), paused (3), built (2), scale (2), tutorials (2), reference (2), user (2), welcome (2), demo (2), start (2), trial (2), login (2), add (2), referral (2), program (2), templates (2), poll (2), engagements (2), request (2), condition_sets (2), sets (2), complimentary_access (2), status (2), updates (2), journeys (2), authors (2), advertisement (2), opportunities (2), oauth2 (2), survey (2), deleted (2), code (2), integrations (2), rate (2), limiting (2), pagination (2), search (2), index (2), level (2), llms (2), txt (2), any (2), next, running, yes, was, this, helpful, submit, ticket, best, practices, help, blog, how, build, monetize, course, archive, video, product, assistance, knowledge, base, looking, inspiration, check, out, our, other, resources, download, openapi, specification, sign, harness, enrich, records, from, external, forms, manage, segmentation, programmatically, integrate, more, closely, advertising, platforms, platform, growth, copy, light, workspace, tag, subscriber, ids, subscribers, recalculate, referral_program, send, test, aggregate, stats, responses, requests, set, emails, journey, author, introspect, revoke, authorize, response, submitted, added, downgraded, upgraded, confirmed, created, scheduled, updated, sent, unsubscribed, subscribed, workspaces, tags, users, tokens, authorizations, ask, agents, available, root, append, url, markdown, version, developer,

Text of the page (random words):
getting started beehiiv developer documentation for ai agents a documentation index is available at the root level at llms txt append llms txt to any url for a page level index or md for the markdown version of any page search ask ai login start trial get a demo search welcome getting started create an api key pagination rate limiting no code integrations webhooks newsletter list subscription post subscription survey oauth2 authorizations tokens api reference advertisement opportunities authors automation journeys automations bulk subscriptions bulk subscription updates complimentary access condition sets custom fields data deletion engagements newsletter lists newsletter list subscriptions oauth users polls posts post templates publications referral program segments subscriptions subscription tags tiers webhooks workspaces getting started create an api key pagination rate limiting no code integrations webhooks newsletter list subscription subscribed badge intent warning minimal outlined beta badge newsletter list subscription unsubscribed badge intent warning minimal outlined beta badge newsletter list subscription paused badge intent warning minimal outlined beta badge newsletter list subscription resumed badge intent warning minimal outlined beta badge post sent post updated post scheduled subscription created subscription confirmed subscription deleted subscription upgraded subscription downgraded subscription paused subscription resumed subscription tier paused subscription tier resumed subscription tier added subscription tier deleted survey response submitted oauth2 authorize create token revoke token introspect token get token info get advertisement opportunities badge intent info minimal outlined oauth scope posts read badge list authors get author add subscription to an automation badge intent info minimal outlined oauth scope automations write badge list automation journeys badge intent info minimal outlined oauth scope automations read badge get automation journey badge intent info minimal outlined oauth scope automations read badge list automations badge intent info minimal outlined oauth scope automations read badge get automation badge intent info minimal outlined oauth scope automations read badge list automation emails bulk create subscription badge intent info minimal outlined oauth scope subscriptions write badge list subscription updates badge intent info minimal outlined oauth scope subscriptions read badge get subscription update badge intent info minimal outlined oauth scope subscriptions read badge update subscriptions badge intent info minimal outlined oauth scope subscriptions write badge update subscriptions badge intent info minimal outlined oauth scope subscriptions write badge update subscriptions status badge intent info minimal outlined oauth scope subscriptions write badge update subscriptions status badge intent info minimal outlined oauth scope subscriptions write badge list complimentary access badge intent info minimal outlined oauth scope complimentary_access read badge get complimentary access badge intent info minimal outlined oauth scope complimentary_access read badge list condition sets badge intent info minimal outlined oauth scope condition_sets read badge get condition set badge intent info minimal outlined oauth scope condition_sets read badge create custom field badge intent info minimal outlined oauth scope custom_fields write badge get custom field badge intent info minimal outlined oauth scope custom_fields read badge list custom fields badge intent info minimal outlined oauth scope custom_fields read badge update custom field badge intent info minimal outlined oauth scope custom_fields write badge update custom field badge intent info minimal outlined oauth scope custom_fields write badge delete custom field badge intent info minimal outlined oauth scope custom_fields write badge create data deletion request badge intent info minimal outlined oauth scope data_deletion write badge get data deletion request badge intent info minimal outlined oauth scope data_deletion read badge list data deletion requests badge intent info minimal outlined oauth scope data_deletion read badge get publication engagements badge intent info minimal outlined oauth scope publications read badge list newsletter lists badge intent warning minimal outlined beta badge badge intent info minimal outlined oauth scope newsletter_lists read badge get newsletter list badge intent warning minimal outlined beta badge badge intent info minimal outlined oauth scope newsletter_lists read badge create newsletter list badge intent warning minimal outlined beta badge badge intent info minimal outlined oauth scope newsletter_lists write badge update newsletter list badge intent warning minimal outlined beta badge badge intent info minimal outlined oauth scope newsletter_lists write badge delete newsletter list badge intent warning minimal outlined beta badge badge intent info minimal outlined oauth scope newsletter_lists write badge create newsletter list subscription badge intent warning minimal outlined beta badge badge intent info minimal outlined oauth scope newsletter_lists write badge list newsletter list subscriptions badge intent warning minimal outlined beta badge badge intent info minimal outlined oauth scope newsletter_lists read badge get newsletter list subscription badge intent warning minimal outlined beta badge badge intent info minimal outlined oauth scope newsletter_lists read badge update newsletter list subscription badge intent warning minimal outlined beta badge badge intent info minimal outlined oauth scope newsletter_lists write badge update newsletter list subscription by subscription id badge intent warning minimal outlined beta badge badge intent info minimal outlined oauth scope newsletter_lists write badge identify user badge intent info minimal outlined oauth scope identify read badge list polls badge intent info minimal outlined oauth scope polls read badge get poll badge intent info minimal outlined oauth scope polls read badge list poll responses badge intent info minimal outlined oauth scope polls read badge create post badge intent info minimal outlined oauth scope posts write badge update post badge intent info minimal outlined oauth scope posts write badge list posts badge intent info minimal outlined oauth scope posts read badge get aggregate stats badge intent info minimal outlined oauth scope posts read badge get post badge intent info minimal outlined oauth scope posts read badge delete post badge intent info minimal outlined oauth scope posts write badge send test email badge intent info minimal outlined oauth scope posts badge get post templates badge intent info minimal outlined oauth scope posts read badge list publications badge intent info minimal outlined oauth scope publications read badge get publication badge intent info minimal outlined oauth scope publications read badge get referral program badge intent info minimal outlined oauth scope referral_program read badge create segment list segments badge intent info minimal outlined oauth scope segments read badge get segment badge intent info minimal outlined oauth scope segments read badge recalculate segment badge intent info minimal outlined oauth scope segments write badge list segment subscribers badge intent info minimal outlined oauth scope segments read badge list segment subscriber ids badge intent info minimal outlined oauth scope segments read badge delete segment badge intent info minimal outlined oauth scope segments write badge create subscription badge intent info minimal outlined oauth scope subscriptions write badge list subscriptions badge intent info minimal outlined oauth scope subscriptions read badge get subscription by email badge intent info minimal outlined oauth scope subscriptions read badge get subscription by id badge intent info minimal outlined oauth scope subscriptions read badge update subscription by id badge intent info minimal outlined oauth scope subscriptions write badge update subscription by id badge intent info minimal outlined oauth scope subscriptions write badge update subscription by email badge intent info minimal outlined oauth scope subscriptions write badge delete subscription badge intent info minimal outlined oauth scope subscriptions write badge add subscription tag badge intent info minimal outlined oauth scope subscriptions write badge create a tier badge intent info minimal outlined oauth scope tiers write badge list tiers badge intent info minimal outlined oauth scope tiers read badge get tier badge intent info minimal outlined oauth scope tiers read badge update a tier badge intent info minimal outlined oauth scope tiers write badge update a tier badge intent info minimal outlined oauth scope tiers write badge create a webhook badge intent info minimal outlined oauth scope webhooks write badge list webhooks badge intent info minimal outlined oauth scope webhooks read badge get webhook badge intent info minimal outlined oauth scope webhooks read badge update webhook badge intent info minimal outlined oauth scope webhooks write badge delete a webhook badge intent info minimal outlined oauth scope webhooks write badge identify workspace badge intent info minimal outlined oauth scope identify read badge get publications by subscription email badge intent info minimal outlined oauth scope publications read badge login start trial get a demo light welcome getting started copy page beehiiv is the newsletter platform built for growth 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 api reference create an api key sign up for beehiiv download openapi specification looking for support inspiration check out our other resources knowledge base product support documentation and assistance tutorials archive of video tutorials course how to build scale and monetize your newsletter blog best practices to help scale your newsletter submit a support ticket was this page helpful yes no create an api key get up and running with the beehiiv api next built with