Page Summary
-
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 the
validateOnlyquery parameter totrue. -
A successful response includes an
Operationobject containing the newly createdSubscriptiondetails. -
Authorization requires one of the listed OAuth scopes, such as
https://www.googleapis.com/auth/chat.spacesor 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, see Create a Google Workspace subscription .
For a subscription on a Chat target resource , you can create a subscription as:
-
A Chat app by specifying an authorization scope that begins with
chat.appand getting one-time administrator approval. To learn more, see Authorize as a Chat app with administrator approval . -
A user by specifying an authorization scope that doesn't include
appin its name. To learn more, see Authorize as a Chat user .
HTTP request
POST https://workspaceevents.googleapis.com/v1/subscriptions
The URL uses gRPC Transcoding syntax.
Query parameters
| Parameters | |
|---|---|
validateOnly
|
Optional. If set to |
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
metadatafield contains an empty array. - The
responsefield 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/chat.app.memberships -
https://www.googleapis.com/auth/chat.app.memberships.readonly -
https://www.googleapis.com/auth/chat.app.messages.readonly -
https://www.googleapis.com/auth/chat.app.spaces -
https://www.googleapis.com/auth/chat.app.spaces.readonly -
https://www.googleapis.com/auth/meetings.space.created -
https://www.googleapis.com/auth/meetings.space.readonly
For more information, see the Authorization guide .
