Beehiiv MCP Server

Overview Schema Source Related Servers Discussions Admin

Bulk create subscription

create_bulk_subscription

Destructive

Bulk-create Beehiiv subscriptions for a publication with emails plus optional tier, UTM, custom fields, and automations. Requires confirm=true and subscriptions:write for OAuth.

Instructions

Bulk create subscription. Changes account state and requires confirm=true for the user-requested action. OAuth integrations require subscriptions:write.

Input Schema

TableJSON Schema

Name	Required	Description
`account`	No	Named private account from BEEHIIV_ACCOUNTS. Defaults to BEEHIIV_DEFAULT_ACCOUNT or the first configured account.
`confirm`	No	Set true only when the user asked for exactly this action.
`payload`	No	Complete JSON body instead of individual body flags. Supports nullable fields and nested bulk structures. Cannot be combined with body flags or payload_file.
`payload_file`	No	Local JSON request body file, at most 5 MB. Contents are validated before the API call and are never logged.
`subscriptions`	No
`publication_id`	Yes	The prefixed ID of the publication object

Schema Changelog

Changes observed during successful MCP inspections.

Changed8 schema fields changedv3.0.1Oct 7, 2026

addedInput schema / $defs

Added value: +{
+  "subscriptions": {
+    "items": {
+      "additionalProperties": false,
+      "properties": {
+        "automation_ids": {
+          "description": "Enroll the subscriber into automations after their subscription has been created. Requires the automations to have an active *Add by API* trigger.",
+          "items": {
+            "type": "string"
+          },
+          "type": "array"
+        },
+        "complimentary_gift_id": {
+          "description": "The prefixed ID of a complimentary access object to apply to this subscription. The complimentary access must belong to the same publication.",
+          "pattern": "^(comp_access_[0-9a-fA-F\\-]+)$",
+          "title": "ComplimentaryAccessId",
+          "type": "string"
+        },
+        "custom_fields": {
+          "description": "The custom fields must already exist for the publication. Any new custom fields here will be discarded.",
+          "items": {
+            "additionalProperties": false,
+            "description": "The object required for setting custom field values on a subscription",
+            "properties": {
+              "name": {
+                "description": "The name of the existing custom field",
+                "type": "string"
+              },
+              "value": {
+                "description": "The value stored for the subscription",
+                "oneOf": [
+                  {
+                    "type": "string"
+                  },
+                  {
+                    "format": "double",
+                    "type": "number"
+                  },
+                  {
+                    "type": "boolean"
+                  },
+                  {
+                    "items": {
+                      "type": "string"
+                    },
+                    "type": "array"
+                  }
+                ],
+                "title": "CustomFieldDataType"
+              }
+            },
+            "title": "CustomFieldValue",
+            "type": "object"
+          },
+          "type": "array"
+        },
+        "double_opt_override": {
+          "description": "Override the publication's default double opt-in settings for this subscription. Possible values are: - \"on\" : The subscriber will receive a double opt-in confirmation email and will need to confirm their subscription prior to being marked as active. - \"off\" : The subscriber will be marked as active immediately and will not receive a double opt-in confirmation email. - \"not_set\" : The publication's default double opt-in settings will be applied to this subscription.",
+          "title": "DoubleOptOverride",
+          "type": "string"
+        },
+        "email": {
+          "description": "The email address of the subscription.",
+          "type": "string"
+        },
+        "newsletter_list_ids": {
+          "description": "An array of newsletter list prefixed IDs to subscribe the new subscription to. The newsletter lists must belong to the same publication.",
+          "items": {
+            "type": "string"
+          },
+          "type": "array"
+        },
+        "premium_tier_ids": {
+          "description": "An array of premium tier IDs to assign to this subscription. When provided, the subscription will be assigned to these specific premium tiers. Can be combined with `premium_tiers` to include tiers from both (duplicates are removed). Takes precedence over the `tier` parameter.",
+          "items": {
+            "type": "string"
+          },
+          "type": "array"
+        },
+        "premium_tiers": {
+          "description": "An array of premium tier names to assign to this subscription. When provided, the subscription will be assigned to premium tiers matching these names. Can be combined with `premium_tier_ids` to include tiers from both (duplicates are removed). Takes precedence over the `tier` parameter.",
+          "items": {
+            "type": "string"
+          },
+          "type": "array"
+        },
+        "reactivate_existing": {
+          "default": false,
+          "description": "Whether or not to reactivate the subscription if they have already unsubscribed. This option should be used only if the subscriber is knowingly resubscribing.",
+          "type": "boolean"
+        },
+        "referral_code": {
+          "description": "This should be a subscribers referral_code. This gives referral credit for the new subscription.",
+          "type": "string"
+        },
+        "referring_site": {
+          "description": "The website that the subscriber was referred from",
+          "type": "string"
+        },
+        "send_welcome_email": {
+          "default": false,
+          "type": "boolean"
+        },
+        "skip_newsletter_list_auto_subscribe": {
+          "description": "When true, the subscriber will not be auto-subscribed to newsletter lists configured with auto-subscribe. Defaults to false.",
+          "type": "boolean"
+        },
+        "stripe_customer_id": {
+          "description": "The Stripe customer ID for this subscription.",
+          "pattern": "^(cus_[0-9a-zA-Z]+)?$",
+          "title": "OptionalStripeCustomerId",
+          "type": "string"
+        },
+        "tier": {
+          "description": "The tier for this subscription.",
+          "enum": [
+            "free",
+            "premium"
+          ],
+          "title": "SubscriptionsCreateRequestTier",
+          "type": "string"
+        },
+        "utm_campaign": {
+          "description": "The acquisition campaign of the subscription",
+          "type": "string"
+        },
+        "utm_content": {
+          "description": "The acquisition content; typically used for A/B testing or ad variations",
+          "type": "string"
+        },
+        "utm_medium": {
+          "description": "The medium of the subscription",
+          "type": "string"
+        },
+        "utm_source": {
+          "description": "The source of the subscription.",
+          "type": "string"
+        },
+        "utm_term": {
+          "description": "The acquisition term; typically the keyword or search term",
+          "type": "string"
+        }
+      },
+      "required": [
+        "email"
+      ],
+      "title": "SubscriptionRequest",
+      "type": "object"
+    },
+    "type": "array"
+  }
+}

