beehiiv.com

•

API Key

About Beehiiv

Beehiiv is a newsletter platform built by ex-Morning Brew team members, designed for growth-focused creators and media companies. It combines email sending, a no-code website builder, subscriber analytics, paid subscriptions, and the industry's largest native newsletter ad network in one product. Beehiiv takes 0% of paid subscription revenue. It targets solo newsletter operators up to large media brands.

AI Agent Use Cases

- Unlimited email sends on all plans including free

- Native ad network for newsletter monetization

- No-code website builder for creator landing pages

- Paid subscription support with 0% platform revenue cut

- A/B testing, subscriber analytics, and segmentation on paid plans

- AI writing tools and audience surveys on Scale and above

Available Actions

These are the specific actions that AI agents can perform with this tool

Add New Subscriber To Publication

16 inputs

Creates a new email subscription for a specific publication.

Inputs

publicationId

The prefixed ID of the publication to subscribe to (must start with 'pub_').

The subscriber's email address for the new subscription.

reactivate_existing

If true and the email was previously unsubscribed, reactivate the subscription. Use only when the user knowingly resubscribes.

send_welcome_email

If true, sends a welcome email to the new subscriber.

utm_source

UTM source for the subscription attribution.

utm_medium

UTM medium for the subscription attribution.

utm_campaign

UTM campaign for the subscription attribution.

referring_site

The website the subscriber was referred from.

referral_code

An existing subscriber's referral_code to attribute referral credit.

custom_fields

Custom fields to set on the subscriber. The fields must already exist for the publication; unknown fields are discarded.

double_opt_override

Overrides the publication's double opt-in settings for this subscription.

tier

The tier of the subscription. Use 'free' for free tier or 'premium' for paid tier.

premium_tiers

Names of premium tiers to associate with this subscription. Ignored if 'premium_tier_ids' is provided.

premium_tier_ids

IDs of premium tiers to associate with this subscription. Takes precedence over 'premium_tiers' if both are provided.

stripe_customer_id

Stripe customer ID to associate (must start with 'cus_').

automation_ids

Automation IDs to enroll the subscriber into. Each automation must have an active 'Add by API' trigger.

Add Subscriber to Publication

16 inputs

Create a new subscription (subscriber) for a specific publication.

Inputs

publicationId

The prefixed ID of the publication (e.g., pub_...). Used as a path parameter to target the publication to which the subscriber will be added.

The email address for the new subscription.

reactivate_existing

If true and the email previously unsubscribed, reactivate the subscription. Use only when the subscriber knowingly resubscribes.

send_welcome_email

If true, send a welcome email upon subscription.

utm_source

UTM source for acquisition tracking (e.g., newsletter, blog, ads).

utm_medium

UTM medium for acquisition tracking (e.g., email, cpc, social).

utm_campaign

UTM campaign name for acquisition tracking.

referring_site

The website the subscriber was referred from.

referral_code

An existing subscriber's referral_code to attribute referral credit to this new subscription.

custom_fields

Custom fields for the subscriber. The fields must already exist on the publication; unknown fields will be discarded.

double_opt_override

Override the publication's double opt-in settings for this subscription. Use only when appropriate per policy.

tier

The tier for this subscription.

premium_tiers

Names of premium tiers to associate with this subscription. Ignored if premium_tier_ids is provided.

premium_tier_ids

IDs of premium tiers to associate with this subscription. Takes precedence over premium_tiers if both are provided.

stripe_customer_id

Stripe customer ID for this subscription (e.g., cus_XXXX).

automation_ids

Automation IDs to enroll the subscriber into after creation. Each automation must have an active 'Add by API' trigger.

Display Publication Posts

1 input

Retrieve a list of posts for a specific publication.

Inputs

publicationId

The prefixed ID of the publication object. Must start with 'pub_' followed by hex characters and dashes.

Get Subscription Referral Program Data

3 inputs

Retrieves a single subscription for a publication and can include referral details and statistics via expandable fields.

Inputs

publicationId

The prefixed ID of the publication object (e.g., pub_...). Must start with 'pub_' and match the documented pattern.

subscriptionId

The prefixed ID of the subscription object (e.g., sub_...). Must start with 'sub_' and match the documented pattern.

expand

Optional list of expandable objects to include. To retrieve referral program data, include 'referrals' (returns subscriptions referred by this subscription) and/or 'stats' (returns subscription statistics). This maps to the API's expand[] multi-value query parameter, e.g., expand[]=referrals&expand[]=stats.

List Publications For Your Account

5 inputs

Retrieve all publications associated with your API key, with optional sorting, pagination, and expansions.

Inputs

expand

Optional expansions to include extra fields for each publication (e.g., subscription counts, engagement stats). Provide as a list that will be sent as a comma-separated string. Only the documented enum values are allowed.

limit

Maximum number of publications to return per page. Defaults to 10 if not specified.

page

Page number to fetch. If not provided, results 1-10 from page 1 are returned by default.

direction

Sort direction. Defaults to asc (ascending).

order_by

Field to sort by. Defaults to created.

Update Subscription Status

6 inputs

Update a specific subscription within a publication, including tier, unsubscribe flag, Stripe customer ID, and custom fields.

Inputs

publicationId

Prefixed ID of the publication (e.g., pub_...), used as a path parameter.

subscriptionId

Prefixed ID of the subscription (e.g., sub_...), used as a path parameter.

tier

Sets the subscription tier. Only 'free' or 'premium' are accepted.

stripe_customer_id

Stripe Customer ID associated with the subscription (e.g., cus_ABC123). Optional.

unsubscribe

If true, unsubscribes this subscription from the publication.

custom_fields

Array of custom field objects to update. Each object should represent a custom field and its value as configured in your account.

Update Subscription for Publication

6 inputs

Updates a single subscription’s properties (tier, unsubscribe state, Stripe customer ID, and custom fields) for a specific publication.

Inputs

publicationId

The prefixed ID of the publication (must start with 'pub_' and include hex characters and optional hyphens).

subscriptionId

The prefixed ID of the subscription (must start with 'sub_' and include hex characters and optional hyphens).

tier

Sets the tier for the subscription. If omitted, the tier remains unchanged.

stripe_customer_id

Stripe Customer ID associated with the subscription. Must start with 'cus_'. Optional.

unsubscribe

Set to true to unsubscribe this subscription from the publication; false leaves it subscribed. Optional.

custom_fields

Array of custom field objects to update for this subscription. Each object should follow your publication’s custom field schema.