Meta tags:
description=Create new subscriptions for a publication.;

Headings (most frequently used words):

subscriptions, oauth, scope, create, subscription, write, authentication, path, parameters, request, response, errors, list, read,

Text of the page (most frequently used words):
badge (202), intent (101), minimal (101), outlined (101), oauth (91), scope (90), info (88), subscription (66), read (48), list (44), #subscriptions (43), the (43), write (41), get (32), newsletter (20), update (20), optional (19), create (17), beta (16), tier (14), email (14), post (14), warning (14), this (12), string (12), tiers (11), posts (11), for (10), publications (10), newsletter_lists (10), publication (9), will (9), automations (9), custom (9), 0000 (9), webhooks (9), custom_fields (8), token (8), segments (8), subscriber (7), api (7), delete (7), data (6), segment (6), automation (6), error (5), object (5), complimentary (5), access (5), false (5), premium (5), polls (5), field (5), with (4), page (4), not (4), request (4), created (4), lists (4), new (4), strings (4), double (4), opt (4), fields (4), referral_code (4), utm_campaign (4), bearer (4), com (4), name (4), identify (4), webhook (4), deletion (4), prefixed (3), must (3), format (3), when (3), defaults (3), boolean (3), array (3), ids (3), active (3), add (3), from (3), are (3), any (3), referral (3), referring_site (3), acquisition (3), search (3), utm_medium (3), utm_source (3), publicationid (3), https (3), status (3), 000000000000 (3), beehiiv (3), data_deletion (3), condition (3), bulk (3), resumed (3), paused (3), was (2), requests (2), response (2), belong (2), same (2), auto (2), subscribed (2), subscribe (2), newsletter_list_ids (2), their (2), have (2), stripe_customer_id (2), assign (2), provided (2), assigned (2), these (2), can (2), combined (2), include (2), both (2), duplicates (2), removed (2), takes (2), precedence (2), over (2), parameter (2), premium_tiers (2), premium_tier_ids (2), names (2), default (2), settings (2), marked (2), and (2), receive (2), confirmation (2), already (2), should (2), subscribers (2), website (2), content (2), typically (2), used (2), utm_content (2), term (2), utm_term (2), send_welcome_email (2), unsubscribed (2), reactivate_existing (2), required (2), authentication (2), authorization (2), www (2), blog (2), organic (2), protected (2), value (2), wayneenterprise (2), curl (2), reference (2), demo (2), start (2), trial (2), login (2), program (2), templates (2), poll (2), engagements (2), condition_sets (2), sets (2), complimentary_access (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), key (2), getting (2), started (2), put (2), documentation (2), index (2), level (2), llms (2), txt (2), built, next, previous, yes, helpful, internal, server, 500, too, many, 429, found, 404, unauthorized, 401, bad, 400, errors, apply, comp_access_, complimentary_gift_id, true, configured, skip_newsletter_list_auto_subscribe, enroll, into, after, has, been, requires, trigger, automation_ids, stripe, customer, cus_, specific, matching, enum, not_set, applied, off, immediately, need, confirm, prior, being, override, possible, values, double_opt_override, exist, here, discarded, objects, gives, credit, that, referred, testing, variations, keyword, campaign, medium, source, whether, reactivate, they, option, only, knowingly, resubscribing, address, endpoint, expects, pub_, path, parameters, form, where, your, auth, utm_channel, twitter, gold, subscription_premium_tier_names, free, subscription_tier, 1666800076, validating, sub_00000000, successful, 200, try, nl_list_00000000, cus_12345abcde, wayne, last, bruce, first, fall_2022_promotion, type, application, json, pub_00000000, copy, light, workspace, tag, recalculate, referral_program, send, test, aggregate, stats, responses, user, set, emails, journey, author, introspect, revoke, authorize, submitted, added, downgraded, upgraded, confirmed, scheduled, updated, sent, workspaces, tags, del, patch, users, tokens, authorizations, welcome, ask, agents, available, root, append, url, markdown, version, developer,

