Update Custom Status
- Print
- DarkLight
- PDF
Update Custom Status
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Post
/api/v1/custom-user-status.update
Update a custom status.
Changelog
| Version | Description |
|---|---|
| 2.4.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
{
"_id": "65462e97a2f73c7460e18f84",
"name": "caught up again",
"statusType": "busy"
}object
_id
string Required
The _id of the custom status.
name
string Required
The updated name of the custom status.
statusType
string Required
The updated statusType of the custom status
Responses
200
OK
Success Example
{
"customUserStatus": {
"_id": "65462e97a2f73c7460e18f84",
"name": "caught up again",
"statusType": "busy",
"_updatedAt": "2023-11-04T11:51:28.353Z"
},
"success": true
}object
customUserStatus
object
_id
string
name
string
statusType
string
_updatedAt
string
success
boolean
400
Bad Request
User status not found
{
"success": false,
"error": "No custom user status found with the id of \"SeZHHb77QXWRbnDh\"."
}object
success
boolean
error
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?