Set User Status

HTTP MethodURLRequires Auth

POST

/api/v1/users.setStatus

Permission required: edit-other-user-info and the setting AllowUserStatusMessageChange enabled.

Body Parameters

KeyExampleRequiredDescription

message

My status update.

Required

The user's status message.

status

online

Optional

The user's status like online, away, busy, offline.

userId

zXuq7SvPKYbzYmfpo

Optional

The userId to change. The running user must have edit-other-user-info permission

username

rocket.cat

Optional

The username to change. The running user must have edit-other-user-info permission

Example Call

curl -H "X-Auth-Token: 40tB-Cn5YQJ74QMlQXi4Zf4E_-e0P5CrklU2pWOtV9M" \
     -H "X-User-Id: uunbZHiuEnib8Pawj" \
     -H "Content-type: application/json" \
     -d '{"message":"My status update", "status": "online"}' \
     http://localhost:3000/api/v1/users.setStatus

Example Response

{
    "success": true
}

Change Log

VersionDescription

1.2.0

Added

Last updated

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