Matchai Docs

Mark all notifications as readComing soon

Marks every notification as read.

Coming soon. This is documented ahead of launch so you can plan your integration; it is not available yet.
POST
/notifications/read-all

Coming soon. Marks every notification as read.

Scopes: notifications:write

Pricing: Included with the connection.

Authorization

headerAuthorizationBearer <matchai_<base62>>

A personal API key, sent as Authorization: Bearer matchai_…. Create keys in Matchai under Settings → Connectors → Advanced (for developers). A key starts with matchai_ followed by letters and digits, carries the scopes chosen when it was created, and can be revoked at any time. Keys reach only the account that created them: to serve other professionals, use Connect with Matchai.

Scope: notifications:write

Header Parameters

Idempotency-Key?string

A unique string (a UUID works). Retrying with the same key within 24 hours returns the first response instead of acting twice. Reusing a key with a different body returns 409 idempotency_key_reused.

Length1 <= length <= 255

Response Body

The new count, zero.

application/json
  1. response
unread*integer

Unread notifications.

Range0 <= value
Example Request
curl -X POST 'https://api.matchai.co/v1/notifications/read-all' \  -H 'Idempotency-Key: 6f1d3c2a-0b7e-4f5a-9c8d-1e2f3a4b5c6d'
Example Response
{  "unread": 0}