AI-generated Key Takeaways
-
This API updates or renews a Google Workspace subscription using a PATCH request to the specified URL.
-
You can optionally specify an
updateMaskto target specific fields for updating andvalidateOnlyto preview the request without applying changes. -
The request body should contain a
Subscriptionobject and the successful response will include anOperationobject with the updatedSubscription. -
Authorization requires specific OAuth scopes related to Google Chat or Google Meet, as detailed in the documentation.
Updates or renews a Google Workspace subscription. To learn how to use this method, see Update or renew a Google Workspace subscription .
For a subscription on a Chat target resource , you can update a subscription as:
-
A Chat app by specifying an authorization scope that begins with
chat.appandgetting one-time administrator approval ( Developer Preview ). To learn more, see Authorize as a Chat app with administrator approval . -
A user by specifying an authorization scope that doesn't include
appin its name. To learn more, see Authorize as a Chat user .
HTTP request
PATCH https://workspaceevents.googleapis.com/v1beta/{subscription.name=subscriptions/*}
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters | |
|---|---|
subscription.name
|
Identifier. Resource name of the subscription. Format: |
Query parameters
updateMask
string (
FieldMask
format)
Optional. The field to update. If omitted, updates any fields included in the request.
You can update one of the following fields in a subscription:
-
expireTime -
ttl -
eventTypes
When using the *
wildcard (equivalent to PUT
), omitted fields are set to empty values and rejected if they're invalid.
validateOnly
boolean
Optional. If set to true
, validates and previews the request, but doesn't update the subscription.
Request body
The request body contains an instance of Subscription
.
Response body
If successful, the response body contains an instance of Operation
.
- The
metadatafield contains an empty array. - The
responsefield contains an updated instance ofSubscription.
Authorization scopes
Requires one of the following OAuth scopes:
-
https://www.googleapis.com/auth/chat.spaces -
https://www.googleapis.com/auth/chat.spaces.readonly -
https://www.googleapis.com/auth/chat.messages -
https://www.googleapis.com/auth/chat.messages.readonly -
https://www.googleapis.com/auth/chat.messages.reactions -
https://www.googleapis.com/auth/chat.messages.reactions.readonly -
https://www.googleapis.com/auth/chat.memberships -
https://www.googleapis.com/auth/chat.memberships.readonly -
https://www.googleapis.com/auth/chat.app.memberships -
https://www.googleapis.com/auth/chat.app.messages.readonly -
https://www.googleapis.com/auth/chat.app.spaces -
https://www.googleapis.com/auth/meetings.space.created -
https://www.googleapis.com/auth/meetings.space.readonly -
https://www.googleapis.com/auth/drive -
https://www.googleapis.com/auth/drive.file -
https://www.googleapis.com/auth/drive.metadata -
https://www.googleapis.com/auth/drive.metadata.readonly -
https://www.googleapis.com/auth/drive.readonly
For more information, see the Authorization guide .
