Create a workspace - Workspaces - API Reference

POST

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

Creates a workspace. Only name is required. Omit domain to create a workspace that holds only the grants you assign to it. Those grants can have any email domain.

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. Automatic grouping needs a domain, so leave this field false on a workspace without one.

Default: false

Example: true

domainstring

The email domain associated with the workspace, such as nylas.com. Optional. Set it when you want Nylas to group grants by domain automatically. Each domain can belong to only one workspace per application, and Nylas returns a 400 error if the domain is already in use. Domain matching for automatic grouping is exact and case-sensitive, so subdomains don't match their parent domain. You can't add, change, or remove 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>"] }'