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

ParameterTypeRequiredDescription
publicationIdstringYesId of the publication, from List publications.
emailstringYesEmail address of the subscriber.
reactivate_existingbooleanNotrue subscribes again an email that had unsubscribed. Use it only when the person is knowingly subscribing again.
send_welcome_emailbooleanNotrue sends the welcome email of the publication.
double_opt_overridestringNoon asks for confirmation by email, off activates right away, not_set follows the setting of the publication.Values: on, off, not_set
tierstringNoTier of the subscription.Values: free, premium
premium_tiersarrayNoNames of the premium tiers to assign, as shown in beehiiv. Takes precedence over tier.
utm_sourcestringNoSource of the subscription.
utm_mediumstringNoMedium of the subscription.
utm_campaignstringNoAcquisition campaign of the subscription.
utm_termstringNoAcquisition term, usually the keyword.
utm_contentstringNoAcquisition content, usually the ad or A/B variation.
referring_sitestringNoWebsite the subscriber came from.
referral_codestringNoreferral_code of the subscriber who referred this one, which gives them the referral credit.
custom_fieldsarrayNoValues 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

See all 12 tools

Toolkits in the same category

See all 100 toolkits

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.