Skip to content

Latest commit

 

History

History
37 lines (27 loc) · 1.56 KB

File metadata and controls

37 lines (27 loc) · 1.56 KB
description
Sets a user Status when the status message and state is given.

Set Status

URL Requires Auth HTTP Method
/api/v1/users.setStatus yes POST

Arguments

ArgumentExampleRequiredDescription
messageMy status update.RequiredThe user's status message.
statusonlineOptionalThe user's status like online, away, busy, offline.
userIdzXuq7SvPKYbzYmfpoOptionalThe userId to change. The running user must have edit-other-user-info permission
usernamerocket.catOptionalThe 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 Result

{
    "success": true
}

Change Log

Version Description
1.2.0 Added