Create a workspace in a company

Creates a new workspace in one of the company's billing accounts. Endpoint authorized with a company-scoped API key, or by a company admin user.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Company ID

Body Params

The workspace to create

Request to create a workspace in a company

int64

Credits reserved for the new workspace in each billing period. When omitted the workspace draws on the account's unallocated credits alongside its siblings.

boolean

When true, cloud runs in the new workspace are blocked once its credit allocation is exhausted for the billing period. Requires credit_allocation.

string

The billing account that will own the new workspace. Required when the company owns more than one account. When omitted and the company owns exactly one account, that account is used.

string
required
length between 1 and 255

The display name for the new workspace

owner_user_ids
array of strings
length ≤ 50

Users to grant the owner role in the new workspace. Each must already be a member of the company, holding either a role in one of its workspaces or a company role; naming a user outside the company, or one that does not exist, is rejected. If any grant fails the whole creation is rolled back, so keep the list to the users who genuinely need to own the workspace.

owner_user_ids
Responses

Language
Credentials
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json