AI-generated Key Takeaways
-
This method updates or renews a Google Workspace subscription using a PATCH request to the specified endpoint.
-
Developers can update subscription fields like expireTime, ttl, and eventTypes using the updateMask query parameter.
-
Request bodies should contain a Subscription object, while successful responses include an Operation object with the updated Subscription.
-
Authorization requires one of the listed OAuth scopes, such as
https://www.googleapis.com/auth/chat.spacesor similar, granting specific permissions.
Updates or renews a Google Workspace subscription. To learn how to use this method, see Update or renew a Google Workspace subscription .
HTTP request
PATCH https://workspaceevents.googleapis.com/v1/{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/meetings.space.created -
https://www.googleapis.com/auth/meetings.space.readonly
For more information, see the Authorization guide .
