beehiiv tools
The 12 beehiiv operations your product runs on your customer's account through Connect. All of them use the same endpoint, POST /api/tools/{tool}/execute.
- 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.
- Create postPOSTCreates a post from HTML and returns its id; only on the Pro and Enterprise plans. status draft, the default, only saves it; confirmed sends and publishes it right away or at scheduled_at. beehiiv builds the post in the background, so Get post can answer 202 for a moment.
- Update postPATCHUpdates 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.
- Delete postDELETEDeletes a draft post for good, or archives a confirmed post.
- Get post aggregate statsGETReturns the statistics added up over the posts of a publication that match the filters: email recipients, deliveries, opens, clicks, rates, unsubscribes and spam reports, web views and clicks, and the most clicked links. For large publications the numbers refresh about once an hour, as computed_at shows.
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.
