Method: subscriptions.create

  • This method creates a Google Workspace subscription and provides instructions on how to use it through a provided link.

  • The request can be previewed without creating a subscription by setting thevalidateOnly query parameter totrue.

  • A successful response includes anOperation object containing the newly createdSubscription details.

  • Authorization requires one of the listed OAuth scopes, such ashttps://www.googleapis.com/auth/chat.spaces or others related to chat, messages, memberships, and meetings, with more information available in the Authorization guide.

Creates a Google Workspace subscription. To learn how to use this method, seeCreate a Google Workspace subscription.

HTTP request

POST https://workspaceevents.googleapis.com/v1/subscriptions

The URL usesgRPC Transcoding syntax.

Query parameters

Parameters
validateOnly

boolean

Optional. If set totrue, validates and previews the request, but doesn't create the subscription.

Request body

The request body contains an instance ofSubscription.

Response body

If successful, the response body contains a newly created instance ofOperation.

  • Themetadata field contains an empty array.
  • Theresponse field contains a new 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 theAuthorization guide.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-07-10 UTC.