Skip to main content
Glama

update_suprsend_category_preference_object

DestructiveIdempotent

Set a single category preference for an object to opted-in or opted-out, and optionally specify per-channel opt-outs. Replaces the existing category preference.

Instructions

Set ONE category's preference for ONE object — 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 on a single object.

When NOT to use:

  • For object-wide channel toggles ("block all SMS") — use update_suprsend_object_channel_preference.

  • For users — use update_suprsend_users_preferences.

  • For tenant defaults — use update_suprsend_tenant_default_preference.

Preference values: opt_in enables; opt_out disables; cant_unsubscribe locks the object from toggling this category.

Returns: updated preference state on success; structured error on failure.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
categoryYescategory_slug of an category to get.
object_idYesThe object_id of the object to get preferences from.
workspaceNoSuprSend workspace to get the user from.
preferenceYesThe preference to update for the object.
object_typeYesThe object_type of the object to get preferences from.
opt_out_channelsNoThe channels to opt out from for the object.
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) existing preferences and that previous opt-outs within the same category are lost, which goes beyond the annotations. It also explains the meaning of preference values.

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?

The description is well-structured with sections, front-loaded purpose, and each sentence adds value. It could be slightly more concise but is appropriately sized for the tool's complexity.

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 no output schema, the description mentions return values (updated state or error). It covers behavioral impact, parameter meanings, and usage context. Minor omission: does not explain the 'workspace' parameter beyond schema, but schema already does.

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% (baseline 3), and the description adds meaning by explaining preference values and opt_out_channels. However, it introduces 'cant_unsubscribe' which is not in the schema enum, causing a slight inconsistency.

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 clearly states it sets one category's preference for one object, with options for opted in, opted out, or cant_unsubscribe. It also lists sibling tools for when not to use, distinguishing its specific purpose.

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?

It explicitly says when to use (changing a single category on a single object) and when NOT to use, with three specific alternative tools and their use cases, providing excellent guidance.

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