Mark Message as Read

Description

PUT /admin/message/read

Marks one or more messages as read in a specific conversation. All users whose messages were marked as read will receive a real-time update.

Authorization

Header

{ Admin-Api-Key: {{ HTTP_ADMIN_API_KEY }} }

Request

Content-Type: application/json

Request

{
  "organizationId": "680a2fae96cc69d78861f101",
  "senderId": "63480e68f4794709f802a2fa",
  "messageRead": {
    "cid": "63077ad836b78c3d82af0815",
    "ids": ["63480e68f4794709f802a2fa", "63077ad836b78c3d82af0866"]
  }
}

Request Parameters

Field	Type	Description
`organizationId`	`string`	OrganizationId performing request
`senderId`	`string`	User ID marking the messages as read
`messageRead.cid`	`string`	Conversation ID
`messageRead.ids`	`array[string]`	List of Message IDs that are being marked as read

Successful Response

Response

{
  "success": true
}

Real-time Message

Event

{
  "message_read": {
    "cid": "63077ad836b78c3d82af0815",
    "ids": ["63480e68f4794709f802a2fa", "63077ad836b78c3d82af0866"],
    "from": "634ec51c0b65918393dca5bf"
  }
}