Method: subscriptions.patch
Stay organized with collections
Save and categorize content based on your preferences.
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 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
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
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.
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 2025-07-07 UTC.
[null,null,["Last updated 2025-07-07 UTC."],[[["\u003cp\u003eThis API updates or renews a Google Workspace subscription using a PATCH request to the specified URL.\u003c/p\u003e\n"],["\u003cp\u003eYou can optionally specify an \u003ccode\u003eupdateMask\u003c/code\u003e to target specific fields for updating and \u003ccode\u003evalidateOnly\u003c/code\u003e to preview the request without applying changes.\u003c/p\u003e\n"],["\u003cp\u003eThe request body should contain a \u003ccode\u003eSubscription\u003c/code\u003e object and the successful response will include an \u003ccode\u003eOperation\u003c/code\u003e object with the updated \u003ccode\u003eSubscription\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization requires specific OAuth scopes related to Google Chat or Google Meet, as detailed in the documentation.\u003c/p\u003e\n"]]],["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"],null,["# Method: subscriptions.patch\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n\n| **Developer Preview:** Available as part of the [Google Workspace Developer Preview Program](/workspace/preview), which grants early access to certain features.\n\nUpdates or renews a Google Workspace subscription. To learn how to use this method, see [Update or renew a Google Workspace subscription](https://developers.google.com/workspace/events/guides/update-subscription).\n\n### HTTP request\n\n`PATCH https://workspaceevents.googleapis.com/v1beta/{subscription.name=subscriptions/*}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|---------------------|------------------------------------------------------------------------------------------------|\n| `subscription.name` | `string` Identifier. Resource name of the subscription. Format: `subscriptions/{subscription}` |\n\n### Query parameters\n\n| Parameters ||\n|----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `updateMask` | `string (`[FieldMask](https://protobuf.dev/reference/protobuf/google.protobuf/#field-mask)` 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`](/workspace/events/reference/rest/v1beta/subscriptions#Subscription.FIELDS.expire_time): The timestamp when the subscription expires. - [`ttl`](/workspace/events/reference/rest/v1beta/subscriptions#Subscription.FIELDS.ttl): The time-to-live (TTL) or duration of the subscription. - [`eventTypes`](/workspace/events/reference/rest/v1beta/subscriptions#Subscription.FIELDS.event_types): The list of event types to receive about the target resource. When using the `*` wildcard (equivalent to `PUT`), omitted fields are set to empty values and rejected if they're invalid. |\n| `validateOnly` | `boolean` Optional. If set to `true`, validates and previews the request, but doesn't update the subscription. |\n\n### Request body\n\nThe request body contains an instance of [Subscription](/workspace/events/reference/rest/v1beta/subscriptions#Subscription).\n\n### Response body\n\nIf successful, the response body contains an instance of [Operation](/workspace/events/reference/rest/v1beta/operations#Operation).\n\n- The `metadata` field contains an empty array.\n- The `response` field contains an updated instance of [Subscription](/workspace/events/reference/rest/v1beta/subscriptions#Subscription).\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/chat.spaces`\n- `\n https://www.googleapis.com/auth/chat.spaces.readonly`\n- `\n https://www.googleapis.com/auth/chat.messages`\n- `\n https://www.googleapis.com/auth/chat.messages.readonly`\n- `\n https://www.googleapis.com/auth/chat.messages.reactions`\n- `\n https://www.googleapis.com/auth/chat.messages.reactions.readonly`\n- `\n https://www.googleapis.com/auth/chat.memberships`\n- `\n https://www.googleapis.com/auth/chat.memberships.readonly`\n- `\n https://www.googleapis.com/auth/meetings.space.created`\n- `\n https://www.googleapis.com/auth/meetings.space.readonly`\n- `\n https://www.googleapis.com/auth/drive`\n- `\n https://www.googleapis.com/auth/drive.file`\n- `\n https://www.googleapis.com/auth/drive.metadata`\n- `\n https://www.googleapis.com/auth/drive.metadata.readonly`\n- `\n https://www.googleapis.com/auth/drive.readonly`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]
