Skip to main content
Glama

update_suprsend_category_preference_object

DestructiveIdempotent

Overwrite the opt-in or opt-out preference for one category on one object, with optional per-channel opt-outs.

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.
object_typeYesThe object_type of the object to get preferences from.
opt_out_channelsNoThe channels to opt out from for the object.
preferenceYesThe preference to update for the object.
workspaceNoSuprSend workspace to get the user from.
Behavior5/5

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

Annotations indicate mutability, destructiveness, idempotency, and open-world. The description adds crucial context: 'Replaces, does not merge. This call overwrites the existing preference for the named category. Previous opt-outs within the same category are lost.' It also explains preference values and return behavior. No contradiction with annotations.

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 bullet points and clear sections. Every sentence adds value. Slightly verbose due to the 'When NOT to use' list, but this is informative rather than wasteful.

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 tool's complexity (6 parameters, 4 required, mutation behavior), the description covers replacement behavior, per-channel opt-outs, preference value semantics, and return/error info. No output schema, so the return description is essential. Complete for its purpose.

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%, so baseline is 3. The description adds value by explaining the meaning of preference values (opt_in, opt_out, cant_unsubscribe) and the effect of opt_out_channels. However, it does not detail the format of category_slug or object_id beyond what the schema provides.

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 the tool's purpose: 'Set ONE category's preference for ONE object — opted in, opted out, or cant_unsubscribe (locked) — plus per-channel opt-outs within that category.' It distinguishes from siblings by naming alternative tools and their use cases.

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' and 'When NOT to use' sections with clear alternatives (e.g., update_suprsend_object_channel_preference, update_suprsend_users_preferences, update_suprsend_tenant_default_preference).

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