Skip to main content
Glama

update_suprsend_user_channel_preference

DestructiveIdempotent

Block or allow specific communication channels for a single user across all categories. Use to restrict or enable delivery channels like email or SMS.

Instructions

Block or allow specific delivery channels for ONE user, applied across ALL categories. Use this for "block all SMS to this user" or "allow only email" patterns.

is_restricted semantics: true blocks delivery on that channel; false re-enables it. Each entry in channel_preferences is a {channel, is_restricted} pair.

When NOT to use:

  • For per-category control — use update_suprsend_users_preferences.

  • For permanent invalidation (e.g., a bounced email) — that's set by SuprSend automatically as perma_status; don't try to override it here.

  • For objects — use update_suprsend_object_channel_preference.

Side effects: takes effect on the next workflow run; in-flight notifications already in the queue may still send.

Returns: updated channel-preference state on success.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
workspaceNoSuprSend workspace to update the channel preference for.
distinct_idYesThe distinct_id of the user to update the channel preference 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?

Discloses side effects (takes effect on next workflow run, in-flight notifications may still send). Explains is_restricted semantics and warns against overriding perma_status. Annotations are consistent: destructiveHint=true, idempotentHint=true, etc. No contradiction.

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?

Well-structured with clear sections (purpose, semantics, when-not-to-use, side effects). Each sentence adds value, but could be slightly more concise; still excellent for thoroughness.

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?

Covers usage, parameter semantics, side effects, return value, and limitations. Given no output schema, description specifies it returns updated channel-preference state. Fully complete for this tool's complexity.

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?

Schema coverage is 100% but description adds meaning: explains the structure of channel_preferences items and the meaning of is_restricted (true blocks, false re-enables). Adds value beyond schema definitions.

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?

Description clearly states the tool blocks or allows delivery channels for one user, applied across all categories. It distinguishes from siblings like update_suprsend_users_preferences and update_suprsend_object_channel_preference via explicit 'When NOT to use' section.

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?

Explicit when to use (block/allow per user globally) and when not to use, with specific alternative tools named (per-category control, permanent invalidation, objects). Also provides use case examples.

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