Meta tags:
description= Note title= Currently in beta icon= b ;
Headings (most frequently used words):
posts, oauth, scope, update, post, write, authentication, path, parameters, request, response, errors, list, read, currently, in, beta,
Text of the page (most frequently used words):
badge (200), intent (100), minimal (100), outlined (100), oauth (90), scope (89), info (87), the (66), post (54), read (48), list (45), write (39), subscription (37), get (32), posts (29), #update (25), subscriptions (25), optional (20), create (19), for (19), this (19), beta (19), newsletter (19), content (15), updated (15), provided (14), warning (14), and (12), 0000 (12), with (11), custom (11), api (11), existing (10), object (10), email (10), publications (10), newsletter_lists (10), fields (9), use (9), title (9), webhooks (9), only (8), token (8), tier (8), segments (8), blocks (7), publication (7), will (7), enterprise (7), string (7), confirmed (7), beehiiv (7), delete (7), tiers (7), automations (7), endpoint (6), request (6), all (6), send (6), page (6), error (6), data (6), authors (6), subtitle (6), https (6), com (6), segment (6), custom_fields (6), automation (6), html (5), when (5), null (5), show (5), values (5), cannot (5), status (5), polls (5), field (5), not (4), both (4), methods (4), body_content (4), currently (4), subject (4), prefixed (4), properties (4), strings (4), headers (4), tags (4), draft (4), allowed (4), enum (4), bearer (4), 000000000000 (4), false (4), patch (4), identify (4), webhook (4), deletion (4), unchanged (3), using (3), available (3), users (3), updates (3), replaces (3), guest (3), level (3), within (3), type (3), date (3), that (3), replace (3), note (3), created (3), postid (3), publicationid (3), post_00000000 (3), data_deletion (3), condition (3), complimentary (3), access (3), bulk (3), resumed (3), paused (3), provide (2), either (2), neither (2), preserved (2), same (2), css (2), guardrails (2), described (2), apply (2), here (2), specific (2), body (2), other (2), remain (2), detailed (2), walkthrough (2), working (2), see (2), guide (2), feature (2), change (2), inquire (2), about (2), pricing (2), please (2), visit (2), our (2), requests (2), response (2), associate (2), association (2), newsletter_list_id (2), recipients (2), web (2), audience (2), targets (2), are (2), ids (2), time (2), from (2), content_tags (2), transition (2), publish (2), defaults (2), settings (2), email_settings (2), url (2), image (2), none (2), scheduled_at (2), datetime (2), link (2), sent (2), block (2), together (2), how (2), interact (2), content_merge_strategy (2), append (2), append_to_template (2), template (2), format (2), required (2), authentication (2), authorization (2), href (2), www (2), preview (2), line (2), fixed (2), typo (2), curl (2), reference (2), demo (2), start (2), trial (2), login (2), add (2), referral (2), program (2), templates (2), test (2), aggregate (2), stats (2), poll (2), lists (2), engagements (2), condition_sets (2), sets (2), complimentary_access (2), journeys (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), search (2), documentation (2), index (2), llms (2), txt (2), any (2), built, next, previous, yes, was, helpful, internal, server, 500, too, many, 429, found, 404, forbidden, 403, unauthorized, 401, bad, 400, errors, pass, remove, specified, omitted, must, belong, guest_author_ids, merges, system, managed, unsubscribe, smtpapi, overridden, map, schedule, supported, moved, back, seo, metadata, seo_settings, web_settings, thumbnail, thumbnail_image_url, top, with_comments_and_likes, comments_and_likes_only, social, share, social_share, display, overrides, shown, does, affect, actual, override_scheduled_at, popup, gated, capture, email_capture_type_override, true, tracking, enabled, boolean, custom_link_tracking_enabled, which, published, after, has, already, been, raw, current, wrapped, internally, removed, during, sanitization, inline, styles, visual, styling, style, htmlsnippet, variants, structured, these, depends, default, full, replacement, supports, types, such, paragraph, heading, button, table, columns, more, objects, prepend, controls, preserve, header, updating, were, expects, post_, pub_, path, parameters, form, where, your, auth, icon, support, article, 36759164012439, meta_default_title, meta_default_description, app, preview_url, displayed_date, 1710300060, publish_date, email_capture_popup, enforce_gated_content, hidden_from_feed, platform, example, web_url, thumbnail_url, slug, text, preview_text, subject_line, split_tested, 1710300000, john, doe, 200, try, email_subject_line, application, json, pub_00000000, copy, light, workspace, tag, subscriber, subscribers, recalculate, referral_program, responses, user, set, emails, journey, author, introspect, revoke, authorize, submitted, added, downgraded, upgraded, scheduled, unsubscribed, subscribed, workspaces, del, tokens, authorizations, welcome, ask, agents, root, markdown, version, developer,
Text of the page (random words):
subscriptions bulk subscription updates complimentary access condition sets custom fields data deletion engagements newsletter lists newsletter list subscriptions oauth users polls posts post create post badge intent info minimal outlined oauth scope posts write badge patch update post badge intent info minimal outlined oauth scope posts write badge get list posts badge intent info minimal outlined oauth scope posts read badge get get aggregate stats badge intent info minimal outlined oauth scope posts read badge get get post badge intent info minimal outlined oauth scope posts read badge del delete post badge intent info minimal outlined oauth scope posts write badge post send test email badge intent info minimal outlined oauth scope posts badge 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 api reference posts update post oauth scope posts write copy page patch https api beehiiv com v2 publications publicationid posts postid patch v2 publications publicationid posts postid curl curl x patch https api beehiiv com v2 publications pub_00000000 0000 0000 0000 000000000000 posts post_00000000 0000 0000 0000 000000000000 h authorization bearer token h content type application json d title updated post title subtitle fixed a typo in the subtitle email_settings email_subject_line updated subject line try it 200 updated 1 2 data 3 id post_00000000 0000 0000 0000 000000000000 4 subtitle fixed a typo in the subtitle 5 title updated post title 6 authors 7 john doe 8 9 created 1710300000 10 status confirmed 11 split_tested false 12 subject_line updated subject line 13 preview_text preview text 14 slug updated post title 15 thumbnail_url 16 web_url https example beehiiv com p updated post title 17 audience both 18 platform both 19 content_tags 20 hidden_from_feed false 21 enforce_gated_content false 22 email_capture_popup false 23 publish_date 1710300060 24 displayed_date null 25 preview_url https app beehiiv com posts post_00000000 0000 0000 0000 000000000000 preview 26 meta_default_description null 27 meta_default_title null 28 newsletter_list_id null 29 30 note title currently in beta icon b this feature is currently in beta the api is subject to change and available only to enterprise users br br to inquire about enterprise pricing please visit our a href https www beehiiv com enterprise enterprise page a note update an existing post for a specific publication only the fields provided in the request body will be updated all other fields remain unchanged for a detailed walkthrough of content methods and working with custom html see the a href https www beehiiv com support article 36759164012439 using the send api and create post endpoint using the send api and create post endpoint a guide to update post content provide either blocks or body_content not both if neither is provided the existing content is preserved the same content methods and css guardrails described in the create endpoint apply here 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 postid string required format post_ 0 9a fa f the prefixed id of the post to update request this endpoint expects an object content_merge_strategy enum optional controls how provided blocks interact with the post s existing content defaults to replace use append_to_template to preserve template header blocks when updating posts that were created from a template allowed values replace append_to_template append prepend blocks list of objects optional the structured content blocks for the post how these interact with existing content depends on content_merge_strategy default full replacement supports block types such as paragraph image heading button html table list columns and more cannot be provided together with body_content show 17 variants body_content string optional raw html to replace the post s current content the html is wrapped in an htmlsnippet block internally note that style and link tags are removed during sanitization use inline styles for all visual styling cannot be provided together with blocks title string optional the title of the post subtitle string optional the subtitle of the post scheduled_at datetime optional the time at which the post will be published cannot be updated after the post has already been sent custom_link_tracking_enabled boolean optional if true custom link tracking will be enabled for this post email_capture_type_override enum optional the email capture type to use for this post allowed values none gated popup override_scheduled_at datetime optional a display date that overrides the scheduled_at date shown in the email does not affect the actual publish date social_share enum optional the social share type to use for this post allowed values comments_and_likes_only with_comments_and_likes top none thumbnail_image_url string optional the url of the thumbnail image to use for the post email_settings object optional the email settings to use for this post only the provided fields within this object will be updated show 9 properties web_settings object optional the web settings to use for this post only the provided fields within this object will be updated show 5 properties seo_settings object optional the seo metadata to use for this post only the provided fields within this object will be updated show 6 properties status enum optional defaults to confirmed transition the post s status use confirmed to schedule or publish a draft post only the draft confirmed transition is supported a confirmed post cannot be moved back to draft allowed values draft confirmed content_tags list of strings optional the content tags for this post when provided this replaces all existing content tags on the post headers map from strings to strings optional custom email headers for this post merges with publication level headers at send time system managed headers e g list unsubscribe x smtpapi cannot be overridden guest_author_ids list of strings optional the prefixed ids of the guest authors to associate with this post guest authors must belong to the publication when provided replaces all existing guest authors on the post recipients object o...
|
