Matchai Docs

Mark a notification as readComing soon

Marks one notification as read, everywhere the account is signed in.

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

Coming soon. Marks one notification as read, everywhere the account is signed in.

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

Path Parameters

notification_id*string

Notification id.

Length1 <= length <= 64

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 notification.

application/json
  1. response
id*string

Notification id.

Length1 <= length <= 64
title*string

Title.

message*string

Text.

category*string
Value in"critical_action""approval_request""essential_business""user_engagement""workflow_update""system_maintenance"
priority*string
Value in"critical""high""medium""low"
read*boolean

Read.

read_at?|

Read.

Formatdate-time
subject?|

What it is about.

action?|null
created_at*string

Created.

Formatdate-time
Example Request
curl -X POST 'https://api.matchai.co/v1/notifications/string/read' \  -H 'Idempotency-Key: 6f1d3c2a-0b7e-4f5a-9c8d-1e2f3a4b5c6d'
Example Response
{  "id": "string",  "title": "string",  "message": "string",  "category": "critical_action",  "priority": "critical",  "read": true,  "read_at": "2019-08-24T14:15:22Z",  "subject": {    "type": "listing",    "id": "string"  },  "action": {    "label": "string",    "url": "http://example.com"  },  "created_at": "2019-08-24T14:15:22Z"}