v1

latestOpenAPI 3.0.12026-08-064278250.7 KB

workspaces

Update a workspace

Update the editable details of an existing workspace: company name, display name, notifications level, and the user and device limits. The workspace is identified by the workspace header. This is a full update: fields that are omitted are reset to their defaults, and omitting both maxProtectedUsers and maxDevicesLimit makes the workspace unlimited. The maxDevicesLimit cannot exceed 3x the effective user limit, and maxProtectedUsers cannot be lowered below the number of users currently protected in the workspace.

patch/v1/workspaces

Headers

Workspacestring required

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

Request body

companyNamestring

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

displayNamestring

The name displayed for the workspace from the user interface.

notificationsLevel'none' | 'parent' | 'localAdmins' | 'all'

The workspace admin portal users who receive notifications.

enableLimitsboolean

Flag indicating whether to enable limits on the number of protected users and devices. If true, maxProtectedUsers and maxDevicesLimit must be provided. If false, the workspace will be unlimited.

maxProtectedUsersinteger

The maximum number of protected users allowed in the workspace. Omit (together with maxDevicesLimit) to make the workspace unlimited. The new limit cannot be lower than the number of users currently protected in the workspace.

overCapacityAllowancenumber

The percentage by which Coro can exceed the maximum allowed users (e.g., 10 = 10%).

maxDevicesLimitinteger

The maximum number of protected devices allowed in the workspace. Cannot exceed 3x the effective user limit (maxProtectedUsers + overCapacityAllowance%).

validboolean

Example request

{
  "companyName": "Company Name",
  "displayName": "Child workspace",
  "notificationsLevel": "all",
  "enableLimits": true,
  "maxProtectedUsers": 25,
  "overCapacityAllowance": 10,
  "maxDevicesLimit": 25
}

Response

Success

idstring required

The unique identifier of the workspace.

companyNamestring required

The name of the company.

displayNamestring required

The name displayed for the workspace from the user interface.

type'regular' | 'channel' | 'child' required

The type of workspace.

domainstring required

The workspace domain.

maxProtectedUsersinteger

The maximum number of protected users allowed in the workspace.

overCapacityAllowancenumber

The fraction by which Coro can exceed the maximum allowed users (e.g. 0.10 = 10%).

maxDevicesLimitinteger

The maximum number of protected devices allowed in the workspace.

limitedboolean

Whether this workspace enforces user and device limits.

notificationsLevel'none' | 'parent' | 'localAdmins' | 'all'

The workspace admin portal users who receive notifications.

parentWorkspaceIdstring

The unique identifier of the parent/channel workspace.

protectedDevicesinteger

The number of protected devices in the workspace.

childrenstring[]

A list of any child workspaces provisioned for this workspace.

mainAdminEmailstring

The admin portal user email address provided when the workspace was created.

adminEmailsstring[]

The email addresses of all admin portal users associated with the workspace.

pendingAdminEmailsstring[]

The email addresses of all pending admins associated with the workspace.

lastAdminLoginTimeinteger

The most recent login to the workspace by an admin user, in UNIX format, including milliseconds.

workspaceCreationTimeinteger

The date the workspace was created, in UNIX format, including milliseconds.

workspaceCreationType'msp' | 'internal' | 'api' | 'direct' | 'distributorPortal'

Defines the method and creator of the workspace.<br>

msp – Workspace created via the MSP portal by a user with the MSP role.<br>
internal – Workspace created via the MSP portal by a user with the Global role.<br>
api – Workspace provisioned through the API.<br>
direct – Workspace created via the self-service sign-up process.

Example response

{
  "id": "corodevonmicrosoftcom_EZ90_b",
  "companyName": "Company Name",
  "displayName": "Child workspace",
  "type": "child",
  "domain": "child-workspace.com",
  "maxProtectedUsers": 25,
  "overCapacityAllowance": 0.1,
  "maxDevicesLimit": 25,
  "limited": true,
  "notificationsLevel": "none",
  "parentWorkspaceId": "coroparent_123",
  "lastAdminLoginTime": 1693562400000,
  "workspaceCreationTime": 1641009600000,
  "workspaceCreationType": "direct"
}