Sign in
Workspaces

Update a workspace

Updates the specified workspace. You cannot change a workspace's domain after it's created.

On the application's default workspace, you can update only the policy_id and rule_ids values.

patch/v3/workspaces/{workspace_id}

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.

namestring

A short, descriptive name for the workspace.

policy_idstring nullable

The ID of the policy to attach to the workspace. Set a policy ID to attach the policy, set null to detach the current policy, or omit the field to keep the current value. The policy must belong to your application.

rule_idsstring[] nullable

The IDs of any rules to attach to the workspace. Set an array to replace the current rules, set null or an empty array to detach all rules, or omit the field to keep the current value. Each rule must belong to your application.

Example request

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

Response

Success. Returns updated 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.