Text of the page (random words):
reate subscription oauth scope subscriptions write 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 post create subscription badge intent info minimal outlined oauth scope subscriptions write badge get list subscriptions badge intent info minimal outlined oauth scope subscriptions read badge get get subscription by email badge intent info minimal outlined oauth scope subscriptions read badge get get subscription by id badge intent info minimal outlined oauth scope subscriptions read badge put update subscription by id badge intent info minimal outlined oauth scope subscriptions write badge patch update subscription by id badge intent info minimal outlined oauth scope subscriptions write badge put update subscription by email badge intent info minimal outlined oauth scope subscriptions write badge del delete subscription badge intent info minimal outlined oauth scope subscriptions write badge 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 api reference subscriptions create subscription oauth scope subscriptions write copy page post https api beehiiv com v2 publications publicationid subscriptions post v2 publications publicationid subscriptions curl curl x post https api beehiiv com v2 publications pub_00000000 0000 0000 0000 000000000000 subscriptions h authorization bearer token h content type application json d email email protected reactivate_existing false send_welcome_email false utm_source wayneenterprise utm_medium organic utm_campaign fall_2022_promotion referring_site www wayneenterprise com blog custom_fields name first name value bruce name last name value wayne stripe_customer_id cus_12345abcde newsletter_list_ids nl_list_00000000 0000 0000 0000 000000000000 try it 200 successful 1 2 data 3 id sub_00000000 0000 0000 0000 000000000000 4 email email protected 5 status validating 6 created 1666800076 7 subscription_tier free 8 subscription_premium_tier_names 9 premium 10 gold 11 12 utm_source twitter 13 utm_medium organic 14 utm_channel website 15 utm_campaign utm_campaign 16 utm_term 17 utm_content 18 referring_site https www blog com 19 referral_code referral_code 20 21 create new subscriptions for a publication authentication authorization bearer bearer authentication of the form bearer token where token is your auth token path parameters publicationid string required format pub_ 0 9a fa f the prefixed id of the publication object request this endpoint expects an object email string required the email address of the subscription reactivate_existing boolean optional defaults to false whether or not to reactivate the subscription if they have already unsubscribed this option should be used only if the subscriber is knowingly resubscribing send_welcome_email boolean optional defaults to false utm_source string optional the source of the subscription utm_medium string optional the medium of the subscription utm_campaign string optional the acquisition campaign of the subscription utm_term string optional the acquisition term typically the keyword or search term utm_content string optional the acquisition content typically used for a b testing or ad variations referring_site string optional the website that the subscriber was referred from referral_code string optional this should be a subscribers referral_code this gives referral credit for the new subscription custom_fields list of objects optional the custom fields must already exist for the publication any new custom fields here will be discarded double_opt_override string optional override the publication s default double opt in settings for this subscription possible values are on the subscriber will receive a double opt in confirmation email and will need to confirm their subscription prior to being marked as active off the subscriber will be marked as active immediately and will not receive a double opt in confirmation email not_set the publication s default double opt in settings will be applied to this subscription tier enum optional the tier for this subscription premium_tiers list of strings optional an array of premium tier names to assign to this subscription when provided the subscription will be assigned to premium tiers matching these names can be combined with premium_tier_ids to include tiers from both duplicates are removed takes precedence over the tier parameter premium_tier_ids list of strings optional an array of premium tier ids to assign to this subscription when provided the subscription will be assigned to these specific premium tiers can be combined with premium_tiers to include tiers from both duplicates are removed takes precedence over the tier parameter stripe_customer_id string optional format cus_ 0 9a za z the stripe customer id for this subscription automation_ids list of strings optional enroll the subscriber into automations after their subscription has been created requires the automations to have an active add by api trigger newsletter_list_ids list of strings optional an array of newsletter list prefixed ids to subscribe the new subscription to the newsletter lists must belong to the same publication beta skip_newsletter_list_auto_subscribe boolean optional when true the subscriber will not be auto subscribed to newsletter lists configured with auto subscribe defaults to false beta complimentary_gift_id string optional format comp_access_ 0 9a fa f the prefixed id of a complimentary access object to apply to this subscription the complimentary access must belong to the same publication response subscription created data object the subscription object errors 400 bad request error 401 unauthorized error 404 not found error 4...