Method: subscriptions.patch

  • 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.spaces or 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.

For a subscription on a Chat target resource, you can update a subscription as:

HTTP request

PATCH https://workspaceevents.googleapis.com/v1/{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:

  • expireTime: The timestamp when the subscription expires.
  • ttl: The time-to-live (TTL) or duration of the subscription.
  • eventTypes: 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.
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/chat.app.memberships
  • https://www.googleapis.com/auth/chat.app.memberships.readonly
  • https://www.googleapis.com/auth/chat.app.all.memberships.readonly
  • https://www.googleapis.com/auth/chat.app.messages.readonly
  • https://www.googleapis.com/auth/chat.app.all.messages.readonly
  • https://www.googleapis.com/auth/chat.app.spaces
  • https://www.googleapis.com/auth/chat.app.spaces.readonly
  • https://www.googleapis.com/auth/chat.app.all.spaces.readonly
  • https://www.googleapis.com/auth/chat.app.all.users.readstate.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.