Create a workspace

Create a new workspace. Each workspace represents a separate organization. Managed service providers (MSPs) can create child workspaces for each of their customers.

SecurityJWT
Request
header Parameters
Workspace
required
string

The workspace identifier, which isolates API requests inside the provided workspace scope.

Example: corodevonmicrosoftcom_TX7T_u
Request Body schema: application/json
companyName
required
string

The name of the company for which the workspace is created.

displayName
required
string

The name displayed for the workspace from the user interface.

type
required
string

The type of workspace to be created. Types include: regular, for individual companies, channel for the MSP parent level, and child for MSP customers.

Enum: "regular" "channel" "child"
domain
required
string

The workspace domain.

adminEmail
required
string

The email address of the admin portal user who manages the workspace.

maxProtectedUsers
integer <int32> >= 0

The maximum number of protected users allowed in the workspace.

notificationsLevel
required
string
Default: "all"

The workspace admin portal users who receive notifications.

Enum: "none" "parent" "localAdmins" "all"
Responses
201

Created

400

Bad request, validation error

401

Unauthorized request

403

Access forbidden

429

Too Many Requests

500

Internal server error

post/v1/workspaces
Request samples
application/json
{
  • "companyName": "Company Name",
  • "displayName": "Child workspace",
  • "type": "child",
  • "domain": "child-workspace.com",
  • "adminEmail": "admin@child-workspace.com",
  • "maxProtectedUsers": 25,
  • "notificationsLevel": "all"
}
Response samples
application/json
{
  • "id": "corodevonmicrosoftcom_EZ90_b",
  • "companyName": "Company Name",
  • "displayName": "Child workspace",
  • "type": "child",
  • "domain": "child-workspace.com",
  • "maxProtectedUsers": 25,
  • "notificationsLevel": "none",
  • "parentWorkspaceId": "coroparent_123",
  • "protectedDevices": 0,
  • "children": [
    ],
  • "mainAdminEmail": "string",
  • "adminEmails": [
    ],
  • "pendingAdminEmails": [
    ],
  • "lastAdminLoginTime": 1693562400000,
  • "workspaceCreationTime": 1641009600000,
  • "workspaceCreationType": "direct"
}