Method: subscriptions.create
Stay organized with collections
Save and categorize content based on your preferences.
HTTP request
POST https://workspaceevents.googleapis.com/v1beta/subscriptions
The URL uses gRPC Transcoding syntax.
Query parameters
| Parameters |
validateOnly |
boolean
Optional. If set to true, validates and previews the request, but doesn't create the subscription.
|
Request body
The request body contains an instance of Subscription.
Response body
If successful, the response body contains a newly created instance of Operation.
- The
metadata field contains an empty array. - The
response field contains a new 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\u003eCreates a Google Workspace subscription using an HTTP POST request to a specified URL.\u003c/p\u003e\n"],["\u003cp\u003eAllows validation and preview of the request without creating a subscription using the \u003ccode\u003evalidateOnly\u003c/code\u003e query parameter.\u003c/p\u003e\n"],["\u003cp\u003eRequires providing a Subscription object in the request body and returns an Operation object in the response, containing the new subscription details.\u003c/p\u003e\n"],["\u003cp\u003eRequires specific authorization scopes, such as chat and meeting related scopes, for access control and permissions.\u003c/p\u003e\n"],["\u003cp\u003eIs currently available as part of the Google Workspace Developer Preview Program.\u003c/p\u003e\n"]]],["This document details creating a Google Workspace subscription via a `POST` request to `https://workspaceevents.googleapis.com/v1beta/subscriptions`. The request includes optional `validateOnly` query parameter for previewing. The request body requires a `Subscription` instance, and successful responses return an `Operation` instance, which contains an array and a new `Subscription` instance. Creating subscription needs to use one of the authorization scopes. This feature is in developer preview.\n"],null,["# Method: subscriptions.create\n\n- [HTTP request](#body.HTTP_TEMPLATE)\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\nCreates a Google Workspace subscription. To learn how to use this method, see [Create a Google Workspace subscription](https://developers.google.com/workspace/events/guides/create-subscription).\n\n### HTTP request\n\n`POST https://workspaceevents.googleapis.com/v1beta/subscriptions`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Query parameters\n\n| Parameters ||\n|----------------|----------------------------------------------------------------------------------------------------------------|\n| `validateOnly` | `boolean` Optional. If set to `true`, validates and previews the request, but doesn't create 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 a newly created instance of [Operation](/workspace/events/reference/rest/v1beta/operations#Operation).\n\n- The `metadata` field contains an empty array.\n- The `response` field contains a new 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)."]]
