Update a workspace - Workspaces - API Reference

PATCH

/v3/workspaces/{workspace_id}

Updates the specified workspace.

NYLAS API KEY

Parameters

Path parameters

workspace_id*string

ID of the workspace to access.

Example: "123e4567-e89b-12d3-a456-426614174000"

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.

Example: true

domainstring

The top-level domain associated with the workspace.

Example: "nylas.com"

namestring

A short, descriptive name for the workspace.

Example: "The Nylas Workspace"

Responses

request_idstring

The request ID.

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

dataobject

curl --request PATCH \ --url "https://api.us.nylas.com/v3/workspaces/<WORKSPACE_ID>" \ --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 }'