changedInput schema / properties / confirm / description

Previous value: -"Must be true for every account mutation. Confirms only the user-requested action."New value: +"Set true only when the user asked for exactly this action."

addedInput schema / properties / payload / properties / subscriptions / $ref
```
Added value: +"#/$defs/subscriptions"
```

removedInput schema / properties / payload / properties / subscriptions / items

Removed value: -{
-  "additionalProperties": false,
-  "properties": {
-    "automation_ids": {
-      "description": "Enroll the subscriber into automations after their subscription has been created. Requires the automations to have an active *Add by API* trigger.",
-      "items": {
-        "type": "string"
-      },
-      "type": "array"
-    },
-    "complimentary_gift_id": {
-      "description": "The prefixed ID of a complimentary access object to apply to this subscription. The complimentary access must belong to the same publication.",
-      "pattern": "^(comp_access_[0-9a-fA-F\\-]+)$",
-      "title": "ComplimentaryAccessId",
-      "type": "string"
-    },
-    "custom_fields": {
-      "description": "The custom fields must already exist for the publication. Any new custom fields here will be discarded.",
-      "items": {
-        "additionalProperties": false,
-        "description": "The object required for setting custom field values on a subscription",
-        "properties": {
-          "name": {
-            "description": "The name of the existing custom field",
-            "type": "string"
-          },
-          "value": {
-            "description": "The value stored for the subscription",
-            "oneOf": [
-              {
-                "type": "string"
-              },
-              {
-                "format": "double",
-                "type": "number"
-              },
-              {
-                "type": "boolean"
-              },
-              {
-                "items": {
-                  "type": "string"
-                },
-                "type": "array"
-              }
-            ],
-            "title": "CustomFieldDataType"
-          }
-        },
-        "title": "CustomFieldValue",
-        "type": "object"
-      },
-      "type": "array"
-    },
-    "double_opt_override": {
-      "description": "Override the publication's default double opt-in settings for this subscription. Possible values are: - \"on\" : The subscriber will receive a double opt-in confirmation email and will need to confirm their subscription prior to being marked as active. - \"off\" : The subscriber will be marked as active immediately and will not receive a double opt-in confirmation email. - \"not_set\" : The publication's default double opt-in settings will be applied to this subscription.",
-      "title": "DoubleOptOverride",
-      "type": "string"
-    },
-    "email": {
-      "description": "The email address of the subscription.",
-      "type": "string"
-    },
-    "newsletter_list_ids": {
-      "description": "An array of newsletter list prefixed IDs to subscribe the new subscription to. The newsletter lists must belong to the same publication.",
-      "items": {
-        "type": "string"
-      },
-      "type": "array"
-    },
-    "premium_tier_ids": {
-      "description": "An array of premium tier IDs to assign to this subscription. When provided, the subscription will be assigned to these specific premium tiers. Can be combined with `premium_tiers` to include tiers from both (duplicates are removed). Takes precedence over the `tier` parameter.",
-      "items": {
-        "type": "string"
-      },
-      "type": "array"
-    },
-    "premium_tiers": {
-      "description": "An array of premium tier names to assign to this subscription. When provided, the subscription will be assigned to premium tiers matching these names. Can be combined with `premium_tier_ids` to include tiers from both (duplicates are removed). Takes precedence over the `tier` parameter.",
-      "items": {
-        "type": "string"
-      },
-      "type": "array"
-    },
-    "reactivate_existing": {
-      "default": false,
-      "description": "Whether or not to reactivate the subscription if they have already unsubscribed. This option should be used only if the subscriber is knowingly resubscribing.",
-      "type": "boolean"
-    },
-    "referral_code": {
-      "description": "This should be a subscribers referral_code. This gives referral credit for the new subscription.",
-      "type": "string"
-    },
-    "referring_site": {
-      "description": "The website that the subscriber was referred from",
-      "type": "string"
-    },
-    "send_welcome_email": {
-      "default": false,
-      "type": "boolean"
-    },
-    "skip_newsletter_list_auto_subscribe": {
-      "description": "When true, the subscriber will not be auto-subscribed to newsletter lists configured with auto-subscribe. Defaults to false.",
-      "type": "boolean"
-    },
-    "stripe_customer_id": {
-      "description": "The Stripe customer ID for this subscription.",
-      "pattern": "^(cus_[0-9a-zA-Z]+)?$",
-      "title": "OptionalStripeCustomerId",
-      "type": "string"
-    },
-    "tier": {
-      "description": "The tier for this subscription.",
-      "enum": [
-        "free",
-        "premium"
-      ],
-      "title": "SubscriptionsCreateRequestTier",
-      "type": "string"
-    },
-    "utm_campaign": {
-      "description": "The acquisition campaign of the subscription",
-      "type": "string"
-    },
-    "utm_content": {
-      "description": "The acquisition content; typically used for A/B testing or ad variations",
-      "type": "string"
-    },
-    "utm_medium": {
-      "description": "The medium of the subscription",
-      "type": "string"
-    },
-    "utm_source": {
-      "description": "The source of the subscription.",
-      "type": "string"
-    },
-    "utm_term": {
-      "description": "The acquisition term; typically the keyword or search term",
-      "type": "string"
-    }
-  },
-  "required": [
-    "email"
-  ],
-  "title": "SubscriptionRequest",
-  "type": "object"
-}

