# Add Subscriber — Beehiiv

> Create a new subscriber for a publication. Use List Custom Fields to discover available custom field names before passing customFields. Use Get Publication Info to get the publication ID. Set reactivateExisting: true to re-subscribe…

- Key: `beehiiv-add-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/add-subscriber
- Hints: open-world
- Source: https://github.com/PipedreamHQ/pipedream/blob/master/components/beehiiv/actions/add-subscriber/add-subscriber.ts

## Description

Create a new subscriber for a publication. Use **List Custom Fields** to discover available custom field names before passing `customFields`. Use **Get Publication Info** to get the publication ID. Set `reactivateExisting: true` to re-subscribe someone who previously unsubscribed. [See the documentation](https://developers.beehiiv.com/api-reference/subscriptions/create)

## Props

| Prop | Type | Required | Description |
|---|---|---|---|
| `publicationId` | `string` | Yes | The publication ID. Use Get Publication Info to find this. |
| `email` | `string` | Yes | The email address of the new subscriber. |
| `reactivateExisting` | `boolean` | No | Whether to reactivate the subscriber if they previously unsubscribed. Only use if the subscriber is knowingly resubscribing. Default: false. |
| `sendWelcomeEmail` | `boolean` | No | Whether to send a welcome email. Default: false. |
| `utmSource` | `string` | No | The source of the subscriber. |
| `utmMedium` | `string` | No | The medium of the subscriber acquisition. |
| `utmChannel` | `string` | No | The channel of the subscriber acquisition. |
| `referringSite` | `string` | No | The URL that referred the subscriber. |
| `customFields` | `string` | No | JSON array of custom field name-value pairs. Example: [{"name": "role", "value": "Engineer"}]. Use List Custom Fields to discover available field names. |
| `tier` | `string` | No | Subscription tier. free for free tier, or the premium tier name. |

## 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-add-subscriber",
  arguments: {
    publicationId: "Publication ID",
    email: "Email",
  },
})
```

**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-add-subscriber",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    beehiiv: { authProvisionId: "apn_xxxxxxx" },
    publicationId: "Publication ID",
    email: "Email",
  },
})

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-add-subscriber",
    "configured_props": {
      "beehiiv": { "authProvisionId": "apn_xxxxxxx" },
      "publicationId": "Publication ID",
      "email": "Email"
    }
  }'
```

---

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