Set User Status

Prev Next
Post
/api/v1/users.setStatus

  • You can set the status for yourself or another user. The AllowUserStatusMessageChange setting must be enabled in the Accounts workspace settings.

  • To change another user's status, you must have the edit-other-user-info permission.

  • According to your workspace settings (under Accounts), you will only be able to set the invisible or offline status if the Allow Invisible status option setting is enabled.

    Changelog

    Version Description
    1.2.0 Added
Header parameters
X-User-Id
stringRequired

The authenticated user ID.

ExamplerbAXPnMktTFbNpwtJ
X-Auth-Token
stringRequired

The authenticated user token.

ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
Body parameters
Example 1
{
  "message": "My status update",
  "status": "online",
  "userId": "zXuq7SvPKYbzYmfpo",
  "username": "bob"
}
object
message
string Required

The user's status message. At least one of the message or status parameters is required.

ExampleMy status update
status
string Required

The user's status like online, away, busy, or offline. At least one of the message or status parameters is required.

Exampleonline
userId
string

The user ID for which you want to set the status. You don't need to add this if you are setting the status for yourself. Alternatively, you can use the username parameter and enter the username for which you want to set the status.

ExamplezXuq7SvPKYbzYmfpo
Responses
200

OK

Success
{
  "success": true
}
object
success
boolean
400

Bad Request

Missing status or message parameter
{
  "success": false,
  "error": "Match error: Failed Match.OneOf, Match.Maybe or Match.Optional validation"
}
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