Create subscription with the beehiiv API
Subscribes 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.
- Identifier
- beehiiv_create_subscription
The request
POST https://connect.reportei.com/api/tools/beehiiv_create_subscription/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"publicationId": "<publicationId>",
"email": "<email>"
}
}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. |
| string | Yes | Email address of the subscriber. | |
| reactivate_existing | boolean | No | true subscribes again an email that had unsubscribed. Use it only when the person is knowingly subscribing again. |
| send_welcome_email | boolean | No | true sends the welcome email of the publication. |
| double_opt_override | string | No | on asks for confirmation by email, off activates right away, not_set follows the setting of the publication.Values: on, off, not_set |
| tier | string | No | Tier of the subscription.Values: free, premium |
| premium_tiers | array | No | Names of the premium tiers to assign, as shown in beehiiv. Takes precedence over tier. |
| utm_source | string | No | Source of the subscription. |
| utm_medium | string | No | Medium of the subscription. |
| utm_campaign | string | No | Acquisition campaign of the subscription. |
| utm_term | string | No | Acquisition term, usually the keyword. |
| utm_content | string | No | Acquisition content, usually the ad or A/B variation. |
| referring_site | string | No | Website the subscriber came from. |
| referral_code | string | No | referral_code of the subscriber who referred this one, which gives them the referral credit. |
| custom_fields | array | No | Values of custom fields that already exist in the publication, by field name. Unknown names are discarded. |
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_create_subscription. 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.
- 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.
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.
