Skip to main content

How to Transfer Email Accounts Between Workspaces

Learn how to transfer email accounts between workspaces

Updated today

You can transfer your email accounts between admin and sub-workspaces using the Instantly API(custom account tags won't be transferred).

Exception: DFY and Pre-warmed accounts from Instantly need to be transferred by our support team.

Important: Both workspaces must be in the same workspace group before you can transfer accounts between them.

Step 1: Set Up Workspace Group

Invite Sub-Workspaces to Your Group

  1. Navigate to Account & Settings

  2. Click the Workspace Group tab

  3. Click "Add sub workspace" button

  4. Add the workspace:

    • Option A: Enter the workspace ID directly

    • Option B: Select from existing workspaces in the dropdown

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

Accept the Invitation

  • The workspace owner receives an invitation via email

  • They can see your workspace name and email address

  • The workspace becomes a sub-workspace once they accept the invitation


Step 2: Generate API Key

Create Your API Key

This endpoint should be called ONLY with an ADMIN workspace API key.

  1. Go to the admin workspace and navigate to Integrations

  2. Find "API Keys" section in the left sidebar

  3. Select "Version 2" (ensure you're using the latest API version)

  4. Click "Create API Key"

Configure the API Key

  1. Enter a name: Example 'Account Transfer'

  2. Select scopes - Choose the necessary permissions for account transfer

  3. Click "Create" to generate the key

  4. Copy your API key immediately - It won't be shown again

Important: Store your API key securely. Treat it like a password and never share it publicly.


Step 3: Execute the Transfer via API

Now you'll use the API endpoint to transfer the email accounts.

Find Your Workspace IDs

Before making the API call, you need the target and destination workspace IDs:

  1. Go to Account & Settings β†’ Workspace & members

  2. Copy the workspace ID for the admin workspace

  3. Go to the Workspace Group section to locate the ID for the sub-workspaces

Make the API Request

  1. Open the API endpoint - Transfer accounts endpoint

  2. Click "Try it" to open the interactive API tester

  3. Go to the Security section and find the "Bearer Token" field

  4. Paste your API key from Step 2

Configure the request body:

  • emails - Array of email addresses to transfer (can be one or multiple). Separate by commas

  • source_workspace_id - The workspace ID where accounts currently exist

  • destination_workspace_id - The workspace ID where you want to move the accounts

{

"emails": [

],

"source_workspace_id": "51a9792a-4e42-4ee2-b912-xxxxxxxxxxxx,

"destination_workspace_id": "637d5919-f991-48f9-bd5c-xxxxxxxxxxxx"

}

Response: If you see this response, the email accounts have been successfully transferred to the destination workspace.

Did this answer your question?