Matchai Docs

Mark a conversation as readComing soon

Marks every message in the conversation as read by you.

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

Coming soon. Marks every message in the conversation as read by you.

Scopes: messages:read

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: messages:read

Path Parameters

conversation_id*string

Conversation 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 conversation.

application/json
  1. response
id*string

Conversation id.

Length1 <= length <= 64
type*string
Value in"direct""group"
channel*string

text: the conversation runs by text message with the other person’s phone.

Value in"matchai""text"
name?|

Group name. null for direct conversations.

participants*array<>

Everyone in it, you included.

context*
last_message?|null
unread_count*integer

Messages you have not read.

Range0 <= value
archived*boolean

Archived by you.

created_at*string

Started.

Formatdate-time
updated_at*string

Last activity.

Formatdate-time
Example Request
curl -X POST 'https://api.matchai.co/v1/conversations/string/read' \  -H 'Idempotency-Key: 6f1d3c2a-0b7e-4f5a-9c8d-1e2f3a4b5c6d'
Example Response
{  "id": "string",  "type": "direct",  "channel": "matchai",  "name": "string",  "participants": [    {      "user_id": "string",      "contact_id": "string",      "display_name": "string",      "avatar_url": "http://example.com"    }  ],  "context": {    "listing_id": "string",    "contact_id": "string",    "project_id": "string",    "team_id": "string"  },  "last_message": {    "id": "string",    "preview": "string",    "sender_user_id": "string",    "sent_at": "2019-08-24T14:15:22Z"  },  "unread_count": 0,  "archived": true,  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}