Export Mailboxes to Platform

POST

/exports/platform-exports

Exports a set of mailboxes to an external platform using stored credentials.

The export runs asynchronously. Listen for the mailbox.exported webhook event to confirm completion.

{
  "mailboxIds": ["GP6M2J2DHXM3F2J40S8AP316R2QR"],
  "credentialId": "cred_V2M9KP3XAQZL"
}

Request

Authorization

API Key

Add parameter in header

cmr-x-api-key

Example:

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

Query Params

Body Params application/jsonRequired

Examples

Responses

🟢200Success

application/json

Mailboxes will export shortly

Bodyapplication/json

🟠401Unauthorized

🟠422Unprocessable Entity

🟠404Not Found

🟠403Forbidden

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://customers.coldmailreseller.com/api/v1/integration/exports/platform-exports?userId=H8M9JV2S9HMPYFQW393AZHQVD4XM' \
--header 'cmr-x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "mailboxIds": [
        "GP6M2J2DHXM3F2J40S8AP316R2QR"
    ],
    "credentialId": "cred_V2M9KP3XAQZL"
}'

Response Example

200 - Example 1

{
    "status": 200,
    "message": "Mailboxes will export shortly",
    "data": null,
    "actionId": "ACT_7a078272-0fa7-4db4-a85b-c78697dacea1"
}

Modified at 2026-08-06 06:20:56

Add Platform Credential

Remove Platform Credential