Skip to main content
PUT
/
api
/
v1
/
markers
/
message-feeds
/
{messageFeedId}
/
mark-read
Mark message feeds as read
curl --request PUT \
  --url https://apix.us.amity.co/api/v1/markers/message-feeds/{messageFeedId}/mark-read \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "readToSegment": 123
}
'
{
  "userMarkers": [
    {
      "userId": "<string>",
      "lastSyncAt": "2023-11-07T05:31:56Z",
      "unreadCount": 123,
      "isMentioned": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "userFeedMarkers": [
    {
      "userId": "<string>",
      "entityId": "<string>",
      "feedId": "<string>",
      "readToSegment": 123,
      "deliveredToSegment": 123,
      "unreadCount": 123,
      "lastMentionSegment": 123,
      "isMentioned": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "userEntityMarkers": [
    {
      "userId": "<string>",
      "entityId": "<string>",
      "unreadCount": 123,
      "isDeleted": true,
      "isMentioned": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "feedMarkers": [
    {
      "entityId": "<string>",
      "feedId": "<string>",
      "lastSegment": 123,
      "isDeleted": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
messageFeedId
string
required

message feed id (internal)

Body

application/json

Mark read

​
readToSegment
number
required

segment of message as read by user

Response

Mark read

​
userMarkers
object[]
​
userFeedMarkers
object[]
​
userEntityMarkers
object[]
​
feedMarkers
object[]