Close DM

Prev Next
Post
/api/v1/dm.close

Removes the direct message from the user's list of direct messages.

Changelog

Version Description
0.48.0 Added
Header parameters
X-Auth-Token
stringRequired

The authToken of the authenticated user.

ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired

The userId of the authenticated user.

ExamplerbAXPnMktTFbNpwtJ
Body parameters
Example
{
  "roomId": "ByehQjC44FwMeiLbX"
}
object
roomId
string Required

The room ID.

Responses
200

OK

Success
{
  "success": true
}
object
success
boolean
400

Bad Request

RoomId is required
{
  "success": false,
  "error": "Body param \"roomId\" is required [error-room-param-not-provided]",
  "errorType": "error-room-param-not-provided"
}
Invalid room ID or user is not member of room
{
  "success": false,
  "error": "The user is not subscribed to the room"
}
object
success
boolean
error
string
errorType
string
401

Unauthorized

Authorization Error
{
  "status": "error",
  "message": "You must be logged in to do this."
}
object
status
string
message
string