Update custom user status type

Updates a custom user status

Headers

Example Call

curl --location --request POST 'http://localhost:3000/api/v1/custom-user-status.update\
--header 'X-Auth-Token: myauth-token' \
--header 'X-User-Id: myuser-name'
 -d "_id=SeZHHb77QXWRbnDhn&name=Férias&statusType=busy"

Result

Success

{
    "customUserStatus": {
        "_id": "SeZHHb77QXWRbnDhn",
        "name": "Férias",
        "statusType": "busy",
        "_updatedAt": "2021-09-26T15:23:46.325Z"
    },
    "success": true
}

Errors

Any of the following errors can occur upon the endpoint.

  • Authorization: Requires an authentication token for the request to be made.

  • No custom user status id: Requires a valid custom user status _id

{
    "success": false,
    "error": "unauthorized"
}

Last updated

Rocket.Chat versions receive support for six months after release.