Skip to main content
Glama

update_suprsend_users_preferences

DestructiveIdempotent

Updates a single user's category preference (opt-in, opt-out, or locked) and per-channel opt-outs, overwriting previous settings for that category.

Instructions

Set ONE category's preference for ONE user — opted in, opted out, or cant_unsubscribe (locked) — plus per-channel opt-outs within that category.

Replaces, does not merge. This call overwrites the existing preference for the named category. Previous opt-outs within the same category are lost; pass them again in opt_out_channels if you want to keep them.

When to use: changing a single category for a single user.

When NOT to use:

  • For tenant-wide defaults — use update_suprsend_tenant_default_preference.

  • For cross-category channel toggles ("block all SMS") — use update_suprsend_user_channel_preference.

  • For the same flow on objects — use update_suprsend_category_preference_object.

Preference values: opt_in enables; opt_out disables; cant_unsubscribe locks the user from toggling this category in their preference UI.

Returns: updated preference state on success; structured error on failure (e.g., unknown category slug).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
workspaceNoSuprSend workspace to run the query from.
categoriesYesThe categories to update the preferences for.
distinct_idsYesThe distinct_ids of the users to update the preferences for.
channel_preferencesYesThe channel preferences to update for the users.
Behavior5/5

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

The description discloses that the call 'replaces, does not merge' and 'overwrites existing preference', plus explains the meaning of each preference value and the return behavior. This adds significant context beyond the annotations, which only indicate destructiveness and idempotence.

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?

The description is well-structured with sections, bullet points, and clear separation of concerns. It is front-loaded with the core action and efficiently delivers all necessary information without redundancy.

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

Completeness5/5

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

Given the 4 parameters, 100% schema coverage, and annotations, the description completes the picture by explaining the replace behavior, preference values, and return value. No output schema is present, but the description adequately describes the response.

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

Parameters4/5

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

While schema coverage is 100% and provides basic descriptions, the description adds important context such as the 'cant_unsubscribe' option (though not present in the schema enum) and explains the overwrite behavior for opt_out_channels. This adds value beyond the schema, justifying a score above the baseline of 3.

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

Purpose5/5

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

The description explicitly states the action ('Set ONE category's preference for ONE user'), the verb ('set'), the resource ('category preference'), and the scope (one category, one user). It also lists the possible preference values, making the purpose very clear.

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

Usage Guidelines5/5

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

The description provides a clear 'When to use' section and a 'When NOT to use' section that names three specific sibling tools and their appropriate use cases, aiding the agent in selecting the correct tool.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/suprsend/cli'

If you have feedback or need assistance with the MCP directory API, please join our Discord server