Skip to main content
Workspace Groups
Updated over a week ago

Organize multiple workspaces under one Admin workspace

A workspace group allows you to organize multiple workspaces (sub-workspaces) within a single admin workspace. This guide provides step-by-step instructions on managing sub-workspaces through the Instantly platform and via API.
โ€‹

โ€‹The current release only allows you to manage the workspace grouping through the dashboard. It does not allow you to see data from across different workspaces in one place.

Adding Sub-Workspaces

From the Instantly platform

  1. Navigate to Settings > Account.

  2. Go to the Workspace Group tab.

  3. Click the Add sub workspace button.

  4. Enter the workspace ID.

  5. Click Add sub workspace to send an invitation. The workspace becomes a sub-workspace once the invitation is accepted.

Via API

  1. Use the POST /workspace-group-members endpoint.

  2. Set the sub_workspace_id field to the workspace you want to invite.

  3. Send the request. The workspace becomes a sub-workspace once the invitation is accepted.


Removing Sub-Workspaces

From the Instantly platform

  1. Navigate to Settings > Account.

  2. Go to the Workspace Group tab.

  3. Locate the sub-workspace in the Sub workspaces section.

  4. Click the Remove button. The workspace is removed immediately.

Via API

  1. Use the GET /workspace-group-members endpoint to get a list of sub-workspaces.

  2. Identify the sub-workspace to remove using the sub_workspace_id.

  3. Send a DELETE request to the /workspace-group-members/:id endpoint, replacing :id with the appropriate ID.

  4. The sub-workspace is removed immediately.


Leaving a Workspace Group

From the Instantly platform

  1. Navigate to Settings > Account.

  2. Go to the Workspace Group tab.

  3. Click the Leave workspace group button under the Admin workspace section. The workspace leaves the group immediately.

Via API

  1. Call the GET /workspace-group-members/admin endpoint.

  2. Retrieve the workspace_group_member_id.

  3. Send a DELETE request to the /workspace-group-members/:id endpoint, replacing :id with the workspace_group_member_id.

  4. The workspace leaves the group immediately.

Important:

  • A workspace cannot be both an admin and a sub-workspace simultaneously.

  • Only workspace owners and admins can manage sub-workspaces.

  • Only workspace owners can leave a workspace group.

For more details about Workspace API endpoints, check our API documentation here: https://developer.instantly.ai/workspace-group
โ€‹

Did this answer your question?