Skip to main content
Glama
thenavidm
by thenavidm

Update newsletter list subscription by subscription ID

newsletter_list_subscriptions_update_by_subscription_id
Destructive

Update a newsletter list subscription by subscription ID to unsubscribe or change its state. Requires confirm=true and newsletter_lists:write for OAuth integrations.

Instructions

Update newsletter list subscription by subscription ID. Changes account state and requires confirm=true for the user-requested action. OAuth integrations require newsletter_lists: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.
unsubscribeNoSet to true to unsubscribe the subscription from this newsletter list.
payload_fileNoLocal JSON request body file, at most 5 MB. Contents are validated before the API call and are never logged.
publication_idYesThe prefixed ID of the publication object
subscription_idYesThe prefixed ID of the subscription
newsletter_list_idYesThe prefixed ID of the newsletter list object

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv3.0.1
    • 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."
  2. First observedv2.0.0

TDQS

A3.8/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 profile is known. The description earns credit for adding what the annotations do not: that it "changes account state," that a confirm=true gate is required for the user-requested action, and that OAuth integrations need newsletter_lists:write. It stops short of describing reversibility or return behavior.

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

Conciseness5/5

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

Three short sentences, each earning its place, with the core action front-loaded and the confirm gate and auth scope following. There is no filler or redundancy.

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

Completeness4/5

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

Given a destructive mutation with a 100%-covered schema, nested payload object, and no output schema, the description covers the action, the confirm gate, and auth scope adequately. The only minor gap is that it does not characterize the mutation surface (essentially an unsubscribe toggle) or any result, but the schema handles the input side fully.

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 100%, so the schema already documents all eight parameters, including the confirm, unsubscribe, payload, and payload_file options. The description's mention of confirm=true and the OAuth scope adds only marginal parameter meaning beyond the schema, so the baseline 3 applies.

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

Purpose4/5

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

The description states a specific verb ("Update") and resource ("newsletter list subscription") and adds the scoping qualifier "by subscription ID". It is clear what the tool does, but it does not distinguish itself from close siblings such as update_newsletter_list_subscription or update_subscription, leaving the agent to infer the difference from the name alone.

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?

The description gives a prerequisite ("requires confirm=true for the user-requested action") and an OAuth scope requirement, which is genuine usage guidance. However, it never states when to prefer this tool over the sibling update_newsletter_list_subscription or update_subscription_by_email, so the when-to-use decision is only implied.

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