# Update Subscriber — Beehiiv

> 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…

- Key: `beehiiv-update-subscriber`
- Type: Action (Write)
- Version: 0.0.2
- App: Beehiiv (`beehiiv`) — https://pipedream.com/apps/beehiiv.md
- This page (HTML): https://pipedream.com/apps/beehiiv/actions/update-subscriber
- Hints: open-world
- Source: https://github.com/PipedreamHQ/pipedream/blob/master/components/beehiiv/actions/update-subscriber/update-subscriber.ts

## Description

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](https://developers.beehiiv.com/api-reference/subscriptions/put)

## Props

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

## Run it

**MCP**

```ts
import { Client } from "@modelcontextprotocol/sdk/client/index.js"
import { StreamableHTTPClientTransport } from "@modelcontextprotocol/sdk/client/streamableHttp.js"
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 accessToken = await pd.rawAccessToken

const transport = new StreamableHTTPClientTransport(
  new URL("https://remote.mcp.pipedream.net/v3"),
  {
    requestInit: {
      headers: {
        Authorization: `Bearer ${accessToken}`,
        "x-pd-project-id": process.env.PIPEDREAM_PROJECT_ID!,
        "x-pd-environment": "production",
        "x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
        "x-pd-app-slug": "beehiiv",
      },
    },
  },
)

const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)

const { tools } = await mcp.listTools()

// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
  name: "beehiiv-update-subscriber",
  arguments: {
    publicationId: "Publication ID",
    subscriptionId: "Subscription ID",
  },
})
```

**TypeScript**

```ts
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)
```

**cURL**

```bash
curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
  -H "Content-Type: application/json" \
  -H "X-PD-Environment: production" \
  -H "Authorization: Bearer {access_token}" \
  -d '{
    "external_user_id": "{external_user_id}",
    "id": "beehiiv-update-subscriber",
    "configured_props": {
      "beehiiv": { "authProvisionId": "apn_xxxxxxx" },
      "publicationId": "Publication ID",
      "subscriptionId": "Subscription ID"
    }
  }'
```

---

- App: https://pipedream.com/apps/beehiiv.md · All apps: https://pipedream.com/apps