Skip to main content

Workspace Groups

Updated over 2 weeks ago

A workspace group lets you organize multiple sub-workspaces under a single admin workspace. This guide provides step-by-step instructions on managing sub-workspaces through the Instantly platform and via API.

  • Centralized management of multiple workspaces

  • Shareable Hyper Credits plan and Inbox Placement plan

  • Ability to transfer email accounts between grouped workspaces

You can't view consolidated data from multiple workspaces in one dashboard.

  • Only workspace owners and admins can manage sub-workspaces

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


Adding Sub-Workspaces

You can add sub-workspaces through the dashboard or via API.

Method 1: Through the Dashboard

  1. Click the Workspace Group tab

  2. Click "Add sub workspace" button

  3. Add the workspace:

    • Option A: Enter the workspace ID directly. Go to Workspace & members tab to copy the workspace ID

    • Option B: Select from existing workspaces in the dropdown

  4. Click "Add sub workspace" to send the invitation

  5. Wait for acceptance:

    • The workspace owner receives an email invitation and becomes a sub-workspace once they accept

    • They can see your workspace name and email address in the invite

Method 2: 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.

  4. Check the API documentation here.


Viewing Your Sub-Workspaces

To see all sub-workspaces in your group:

  1. Go to Account & Settings

  2. Click the Workspace Group tab

  3. View the Sub workspaces section

    • Sub-workspace name

    • Sub-workspace ID

    • Date added to group

    • Current status (Accepted/pending invitation)

    • Remove button


Removing Sub-Workspaces

You can remove sub-workspaces at any time. Removal is immediate and doesn't require confirmation from the sub-workspace.

Method 1: Through the Dashboard

  1. Go to the Workspace Group tab

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

  3. Click the Remove button.

Method 2: 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.

  5. Check the API documentation here.


Leaving a Workspace Group

Method 1: Through the Dashboard

  • Only workspace owner can leave a workspace group. If you are a team member in the workspace, please request that the owner leave the group.

  • Go to the Workspace Group tab.

  • Click the Leave workspace group button. The workspace leaves the group immediately.

Method 2: 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.

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

Did this answer your question?