Update post with the beehiiv API
Updates a post; only on the Pro and Enterprise plans. Only the fields sent change, and body_content replaces the whole content. scheduled_at cannot change after the post was sent.
- Identifier
- beehiiv_update_post
The request
POST https://connect.reportei.com/api/tools/beehiiv_update_post/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"publicationId": "<publicationId>",
"postId": "<postId>"
}
}Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| publicationId | string | Yes | Id of the publication, from List publications. |
| postId | string | Yes | Id of the post, from List posts or Create post. |
| title | string | No | Title of the post. |
| subtitle | string | No | Subtitle of the post. |
| body_content | string | No | New content as raw HTML, replacing the current one. beehiiv removes style and link tags, so style the elements with inline style attributes. |
| status | string | No | confirmed sends and publishes the post right away, or at scheduled_at.Values: draft, confirmed |
| scheduled_at | string | No | When to publish, for example 2026-11-05T12:00:00Z. |
| thumbnail_image_url | string | No | URL of the thumbnail image. |
| content_tags | array | No | Content tags of the post. |
| recipients | object | No | Who gets it on each channel, with tier_ids free, premium or all. Leave a channel out to skip it. |
| email_settings | object | No | Email options: email_subject_line, email_preview_text, reply_to_address (a verified reply-to address of the publication) and whether the title, subtitle and byline show in the email. |
| web_settings | object | No | Web options: the slug of the post URL, hide_from_feed, and whether the title, subtitle and thumbnail show on the web. |
| seo_settings | object | No | Search and social metadata of the web version. |
| social_share | string | No | Social share buttons of the post.Values: comments_and_likes_only, with_comments_and_likes, top, none |
| email_capture_type_override | string | No | How the web version asks visitors for their email.Values: none, gated, popup |
| custom_link_tracking_enabled | boolean | No | true turns on custom link tracking. |
| utm_params_enabled | boolean | No | Whether UTM parameters go on the links. |
| utm_source | string | No | utm_source of the links. |
| utm_medium | string | No | utm_medium of the links. |
| utm_campaign | string | No | utm_campaign of the links. |
Supported connections
Your customer connects their beehiiv account once, with one of the modes below. The same connection serves every tool of the toolkit.
API key
Your customer pastes the app's key on a Connect screen, or your system sends the key with POST /api/customer-toolkits, with no screen.
The response
On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.
Ready for AI agents
This tool's input is a JSON Schema, available at GET /api/tools/beehiiv_update_post. It becomes your agent's tool definition with no conversion.
Other beehiiv tools
- List publicationsGETLists the publications the API key reaches, with id, name and organization_name. expand stats adds active subscriptions, average open and click rates and totals sent. Page with page and limit, up to 100; the response has total_pages.
- List subscriptionsGETLists the subscriptions (subscribers) of a publication, optionally only one email, status or tier. Page with limit, up to 100, and cursor: the response has has_more and next_cursor.
- Get subscriptionGETReturns one subscription with email, status, created, subscription_tier, the utm fields and referral_code.
- Create subscriptionPOSTSubscribes an email to a publication and returns the subscription with its id. With double opt-in on the publication, or double_opt_override on, the person confirms by email before becoming active.
- Update subscriptionPATCHUpdates a subscription. Only the fields sent change. unsubscribe true unsubscribes the person from the publication.
- Create subscription tagPOSTAdds tags to a subscription. A tag that does not exist in the publication yet is created.
- List postsGETLists the posts of a publication with id, title, subtitle, status, publish_date and web_url. expand stats adds the email and web statistics of each post. Page with page and limit, up to 100; the response has total_pages.
- Get postGETReturns one post; expand stats adds its email and web statistics. A post created moments ago can answer 202 while beehiiv builds it, and 404 with POST_CREATION_FAILED when the creation failed.
Toolkits in the same category
See all 100 toolkitsSee Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
