Creates a workspace inside the connected organization.
Optionally grant it seats from the organization pool with
seatAllocation. Allocating more than the pool has available is
rejected with 400, unless the organization's seats are added on
demand (pay as you go): then the missing seats are added to the
subscription instead. Requires the connected workspace to be an
organization (otherwise 403).
Authorization
bearerAuth An API key created under Settings → API & Webhooks.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/workspaces" \ -H "Content-Type: application/json" \ -d '{ "name": "Acme Inc.", "seatAllocation": 2 }'{ "data": { "id": "string", "name": "string", "avatar": "string", "seatAllocation": 0, "sendersUsed": 0, "mailboxesUsed": 0, "seatsUsed": 0, "ownerId": "string", "members": [ { "id": "string", "email": "string", "username": "string", "role": "owner" } ], "orgMembers": [ { "id": "string", "email": "string", "username": "string" } ], "invites": [ { "identifier": "string", "role": "admin", "createdAt": "2019-08-24T14:15:22Z" } ] }}Search domains to buy GET
Domains matching a keyword (or one exact domain), with availability, whether Google Workspace and Microsoft 365 can host each, and the first-year price. Needs the managed mailboxes feature on the workspace (`403`, `code: feature-disabled`).
Delete a workspace DELETE
Removes the workspace from the organization. Rejected with `400` while it still has connected sender accounts or mailboxes, disconnect them first.