API documentation | API docs for agents | OpenAPI 3.1

read

ark.mark_notification_read

Marks one notification for the connected user as read.

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

notificationIdpathstringrequired: format: uuid
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

None.

Example request

Shell

curl -X POST 'https://arktms.com/api/v1/notifications/<notificationId>/read' \
  -H "Authorization: Bearer $ARK_API_TOKEN" \
  -H "Idempotency-Key: <unique-key>"

Success response

Marked notification

objectstringrequired

one of: api_response

okbooleanrequired

one of: true

api_versionstringrequired

one of: 2026-05-31

request_idstringrequired

dataobjectrequired

data.notificationobjectrequired

data.wasAlreadyReadbooleanrequired

Errors

HTTP 400: Invalid request
HTTP 401: Authentication required
HTTP 403: Permission, scope, team, or entitlement denied
HTTP 404: Resource not found