API documentation | API docs for agents | OpenAPI 3.1

preferences

ark.update_user_preferences

Updates notification and sound preferences for the connected user.

Availability: Expanded preview
Scopes: notifications:write
ARK permissions: None
Team visibility: Not entity-scoped
Idempotency-Key: Required for this write
Approval: No MCP approval on REST API-token calls
Rate limit: API credential and organization budgets

Parameters

Idempotency-Keyheaderstringrequired: Required for external write operations. Reuse the same key only for exact retries of the same request body.; min length: 1; max length: 200

Request body

notificationsEnabledboolean

soundNewBidboolean

soundQuoteAcceptedboolean

soundAwardSuccessboolean

volumenumber

min: 0; max: 1

Example request

Shell

curl -X PATCH 'https://arktms.com/api/v1/me/preferences' \
  -H "Authorization: Bearer $ARK_API_TOKEN" \
  -H "Idempotency-Key: <unique-key>" \
  -H "Content-Type: application/json" \
  -d '{}'

Success response

Updated user preferences

objectstringrequired

one of: api_response

okbooleanrequired

one of: true

api_versionstringrequired

one of: 2026-05-31

request_idstringrequired

dataobjectrequired

data.userIdstringrequired

format: uuid

data.notificationsEnabledbooleanrequired

data.soundNewBidbooleanrequired

data.soundQuoteAcceptedbooleanrequired

data.soundAwardSuccessbooleanrequired

data.volumenumberrequired

min: 0; max: 1

data.createdAtstring | nullrequired

format: date-time

data.modifiedAtstring | nullrequired

format: date-time

data.modifiedBystring | nullrequired

format: uuid

Errors

HTTP 400: Invalid request
HTTP 401: Authentication required
HTTP 403: Permission, scope, team, or entitlement denied
HTTP 409: Idempotency conflict or in-progress retry