Update subscription with the beehiiv API

Updates a subscription. Only the fields sent change. unsubscribe true unsubscribes the person from the publication.

Identifier
beehiiv_update_subscription

The request

POST https://connect.reportei.com/api/tools/beehiiv_update_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>",
    "subscriptionId": "<subscriptionId>"
  }
}

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.
subscriptionIdstringYesId of the subscription, from List subscriptions.
emailstringNoNew email address of the subscriber.
tierstringNoNew tier of the subscription.Values: free, premium
premium_tiersarrayNoNames of the premium tiers to assign, as shown in beehiiv.
unsubscribebooleanNotrue unsubscribes the person from the publication.
custom_fieldsarrayNoCustom field values to change, by field name. delete true removes the value of that field.

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_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.