GOgoogle
users

POST /v1/users/{usersId}/availability:markAsAway

Marks user as AWAY in Google Chat. Sets the user's state to away and is not affected by the user's activity. This method only updates the authenticated user's availability. Requires user authentication with authorization scope: - https://www.googleapis.com/auth/chat.users.availability

Request

  • Base URL
    https://chat.googleapis.com
  • URL
    https://chat.googleapis.com/v1/users/{usersId}/availability:markAsAway
  • Auth
    OAuth 2 and OAuth 2
    Implicit: https://accounts.google.com/o/oauth2/auth
    Scopes: https://www.googleapis.com/auth/chat.users.availability
    Authorization code: https://accounts.google.com/o/oauth2/auth
    Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/chat.users.availability

Path parameters

usersIdstring required

Request body

MarkAsAwayRequest required

Request message for the MarkAsAway method.

Response

Successful response

namestring

Identifier. Resource name of the user's availability. Format: users/{user}/availability {user} is the id for the Person in the People API or Admin SDK directory API. For example, users/123456789. The user's email address or me can also be used as an alias to refer to the caller. For example, users/user@example.com or users/me.

state'STATE_UNSPECIFIED' | 'ACTIVE' | 'IDLE' | 'AWAY' | 'DO_NOT_DISTURB'

Output only. The user's current availability state.

Changes

No recorded changes to this operation across all 9 revisions of this API.