removedInput schema / properties / payload / properties / subscriptions / type
```
Removed value: -"array"
```
addedInput schema / properties / subscriptions / $ref
```
Added value: +"#/$defs/subscriptions"
```

removedInput schema / properties / subscriptions / items

Removed value: -{
-  "additionalProperties": false,
-  "properties": {
-    "automation_ids": {
-      "description": "Enroll the subscriber into automations after their subscription has been created. Requires the automations to have an active *Add by API* trigger.",
-      "items": {
-        "type": "string"
-      },
-      "type": "array"
-    },
-    "complimentary_gift_id": {
-      "description": "The prefixed ID of a complimentary access object to apply to this subscription. The complimentary access must belong to the same publication.",
-      "pattern": "^(comp_access_[0-9a-fA-F\\-]+)$",
-      "title": "ComplimentaryAccessId",
-      "type": "string"
-    },
-    "custom_fields": {
-      "description": "The custom fields must already exist for the publication. Any new custom fields here will be discarded.",
-      "items": {
-        "additionalProperties": false,
-        "description": "The object required for setting custom field values on a subscription",
-        "properties": {
-          "name": {
-            "description": "The name of the existing custom field",
-            "type": "string"
-          },
-          "value": {
-            "description": "The value stored for the subscription",
-            "oneOf": [
-              {
-                "type": "string"
-              },
-              {
-                "format": "double",
-                "type": "number"
-              },
-              {
-                "type": "boolean"
-              },
-              {
-                "items": {
-                  "type": "string"
-                },
-                "type": "array"
-              }
-            ],
-            "title": "CustomFieldDataType"
-          }
-        },
-        "title": "CustomFieldValue",
-        "type": "object"
-      },
-      "type": "array"
-    },
-    "double_opt_override": {
-      "description": "Override the publication's default double opt-in settings for this subscription. Possible values are: - \"on\" : The subscriber will receive a double opt-in confirmation email and will need to confirm their subscription prior to being marked as active. - \"off\" : The subscriber will be marked as active immediately and will not receive a double opt-in confirmation email. - \"not_set\" : The publication's default double opt-in settings will be applied to this subscription.",
-      "title": "DoubleOptOverride",
-      "type": "string"
-    },
-    "email": {
-      "description": "The email address of the subscription.",
-      "type": "string"
-    },
-    "newsletter_list_ids": {
-      "description": "An array of newsletter list prefixed IDs to subscribe the new subscription to. The newsletter lists must belong to the same publication.",
-      "items": {
-        "type": "string"
-      },
-      "type": "array"
-    },
-    "premium_tier_ids": {
-      "description": "An array of premium tier IDs to assign to this subscription. When provided, the subscription will be assigned to these specific premium tiers. Can be combined with `premium_tiers` to include tiers from both (duplicates are removed). Takes precedence over the `tier` parameter.",
-      "items": {
-        "type": "string"
-      },
-      "type": "array"
-    },
-    "premium_tiers": {
-      "description": "An array of premium tier names to assign to this subscription. When provided, the subscription will be assigned to premium tiers matching these names. Can be combined with `premium_tier_ids` to include tiers from both (duplicates are removed). Takes precedence over the `tier` parameter.",
-      "items": {
-        "type": "string"
-      },
-      "type": "array"
-    },
-    "reactivate_existing": {
-      "default": false,
-      "description": "Whether or not to reactivate the subscription if they have already unsubscribed. This option should be used only if the subscriber is knowingly resubscribing.",
-      "type": "boolean"
-    },
-    "referral_code": {
-      "description": "This should be a subscribers referral_code. This gives referral credit for the new subscription.",
-      "type": "string"
-    },
-    "referring_site": {
-      "description": "The website that the subscriber was referred from",
-      "type": "string"
-    },
-    "send_welcome_email": {
-      "default": false,
-      "type": "boolean"
-    },
-    "skip_newsletter_list_auto_subscribe": {
-      "description": "When true, the subscriber will not be auto-subscribed to newsletter lists configured with auto-subscribe. Defaults to false.",
-      "type": "boolean"
-    },
-    "stripe_customer_id": {
-      "description": "The Stripe customer ID for this subscription.",
-      "pattern": "^(cus_[0-9a-zA-Z]+)?$",
-      "title": "OptionalStripeCustomerId",
-      "type": "string"
-    },
-    "tier": {
-      "description": "The tier for this subscription.",
-      "enum": [
-        "free",
-        "premium"
-      ],
-      "title": "SubscriptionsCreateRequestTier",
-      "type": "string"
-    },
-    "utm_campaign": {
-      "description": "The acquisition campaign of the subscription",
-      "type": "string"
-    },
-    "utm_content": {
-      "description": "The acquisition content; typically used for A/B testing or ad variations",
-      "type": "string"
-    },
-    "utm_medium": {
-      "description": "The medium of the subscription",
-      "type": "string"
-    },
-    "utm_source": {
-      "description": "The source of the subscription.",
-      "type": "string"
-    },
-    "utm_term": {
-      "description": "The acquisition term; typically the keyword or search term",
-      "type": "string"
-    }
-  },
-  "required": [
-    "email"
-  ],
-  "title": "SubscriptionRequest",
-  "type": "object"
-}

