Skip to navigation
Sigma REST APIWorkspaces

Create a workspace

View as Markdown

This endpoint allows clients to create a workspace with specific characteristics.

Usage notes

  • Set NoDuplicates to true to prevent the creation of a workspace with a name that already exists.

Usage scenarios

  • Initial setup: Useful for users setting up a new workspace after signing up.
  • Project separation: Helps in creating separate workspaces for different projects or teams.

Best practices

  • Check for existing names: Before setting noDuplicates to true, make sure to search for existing workspace names to avoid conflicts.
  • Consistent naming conventions: Adopt a consistent naming convention for workspaces to ensure clarity and avoid confusion.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Request

The request body.
namestringRequired
Name of the new workspace.
noDuplicatesbooleanOptional
Set to true to avoid creating a workspace with a duplicate name.

Response

The response body.
Workspace detailsobject
OR
object