View as Markdown
Beehiiv icon

Beehiiv ACTION

Update Subscriber

Update an existing subscriber's fields or unsubscribe them. Use Search Subscribers or Get Subscriber to find the subscription ID first. Use List Custom Fields to discover available custom field names. Set unsubscribe: true to unsubscribe the subscriber. Use Get Publication Info to get the publication ID. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Beehiiv account once, then configure and run Update Subscriber from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "beehiiv-update-subscriber",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    beehiiv: { authProvisionId: "apn_xxxxxxx" },
    publicationId: "Publication ID",
    subscriptionId: "Subscription ID",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Update Subscriber inputs
Property Type Description
publicationId Publication ID string
The publication ID. Use Get Publication Info to find this.
Required
subscriptionId Subscription ID string
The subscriber's subscription ID. Use Search Subscribers or Get Subscriber to find this.
Required
unsubscribe Unsubscribe boolean
Set to true to unsubscribe this subscriber.
Optional
customFields Custom Fields string
JSON array of custom field name-value pairs to update. Example: [{"name": "role", "value": "Manager"}]. Use List Custom Fields to discover available field names.
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
beehiiv-update-subscriber
Version
0.0.2
App
Beehiiv
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes