Post
/api/v1/dm.delete
Delete a DM. Permission required: view-room-administration.
Changelog
| Version | Description |
|---|---|
| 3.18.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": "hdy9972092873h8s7s0"
}OneOf
object
object
roomId
string Required
The room ID of the DM. This parameter is required if you don't enter the username parameter.
object
object
username
string Required
The username of the user in the DM.
Responses
200
OK
Success
{
"success": true
}object
success
boolean
400
Bad Request
Example 1
{
"success": false,
"error": "must have required property 'roomId'\n must have required property 'username'\n must match exactly one schema in oneOf [invalid-params]",
"errorType": "invalid-params"
}Invalid room ID or username
{
"success": false,
"error": "[invalid-channel]",
"errorType": "invalid-channel"
}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