Update this user's presence state.

This API sets the given user's presence state. When setting the status, the activity time is updated to reflect that activity; the client does not need to specify the last_active_ago field. You cannot set the presence state of another user.

put/_matrix/client/v3/presence/{userId}/status

Request

Base URL
https://matrix.org
Auth
- API key in query parameter access_token
- or HTTP bearer
TypeScript
https://skmtc.dev/matrix/apis/matrix-client-server-api/docs/_matrix/client/v3/presence/:userId/status/put.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

userIdstring required

The user whose presence state to update.

Request body

presence'online' | 'offline' | 'unavailable' required

The new presence state.

status_msgstring

The status message to attach to this state.

Example request

{
  "presence": "online",
  "status_msg": "I am here."
}

Response

The new presence state was set.

object required

Changes

No recorded changes to this operation across all 1 revision of this API.