Mark All Threads Read

Mark every unread thread in the workspace as read, optionally only one category.

POSThttps://api.foxreach.io/api/v1/inbox/mark-all-read

Requires an API key with the write scope.

Runs as one set-based update and answers directly with the count, so it never returns a job. Threads in other workspaces are never touched. Send {} to mark everything.

Body Parameters#

categorystringbody

Only mark threads in this category. One of: interested, not_interested, out_of_office, bounce, unsubscribe, uncategorized, unknown, unrelated.

Response#

Returns { "data": { "updated": 12 } }, the number of threads that were unread.

Errors#

Status	Description
`401`	Missing, invalid, revoked or expired API key
`403`	API key does not have the required scope: `write`
`422`	Unknown category, or no body sent

Rate Limit#

100 requests per minute, shared by every bulk call in your workspace. Fixed 60-second window.
Every response includes X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset (unix epoch seconds) and X-RateLimit-Bucket (bulk).
A 429 response includes a Retry-After header (seconds until the bucket resets).

For client-side patterns, see Rate Limiting.

Request

cURL

curl -X POST "https://api.foxreach.io/api/v1/inbox/mark-all-read" \
  -H "X-API-Key: otr_your_key" \
  -H "Content-Type: application/json" \
  -d '{"category": "out_of_office"}'

Python SDK

from foxreach import FoxReach

client = FoxReach(api_key="otr_your_key")
result = client.inbox.mark_all_read(category="out_of_office")

TypeScript SDK

import { FoxReach } from "foxreach";

const client = new FoxReach({ apiKey: "otr_your_key" });
const result = await client.inbox.markAllRead({ category: "out_of_office" });

Response

JSON

{ "data": { "updated": 12 } }

Was this page helpful?

View as MarkdownLast updated November 4, 2026