2026-07-07
▼ ▲ chat.users.availability.get
Path : v1/{+name}
Parameters :
name
Description : Required. The resource name of the availability to retrieve. 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`.
Pattern : ^users/[^/]+/availability$
Location : path
Type : string
Required : Yes
Scopes :
Parameter Order : name
Description : Returns availability information for a human user in Google Chat. For example, this can be used to check if a user is online or away, or to retrieve their custom status message. This method only retrieves the authenticated user's availability. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.availability.readonly` - `https://www.googleapis.com/auth/chat.users.availability`
Flat Path : v1/users/{usersId}/availability
HTTP Method : GET
▼ ▲ chat.users.availability.patch
Parameters :
updateMask
Description : Required. The list of fields to update. The only field that can be updated is `custom_status`.
Location : query
Type : string
Format : google-fieldmask
name
Description : 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`.
Pattern : ^users/[^/]+/availability$
Location : path
Type : string
Required : Yes
Path : v1/{+name}
Flat Path : v1/users/{usersId}/availability
HTTP Method : PATCH
Scopes :
Parameter Order : name
Description : Updates availability information for a human user. Only the `custom_status` field can be updated through this method. This method only updates the authenticated user's availability. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.availability`
▼ ▲ chat.users.availability.getAvailability
Path : v1/{+name}
HTTP Method : GET
Description : Returns availability information for a human user in Google Chat. For example, this can be used to check if a user is online or away, or to retrieve their custom status message. This method only retrieves the authenticated user's availability. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.availability.readonly` - `https://www.googleapis.com/auth/chat.users.availability`
Parameter Order : name
Parameters :
name
Location : path
Type : string
Pattern : ^users/[^/]+/availability$
Required : Yes
Description : Required. The resource name of the availability to retrieve. 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`.
Flat Path : v1/users/{usersId}/availability
Scopes :
▼ ▲ chat.users.availability.updateAvailability
Flat Path : v1/users/{usersId}/availability
Scopes :
Path : v1/{+name}
HTTP Method : PATCH
Parameter Order : name
Parameters :
name
Pattern : ^users/[^/]+/availability$
Type : string
Location : path
Description : 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`.
Required : Yes
updateMask
Description : Required. The list of fields to update. The only field that can be updated is `custom_status`.
Type : string
Format : google-fieldmask
Location : query
Description : Updates availability information for a human user. Only the `custom_status` field can be updated through this method. This method only updates the authenticated user's availability. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.availability`