set_inbox_thread_read

This reference is generated from the published tool contract.

Behavior and boundaries

Overwrites an Agent Mailbox thread’s read state: marks it read through the observed sequence, or explicitly unread. Supply sequence from get_inbox_thread as through. Newer messages remain unread and an older read position never moves the cursor backwards. Changes are also visible in the mailbox UI. Requires the client’s write policy, without an additional Ridian approval step.

Permissions

Granted scopes, accounts, calendars and visibility rules limit access. Workspace administrators do not automatically gain access to other users’ accounts.

inbox:write

Consent and boundaries

Input

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "through": {
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "unread": {
      "type": "boolean"
    }
  },
  "required": [
    "id",
    "through",
    "unread"
  ],
  "additionalProperties": false
}

Output

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "changed": {
      "type": "boolean"
    }
  },
  "required": [
    "changed"
  ],
  "additionalProperties": false
}

Errors and retries

Check the tool result for errors. Do not blindly retry writes after a timeout. Check the current resource or send status first.

Error handling