Mark channel as read

Mark any room (channel, group and DMs) as read.
URL
Requires Auth
HTTP Method
/api/v1/subscriptions.read
yes
POST
Payload
Argument
Example
Required
Description
Valid Format(s)
rid roomId
L6su9mxwdDkvdSaT9hvzu8z6mHFigiXy6Y OR GENERAL
Required
A valid roomId for a channel, group or DM
Alphanumeric mixed-case string
Example Call
Using rid as argument.
curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
     -H "X-User-Id: aobEdbYhXfu5hkeqG" \
     -H "Content-Type: application/json" \
     http://localhost:3000/api/v1/subscriptions.read \
     -d '{"rid":"L6su9mxwdDkvdSaT9hvzu8z6mHFigiXy6Y"}'
Example Result
{
    "success": true
}
Example Call
Using roomId as argument.
curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
     -H "X-User-Id: aobEdbYhXfu5hkeqG" \
     -H "Content-Type: application/json" \
     http://localhost:3000/api/v1/subscriptions.read \
     -d '{"roomId":"L6su9mxwdDkvdSaT9hvzu8z6mHFigiXy6Y"}'
Example Result
{
    "success": true
}
Change Log
Version
Description
3.11.0
roomId can be used as argument instead of rid.
0.61.0
Endpoint Added.

URL	Requires Auth	HTTP Method
`/api/v1/subscriptions.read`	`yes`	`POST`

Argument	Example	Required	Description	Valid Format(s)
`rid` `roomId`	`L6su9mxwdDkvdSaT9hvzu8z6mHFigiXy6Y` OR `GENERAL`	Required	A valid `roomId` for a channel, group or DM	Alphanumeric mixed-case string

Version	Description
3.11.0	`roomId` can be used as argument instead of `rid`.
0.61.0	Endpoint Added.

Last modified 1yr ago