Create a workspace - Workspaces - API Reference

POST

https://api.us.nylas.com/v3/workspaces

Creates a workspace.

NYLAS API KEY

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.

Default: true

Example: true

domain*string

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

Example: "nylas.com"

name*string

A short, descriptive name for the workspace.

Example: "The Nylas Workspace"

policy_idstring

The ID of the policy to attach to the workspace.

Example: "6dcc5d92-8a55-4ce8-85a8-2f4275f8f0a0"

rule_idsarray<string>

The IDs of any rules to attach to the workspace.

Example: ["3f2504e0-4f89-41d3-9a0c-0305e82c3301"]

Responses

request_idstring

The request ID.

Example: "5967ca40-a2d8-4ee0-a0e0-6f18ace39a90"

dataobject

curl --request POST \ --url "https://api.us.nylas.com/v3/workspaces" \ --header 'Accept: application/json' \ --header 'Authorization: Bearer <NYLAS_API_KEY>' \ --header 'Content-Type: application/json' \ --data '{ "name": "The Nylas Workspace", "domain": "nylas.com", "auto_group": true, "policy_id": "<POLICY_ID>", "rule_ids": ["<RULE_ID>"] }'