Connect Inboxes (Export to Platform)

POST

/v1/connect-inbox

Submit platform credentials and a list of inboxes to connect/export. Creates a connect_inbox record (upserted by platform+workspace+client) and an ExportHistory record with status IN_PROGRESS. Also fires Google Sheets logging in the background.

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Body Params application/jsonRequired

Example

{
    "platform_type": "instantly",
    "platform_email": "user@instantly.ai",
    "platform_pass": "mypassword123",
    "inbox_type": "google",
    "inboxes": [
        {
            "email": "john@b2bforcelabs.com",
            "password": "john@2026!",
            "name": "John Doe"
        }
    ],
    "workspaceName": "Main Workspace"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location '/v1/connect-inbox' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "platform_type": "instantly",
    "platform_email": "user@instantly.ai",
    "platform_pass": "mypassword123",
    "inbox_type": "google",
    "inboxes": [
        {
            "email": "john@b2bforcelabs.com",
            "password": "john@2026!",
            "name": "John Doe"
        }
    ],
    "workspaceName": "Main Workspace"
}'

Responses

🟢200

application/json

Inboxes queued for connection

Bodyapplication/json

Example

{
    "status": 200,
    "message": "Inboxes will be connected within 24 hours based on the queue of inboxes.",
    "data": {
        "record": {
            "id": "ci_abc1",
            "platform": "instantly",
            "email": "user@instantly.ai",
            "workspaceName": "Main Workspace",
            "selectedMailboxes": [
                {
                    "email": "john@b2bforcelabs.com"
                }
            ]
        },
        "exportHistory": {
            "id": "exp_abc3",
            "jobId": "EXB3C4",
            "totalMailboxes": 1,
            "platform": "instantly",
            "exportStatus": "IN_PROGRESS",
            "createdAt": "2025-10-02T15:45:32.267Z"
        }
    }
}

🟠400

🟠401

🔴500

Update Third Party Account Details

Get All Subscriptions