removedInput schema / properties / subscriptions / type
```
Removed value: -"array"
```

First observedv2.0.0Oct 3, 2026

TDQS

B3.1/5.0

Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare destructiveHint=true, idempotentHint=false, and openWorldHint=true, so the mutation risk is covered. The description usefully adds two things annotations cannot express: the confirm=true gate tied to explicit user intent, and the subscriptions:write OAuth requirement. It still omits partial-batch failure behavior, but the added context is substantive.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Three short sentences with no filler, and the confirm/auth constraints are front-loaded. The leading sentence is wasted on a title restatement, but the overall entry is tight and readable.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a destructive bulk mutation with 6 parameters, nested objects, and no output schema, the description omits what matters most: whether a partially invalid batch fails atomically or partially, what the response contains, and any batch-size limits. The confirm and auth notes partially compensate, but the gaps are meaningful.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 83% and the nested SubscriptionRequest is thoroughly documented, so the schema carries the parameter semantics. The description only elaborates on one parameter (confirm) and says nothing about payload vs payload_file vs body flags, which the schema itself already explains. Baseline 3 is appropriate.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose2/5

Does the description clearly state what the tool does and how it differs from similar tools?

The first sentence, "Bulk create subscription," only restates the tool name and title without adding scope, verb detail, or differentiation. It does not contrast with the sibling create_subscription or explain what 'bulk' means (batch size, per-item failure handling). An agent learns nothing from this beyond the name.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It gives one real condition: the tool changes account state and requires confirm=true for the user-requested action, plus an OAuth scope requirement. However, it offers no routing guidance versus create_subscription (single) or the bulk_subscription_updates family, which are the obvious alternatives an agent would weigh.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Bulk create subscription

Instructions

Input Schema

Schema Changelog

TDQS

Other Tools