NYnylas
Workspaces

Update workspace assignments

Manually assigns or removes specified grants to or from a specific workspace. You must specify at least one grant ID in either assign_grants or remove_grants. You can include up to 500 grants per list.

Manual assignment doesn't check email domains. You can assign any grant in the application to any workspace, including a workspace without a domain. Assigning a grant that's already in another workspace moves it.

post/v3/workspaces/{workspace_id}/manual-assign

Request

  • Base URL
    https://api.us.nylas.com
  • Auth
    HTTP bearer

Request body

assign_grantsstring[]

A list of grant IDs to be assigned to the workspace.

remove_grantsstring[]

A list of grant IDs to remove from the workspace. Nylas clears each grant's workspace_id. The grant isn't moved to the application's default workspace.

Example request

{
  "assign_grants": [
    "123e4567-e89b-12d3-a456-426614174001"
  ],
  "remove_grants": [
    "123e4567-e89b-12d3-a456-426614174001"
  ]
}

Response

Success. Returns updated grant information.

request_idstring

The request ID.

Example response

{
  "request_id": "5967ca40-a2d8-4ee0-a0e0-6f18ace39a90",
  "data": {
    "application_id": "123e4567-e89b-12d3-a456-426614174000",
    "domain": "nylas.com",
    "grants_assigned": [
      "123e4567-e89b-12d3-a456-426614174001",
      "123e4567-e89b-12d3-a456-426614174003"
    ],
    "grants_removed": [
      "123e4567-e89b-12d3-a456-426614174002"
    ],
    "workspace_id": "123e4567-e89b-12d3-a456-426614174000"
  }
}

Changes

No recorded changes to this operation across all 16 revisions of this API.