2026-06-27
▼ ▲ chat.users.availability.markAsActive
HTTP Method : POST
Parameter Order : name
Description : Marks user as `ACTIVE` in Google Chat. Sets the user's availability state to `ACTIVE`. The `ACTIVE` state lasts until the specified expiration, at which point the user's state becomes `AWAY`. Note that if the user is actively using Chat, the `ACTIVE` state duration may extend beyond the provided expiration. This method only updates the authenticated user's availability. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.availability`
Scopes :
Parameters :
name
Description : Required. The resource name of the availability to mark as active. 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`.
Type : string
Location : path
Pattern : ^users/[^/]+/availability$
Required : Yes
Path : v1/{+name}:markAsActive
Flat Path : v1/users/{usersId}/availability:markAsActive
▼ ▲ chat.users.availability.markAsAway
Parameter Order : name
HTTP Method : POST
Parameters :
name
Location : path
Pattern : ^users/[^/]+/availability$
Required : Yes
Description : Required. The resource name of the availability to mark as away. 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`.
Type : string
Scopes :
Description : 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](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.availability`
Flat Path : v1/users/{usersId}/availability:markAsAway
Path : v1/{+name}:markAsAway
▼ ▲ chat.users.availability.markAsDoNotDisturb
Parameter Order : name
HTTP Method : POST
Scopes :
Parameters :
name
Description : Required. The resource name of the availability to mark as Do Not Disturb. 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`.
Type : string
Pattern : ^users/[^/]+/availability$
Location : path
Required : Yes
Description : Marks user as`DO_NOT_DISTURB` in Google Chat. Sets a user's availability state to `DO_NOT_DISTURB` until a specified expiration time. When in `DO_NOT_DISTURB`, users typically won't receive notifications. This method only updates the authenticated user's availability. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.availability`
Flat Path : v1/users/{usersId}/availability:markAsDoNotDisturb
Path : v1/{+name}:markAsDoNotDisturb
▼ ▲ chat.users.availability.updateAvailability
HTTP Method : PATCH
Parameter Order : name
Path : v1/{+name}
Flat Path : v1/users/{usersId}/availability
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`
Parameters :
name
Pattern : ^users/[^/]+/availability$
Location : path
Required : Yes
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`.
Type : string
updateMask
Location : query
Description : Required. The list of fields to update. The only field that can be updated is `custom_status`.
Type : string
Format : google-fieldmask
Scopes :
▼ ▲ chat.users.availability.getAvailability
HTTP Method : GET
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`
Parameters :
name
Required : Yes
Pattern : ^users/[^/]+/availability$
Location : path
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`.
Type : string
Scopes :
Path : v1/{+name}
Flat Path : v1/users/{usersId}/availability