Sign in
Workspaces

Create a workspace

Creates a workspace.

post/v3/workspaces

Request body

auto_groupboolean

When true, specifies that newly created grants in the application are automatically assigned to the workspace if their email address' domain matches the domain.

domainstring required

The top-level domain associated with the workspace. You can't change the domain after the workspace is created.

namestring required

A short, descriptive name for the workspace.

policy_idstring

The ID of the policy to attach to the workspace.

rule_idsstring[]

The IDs of any rules to attach to the workspace.

Example request

{
  "auto_group": true,
  "domain": "nylas.com",
  "name": "The Nylas Workspace",
  "policy_id": "6dcc5d92-8a55-4ce8-85a8-2f4275f8f0a0",
  "rule_ids": [
    "3f2504e0-4f89-41d3-9a0c-0305e82c3301"
  ]
}

Response

Success. Returns new Workspace object.

request_idstring

The request ID.

Example response

{
  "request_id": "5967ca40-a2d8-4ee0-a0e0-6f18ace39a90",
  "data": {
    "application_id": "ad410018-d306-43f9-8361-fa5d7b2172e0",
    "auto_group": true,
    "created_at": 1756379932,
    "domain": "nylas.com",
    "name": "The Nylas Workspace",
    "policy_id": "6dcc5d92-8a55-4ce8-85a8-2f4275f8f0a0",
    "rule_ids": [
      "3f2504e0-4f89-41d3-9a0c-0305e82c3301"
    ],
    "updated_at": 1756379932,
    "workspace_id": "abf6ff99-05ad-4c0a-aaf8-400aacf2470a"
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.