Set DM Topic
- Print
- DarkLight
- PDF
Set DM Topic
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Post
/api/v1/im.setTopic
Set the topic of a DM.
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 1
{
"roomId": "ByehQjC44FwMeiLbX",
"topic": "Discuss all of the testing"
}object
roomId
string Required
The room ID of the direct message.
topic
string Required
The topic of the DM.
Responses
200
OK
Example 1
{
"topic": "Discuss all of the testing",
"success": true
}object
topic
string
success
boolean
400
Bad Request
Example 1
{
"success": false,
"error": "Body param \"roomId\" is required [error-room-param-not-provided]",
"errorType": "error-room-param-not-provided"
}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
Was this article helpful?