Set maximum Conversation unread

Operation boundary

POST/conversations/setUnread

Monotonically advances read_seq so no more than unread messages remain.

Request Body

application/json

User Conversation key and maximum unread count to retain.

TypeScript Definitions

Use the request body type in TypeScript.

Parameters for setting a Conversation maximum unread count.

uid*string

Unique identifier of the target user.

Length1 <= length

channel_id*string

Logical identifier of the target Channel; for a person Channel this is normally the other UID.

Length1 <= length

channel_type*integer

Numeric Channel type; 1 is a person Channel, 2 is a group Channel, and other values are extension types.

Formatuint8

Range1 <= value <= 255

unread*integer

Maximum unread messages to retain; it must be at least 0 and the server only advances read_seq monotonically.

Range0 <= value

[key: string]?any

{  "status": 200}