ARK TMS

MCP documentation | MCP docs for agents

ark_update_user_preferences

ark.update_user_preferences

Update notification and sound preferences for the connected ARK user.

Availability
Expanded preview
Scopes
notifications:write
ARK permissions
None
Team visibility
Not entity-scoped
Approval policy
ask_before_write
ARK approval request
Required before execution
Idempotency
Required for external execution
Read-only
No
Destructive
No
External side effect
No
Rate limit
OAuth MCP credential and organization budgets

Input

notificationsEnabledboolean

Whether in-app notifications are enabled for the connected user.

soundNewBidboolean

Whether to play a sound for new carrier bids.

soundQuoteAcceptedboolean

Whether to play a sound when a quote is accepted.

soundAwardSuccessboolean

Whether to play a sound when a load is awarded successfully.

volumenumber

Notification sound volume from 0 to 1.

min: 0; max: 1

Result

The tool returns the canonical ark.update_user_preferences operation result in structuredContent and mirrors the same JSON as text. Errors set isError: true and return a stable error code, message, and optional details.