Skip to main content
Glama
thenavidm
by thenavidm

Create data deletion request

create_data_deletion
Destructive

Submit a subscriber data deletion request for a Beehiiv publication. Requires publication_id, confirm=true for user-requested actions, and data_deletion:write for OAuth.

Instructions

Create data deletion request. Changes account state and requires confirm=true for the user-requested action. OAuth integrations require data_deletion:write.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
emailNoThe email address of the subscriber to delete.
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.
publication_idYesThe prefixed ID of the publication 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.6/5.0
Behavior4/5

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

Annotations already declare destructiveHint=true, readOnlyHint=false, and openWorldHint=true. The description goes beyond that by naming the concrete consequence ('changes account state'), the confirm=true safety gate, and the OAuth scope needed — all real behavioral context an agent cannot get from the annotations alone.

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?

Two short sentences, front-loaded with the action and then the two constraints. Every clause carries information; nothing is padding. It is slightly clipped rather than fully structured, but efficient.

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 6-parameter destructive mutation with a nested payload object and no output schema, the description covers the safety gate and auth but omits what the call returns, whether the deletion is immediate or queued, and how the payload/payload_file alternatives relate to the individual flags. Adequate but with clear gaps.

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 every parameter is already documented in the schema (including confirm's semantics and the payload/payload_file mutual exclusion). The description only echoes confirm=true, adding emphasis but no new syntax or format detail, so the baseline of 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 and resource ('Create data deletion request'), which is unambiguous on its own. However, it does not differentiate itself from the sibling read-side tools (list_data_deletion, get_data_deletion) that an agent will also see, so the agent must infer this is the write counterpart.

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 a prerequisite ('requires confirm=true for the user-requested action') and an auth requirement ('OAuth integrations require data_deletion:write'), which is useful gating context. It does not, however, say when to prefer this over delete_subscription or other deletion-adjacent siblings, nor when not to use it.

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