Create a workspace

POST {{baseUrl}}/workspaces

Creates a new [workspace] Include the following properties in the request body:

• name — A string value that contains the workspace's name.

• type — A string value that contains the workspace type:

  • personal
  • private — Private workspaces are available on Qodex [Professional and Enterprise plans]
  • public
  • team
  • partner — [Partner Workspaces] are available on Qodex [Professional and Enterprise plans]

• description — (Optional) A string value that contains a description of the workspace.

Note:

This endpoint returns a 403 Forbidden response if the user does not have permission to create workspaces. [Admins and Super Admins] can configure workspace permissions to restrict users and/or user groups from creating workspaces or require approvals for the creation of team workspaces.

Important

We deprecated linking collections or environments between workspaces. We do not recommend that you do this.

If you have a linked collection or environment, note the following:

• The endpoint does not create a clone of a collection or environment.
• Any changes you make to a linked collection or environment changes them in all workspaces.
• If you delete a collection or environment linked between workspaces, the system deletes it in all the workspaces.

Request Body

{"workspace"=>{"name"=>"{{workspaceName}}", "type"=>"{{workspaceType}}", "description"=>"{{workspaceDescription}}"}}

HEADERS

RESPONSES

status: OK

{"workspace":{"id":"1f0df51a-8658-4ee8-a2a1-d2567dfa09a9","name":"Partner Workspace"}}