Method: subscriptions.patch
HTTP request
PATCH https://workspaceevents.googleapis.com/v1beta/{subscription.name=subscriptions/*}
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
subscription.name |
string
Identifier. Resource name of the subscription. Format: subscriptions/{subscription}
|
Query parameters
| 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:
expireTimettleventTypes To fully replace the subscription (the equivalent of PUT), use *. Any omitted fields are updated with empty values.
|
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
metadata field contains an empty array. - The
response field contains an updated instance of Subscription.
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.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-11-14 UTC.
[null,null,["Last updated 2024-11-14 UTC."],[[["This API updates or renews a Google Workspace subscription using a PATCH request to the specified URL."],["You can optionally specify an `updateMask` to target specific fields for updating and `validateOnly` to preview the request without applying changes."],["The request body should contain a `Subscription` object and the successful response will include an `Operation` object with the updated `Subscription`."],["Authorization requires specific OAuth scopes related to Google Chat or Google Meet, as detailed in the documentation."]]],["This documentation details updating Google Workspace subscriptions via a `PATCH` HTTP request to `https://workspaceevents.googleapis.com/v1beta/{subscription.name=subscriptions/*}`. Key actions involve specifying the subscription name in the path and using `updateMask` in query parameters to selectively modify fields like `expireTime`, `ttl`, or `eventTypes`. The request body contains subscription details, while the successful response includes an `Operation` with the updated subscription. Authentication requires specific OAuth scopes. The process allows for request validation without actual modification.\n"]]
