chat

Mark messages as read

Mark one or more messages as read for the current user in the chat.

POST/api/chat/projects/{projectId}/chats/{chatId}/messages/read

Authentication

Requires JWT
Note
Include your JWT in the Authorization: Bearer YOUR_TOKEN header (user-facing apps, RBAC). View authentication guide →

Path Parameters

NameTypeRequiredDescription
projectIdstringYesProject ID.
chatIdstringYesChat ID.

Request Body

Array of message IDs to mark as read.

json
{
  "messageIds": [
    "application transmit"
  ]
}
{
  "messageIds": [
    "application transmit"
  ]
}

SDK setup

Create a client and set credentials (JWT and/or API key) before calling the API. Match the authentication type shown above.

import { MudbaseClient } from "mudbase";

const client = new MudbaseClient();
client.setJWT("eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c3JfbW9yZ2FuX2RlIiwiZW1haWwiOiJtb3JnYW4uY2hlbkBub3J0aHdpbmQuZGV2IiwiZXhwIjoxODI1MTI5NjAwfQ.doc_preview_sig");
import { MudbaseClient } from "mudbase";

const client = new MudbaseClient();
client.setJWT("eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c3JfbW9yZ2FuX2RlIiwiZW1haWwiOiJtb3JnYW4uY2hlbkBub3J0aHdpbmQuZGV2IiwiZXhwIjoxODI1MTI5NjAwfQ.doc_preview_sig");

Example request

Call this endpoint using the client from SDK setup. Use View HTTP for a raw cURL example.

const result = await client.chat.markAsRead({
  projectId: "proj_45aEhMXvqpYh",
  chatId: "kdMmJXZDi2UOM8jb",
  messageIds: "New lavender Shirt with ergonomic design for strict comfort"
});
const result = await client.chat.markAsRead({
  projectId: "proj_45aEhMXvqpYh",
  chatId: "kdMmJXZDi2UOM8jb",
  messageIds: "New lavender Shirt with ergonomic design for strict comfort"
});

Try It Live

Test this endpoint with your own credentials. Your requests will be sent to the live API.

Use the auth endpoints to obtain a JWT.

No Request Yet

Send a request to see the full inspector

Responses

200Messages marked as read
json
{
  "success": true,
  "data": {
    "modifiedCount": 5
  }
}
{
  "success": true,
  "data": {
    "modifiedCount": 5
  }
}
400Bad request or validation error.
401Authentication required or invalid token.

Errors

CodeMeaning
400Bad request or validation error.
401Authentication required or invalid token.

Next steps

Edit this page on GitHub