Status

class matterapi.endpoints.async_api.StatusApi(client: matterapi.client.base.BaseClient, skip_response_parsing: bool = False)

Endpoints for getting and updating user statuses.

async get_user_status(user_id: str) → matterapi.models.Status

Get user status

Get user status by id from the server.

Permissions:

Must be authenticated.

Api Reference:

GetUserStatus

async get_users_statuses_by_ids(*, json_body: Union[List[str], Dict]) → List[matterapi.models.Status]

Get user statuses by id

Get a list of user statuses by id from the server.

Permissions:

Must be authenticated.

Api Reference:

GetUsersStatusesByIds

async post_user_recent_custom_status_delete(user_id: str, *, json_body: Union[matterapi.models.PostUserRecentCustomStatusDeleteJsonBody, Dict]) → None

Delete user’s recent custom status

Deletes a user’s recent custom status by removing the specific status from the recentCustomStatuses in the user’s props and updates the user.

Permissions:

Must be logged in as the user whose recent custom status is being deleted.

Api Reference:

PostUserRecentCustomStatusDelete

async remove_recent_custom_status(user_id: str, *, json_body: Union[matterapi.models.RemoveRecentCustomStatusJsonBody, Dict]) → None

Delete user’s recent custom status

Deletes a user’s recent custom status by removing the specific status from the recentCustomStatuses in the user’s props and updates the user.

Permissions:

Must be logged in as the user whose recent custom status is being deleted.

Api Reference:

RemoveRecentCustomStatus

async unset_user_custom_status(user_id: str) → None

Unsets user custom status

Unsets a user’s custom status by updating the user’s props and updates the user

Permissions:

Must be logged in as the user whose custom status is being removed.

Api Reference:

UnsetUserCustomStatus

async update_user_custom_status(user_id: str, *, json_body: Union[matterapi.models.UpdateUserCustomStatusJsonBody, Dict]) → None

Update user custom status

Updates a user’s custom status by setting the value in the user’s props and updates the user. Also save the given custom status to the recent custom statuses in the user’s props

Permissions:

Must be logged in as the user whose custom status is being updated.

Api Reference:

UpdateUserCustomStatus

async update_user_status(user_id: str, *, json_body: Union[matterapi.models.UpdateUserStatusJsonBody, Dict]) → matterapi.models.Status

Update user status

Manually set a user’s status. When setting a user’s status, the status will remain that value until set “online” again, which will return the status to being automatically updated based on user activity.

Permissions:

Must have edit_other_users permission for the team.

Api Reference:

UpdateUserStatus