Skip to main content
Glama
thenavidm

Beehiiv MCP Server

by thenavidm
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Local

Update subscriptions

update_bulk_subscription_update
Destructive

Update up to 1,000 Beehiiv subscriptions in bulk: change tier, unsubscribe status, custom fields, and newsletter lists; confirmation required.

Instructions

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

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
accountNoNamed private account from BEEHIIV_ACCOUNTS. Defaults to BEEHIIV_DEFAULT_ACCOUNT or the first configured account.
confirmNoSet true only when the user asked for exactly this action.
payloadNoComplete JSON body instead of individual body flags. Supports nullable fields and nested bulk structures. Cannot be combined with body flags or payload_file.
payload_fileNoLocal JSON request body file, at most 5 MB. Contents are validated before the API call and are never logged.
subscriptionsNo
publication_idYesThe prefixed ID of the publication object

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed10 schema fields changedv3.0.1
    • addedInput schema / $defs
      Added value: +{
+  "subscriptions": {
+    "description": "An array of objects representing the subscriptions to be updated (max 1000).",
+    "items": {
+      "additionalProperties": false,
+      "properties": {
+        "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": "An array of custom field objects to update",
+          "items": {
+            "additionalProperties": false,
+            "properties": {
+              "delete": {
+                "description": "A boolean value to specify whether to delete this custom field entry from the subscription",
+                "type": "boolean"
+              },
+              "name": {
+                "description": "The display value of the custom field",
+                "type": "string"
+              },
+              "value": {
+                "description": "The value of the custom field",
+                "oneOf": [
+                  {
+                    "type": "string"
+                  },
+                  {
+                    "format": "double",
+                    "type": "number"
+                  },
+                  {
+                    "type": "boolean"
+                  },
+                  {
+                    "items": {
+                      "type": "string"
+                    },
+                    "type": "array"
+                  }
+                ],
+                "title": "CustomFieldDataType"
+              }
+            },
+            "title": "SubscriptionsPatchRequestSubscriptionsItemCustomFieldsItem",
+            "type": "object"
+          },
+          "type": "array"
+        },
+        "newsletter_list_ids": {
+          "description": "An array of newsletter list prefixed IDs to subscribe this subscription to. Adds to the subscription's existing list memberships; it does not replace them. The newsletter lists must belong to the same publication. Cannot be combined with `unsubscribe`.",
+          "items": {
+            "type": "string"
+          },
+          "type": "array"
+        },
+        "stripe_customer_id": {
+          "description": "The Stripe Customer ID of the subscription (not required)",
+          "pattern": "^(cus_[0-9a-zA-Z]+)?$",
+          "title": "OptionalStripeCustomerId",
+          "type": "string"
+        },
+        "subscription_id": {
+          "description": "The prefixed ID of the subscription.",
+          "pattern": "^(sub_[0-9a-fA-F\\-]+)$",
+          "title": "SubscriptionId",
+          "type": "string"
+        },
+        "tier": {
+          "description": "The Tier of the Subscription (not required)",
+          "enum": [
+            "free",
+            "premium"
+          ],
+          "title": "SubscriptionsPatchRequestSubscriptionsItemTier",
+          "type": "string"
+        },
+        "unsubscribe": {
+          "description": "A boolean value specifying whether to unsubscribe this subscription from the publication (not required)",
+          "type": "boolean"
+        },
+        "unsubscribe_newsletter_list_ids": {
+          "description": "An array of newsletter list prefixed IDs to unsubscribe this subscription from. Unsubscribing from a list the subscription is not on is a no-op. The newsletter lists must belong to the same publication, and the same list cannot appear in `newsletter_list_ids`.",
+          "items": {
+            "type": "string"
+          },
+          "type": "array"
+        }
+      },
+      "required": [
+        "subscription_id"
+      ],
+      "title": "SubscriptionsPatchRequestSubscriptionsItem",
+      "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 / description
      Removed value: -"An array of objects representing the subscriptions to be updated (max 1000)."
    • removedInput schema / properties / payload / properties / subscriptions / items
      Removed value: -{
-  "additionalProperties": false,
-  "properties": {
-    "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": "An array of custom field objects to update",
-      "items": {
-        "additionalProperties": false,
-        "properties": {
-          "delete": {
-            "description": "A boolean value to specify whether to delete this custom field entry from the subscription",
-            "type": "boolean"
-          },
-          "name": {
-            "description": "The display value of the custom field",
-            "type": "string"
-          },
-          "value": {
-            "description": "The value of the custom field",
-            "oneOf": [
-              {
-                "type": "string"
-              },
-              {
-                "format": "double",
-                "type": "number"
-              },
-              {
-                "type": "boolean"
-              },
-              {
-                "items": {
-                  "type": "string"
-                },
-                "type": "array"
-              }
-            ],
-            "title": "CustomFieldDataType"
-          }
-        },
-        "title": "SubscriptionsPatchRequestSubscriptionsItemCustomFieldsItem",
-        "type": "object"
-      },
-      "type": "array"
-    },
-    "newsletter_list_ids": {
-      "description": "An array of newsletter list prefixed IDs to subscribe this subscription to. Adds to the subscription's existing list memberships; it does not replace them. The newsletter lists must belong to the same publication. Cannot be combined with `unsubscribe`.",
-      "items": {
-        "type": "string"
-      },
-      "type": "array"
-    },
-    "stripe_customer_id": {
-      "description": "The Stripe Customer ID of the subscription (not required)",
-      "pattern": "^(cus_[0-9a-zA-Z]+)?$",
-      "title": "OptionalStripeCustomerId",
-      "type": "string"
-    },
-    "subscription_id": {
-      "description": "The prefixed ID of the subscription.",
-      "pattern": "^(sub_[0-9a-fA-F\\-]+)$",
-      "title": "SubscriptionId",
-      "type": "string"
-    },
-    "tier": {
-      "description": "The Tier of the Subscription (not required)",
-      "enum": [
-        "free",
-        "premium"
-      ],
-      "title": "SubscriptionsPatchRequestSubscriptionsItemTier",
-      "type": "string"
-    },
-    "unsubscribe": {
-      "description": "A boolean value specifying whether to unsubscribe this subscription from the publication (not required)",
-      "type": "boolean"
-    },
-    "unsubscribe_newsletter_list_ids": {
-      "description": "An array of newsletter list prefixed IDs to unsubscribe this subscription from. Unsubscribing from a list the subscription is not on is a no-op. The newsletter lists must belong to the same publication, and the same list cannot appear in `newsletter_list_ids`.",
-      "items": {
-        "type": "string"
-      },
-      "type": "array"
-    }
-  },
-  "required": [
-    "subscription_id"
-  ],
-  "title": "SubscriptionsPatchRequestSubscriptionsItem",
-  "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 / description
      Removed value: -"An array of objects representing the subscriptions to be updated (max 1000)."
    • removedInput schema / properties / subscriptions / items
      Removed value: -{
-  "additionalProperties": false,
-  "properties": {
-    "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": "An array of custom field objects to update",
-      "items": {
-        "additionalProperties": false,
-        "properties": {
-          "delete": {
-            "description": "A boolean value to specify whether to delete this custom field entry from the subscription",
-            "type": "boolean"
-          },
-          "name": {
-            "description": "The display value of the custom field",
-            "type": "string"
-          },
-          "value": {
-            "description": "The value of the custom field",
-            "oneOf": [
-              {
-                "type": "string"
-              },
-              {
-                "format": "double",
-                "type": "number"
-              },
-              {
-                "type": "boolean"
-              },
-              {
-                "items": {
-                  "type": "string"
-                },
-                "type": "array"
-              }
-            ],
-            "title": "CustomFieldDataType"
-          }
-        },
-        "title": "SubscriptionsPatchRequestSubscriptionsItemCustomFieldsItem",
-        "type": "object"
-      },
-      "type": "array"
-    },
-    "newsletter_list_ids": {
-      "description": "An array of newsletter list prefixed IDs to subscribe this subscription to. Adds to the subscription's existing list memberships; it does not replace them. The newsletter lists must belong to the same publication. Cannot be combined with `unsubscribe`.",
-      "items": {
-        "type": "string"
-      },
-      "type": "array"
-    },
-    "stripe_customer_id": {
-      "description": "The Stripe Customer ID of the subscription (not required)",
-      "pattern": "^(cus_[0-9a-zA-Z]+)?$",
-      "title": "OptionalStripeCustomerId",
-      "type": "string"
-    },
-    "subscription_id": {
-      "description": "The prefixed ID of the subscription.",
-      "pattern": "^(sub_[0-9a-fA-F\\-]+)$",
-      "title": "SubscriptionId",
-      "type": "string"
-    },
-    "tier": {
-      "description": "The Tier of the Subscription (not required)",
-      "enum": [
-        "free",
-        "premium"
-      ],
-      "title": "SubscriptionsPatchRequestSubscriptionsItemTier",
-      "type": "string"
-    },
-    "unsubscribe": {
-      "description": "A boolean value specifying whether to unsubscribe this subscription from the publication (not required)",
-      "type": "boolean"
-    },
-    "unsubscribe_newsletter_list_ids": {
-      "description": "An array of newsletter list prefixed IDs to unsubscribe this subscription from. Unsubscribing from a list the subscription is not on is a no-op. The newsletter lists must belong to the same publication, and the same list cannot appear in `newsletter_list_ids`.",
-      "items": {
-        "type": "string"
-      },
-      "type": "array"
-    }
-  },
-  "required": [
-    "subscription_id"
-  ],
-  "title": "SubscriptionsPatchRequestSubscriptionsItem",
-  "type": "object"
-}
    • removedInput schema / properties / subscriptions / type
      Removed value: -"array"
  2. First observedv2.0.0

TDQS

C2.9/5.0
Behavior3/5

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

Annotations already declare destructiveHint=true, idempotentHint=false, and readOnlyHint=false, so the mutation profile is known. The description adds two genuinely useful facts beyond the annotations: the required confirm=true confirmation gate and the OAuth scope subscriptions:write. It stops short of describing scope of destruction or reversibility, but against annotation coverage this is adequate value-add.

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, front-loaded with the core action followed by the confirm requirement and auth scope. Nothing is padded and the ordering puts the most decision-relevant facts first. It is efficient, though very brief relative to the tool's complexity.

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 tool with a deeply nested schema and no output schema, the description covers the key safety facts (confirm, auth scope) but omits bulk semantics (max 1000, per-item patching) and its relationship to replace_bulk_subscription_update. The rich schema compensates for missing parameter detail, so it is minimally complete rather than fully so.

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%, so the schema already documents nearly all parameters in detail (subscription_id pattern, newsletter_list_ids add-only semantics, unsubscribe conflicts, payload alternatives). The description mentions confirm=true, adding a small amount, but does not extend meaning for the nested bulk structures. Baseline 3 is appropriate when the schema carries the load.

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

Purpose3/5

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

The description gives a clear verb and resource ("Update subscriptions") and notes it stands out as a bulk/account-state mutation. However, it fails to differentiate from the many sibling update tools such as update_subscription, patch_subscription, update_subscription_by_email, and replace_bulk_subscription_update. An agent cannot tell from the text alone why it should pick this tool over those, which is critical given the crowded sibling set.

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

Usage Guidelines2/5

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

The only guidance is the precondition that confirm=true is required, which is a safety gate rather than selection criteria. There is no statement of when to use this tool versus the single-update siblings or replace_bulk_subscription_update, nor any exclusion of conflicting tools. An agent is left to infer correct usage entirely.

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

Deploy Server

Other Tools