Connect Mailbox

POST

/onebox/connect

Connect one or every purchased mailbox to Onebox.

Queues a background job per mailbox; the call returns as soon as the work is queued, so a 200 means accepted, not connected. Poll GET /onebox/connected-mailboxes to see when a mailbox becomes active.

Only working mailboxes can be connected — the mailbox must be ACTIVE, sitting on an ACTIVE domain, under a subscription that is ACTIVE or RENEWING. Anything else is rejected with 400.

Examples

Connect a single mailbox:

{ "userId": "K5PF9Y068AMDGENV5BTCNJJZK55F", "email": "andrew.lawyer@aurumlawyer.com" }

Connect every working mailbox the user owns:

{ "userId": "K5PF9Y068AMDGENV5BTCNJJZK55F", "connectAll": true }

connectAll must be a real JSON boolean. The string "true" is rejected.

Request

Authorization

API Key

Add parameter in header

cmr-x-api-key

Example:

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

Body Params application/jsonRequired

Examples

Responses

🟢200Queued

application/json

Connection jobs were queued. count is how many mailboxes were queued.

Bodyapplication/json

🟠400Not a working mailbox

🟠401Unauthorized

🟠404User not found

🟠422Validation Error

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://customers.coldmailreseller.com/api/v1/integration/onebox/connect' \
--header 'cmr-x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "userId": "K5PF9Y068AMDGENV5BTCNJJZK55F",
    "email": "andrew.lawyer@aurumlawyer.com",
    "connectAll": false
}'

Response Example

200 - Example 1

{
    "status": 200,
    "message": "1 mailbox connection(s) queued",
    "data": {
        "queued": true,
        "count": 1,
        "mailboxes": [
            {
                "email": "andrew.lawyer@aurumlawyer.com",
                "provider": "GMAIL",
                "jobId": "onebox-connect-andrew.lawyer@aurumlawyer.com",
                "connectionId": "bec102ab-d0d1-42b5-9d5d-feda42893ef3"
            }
        ]
    }
}

Modified at 2026-10-02 13:25:19

Get Placement Reports

List Connected Mailboxes

Connect Mailbox

Examples#

Request

Responses

Examples