Export Mailboxes

GET

/exports/platform-exports

Queues mailboxes for export to the platform linked to the given credentialId.

Query Parameters

Name	Type	Required	Description	Example
`userId`	`string`	Yes	Unique identifier for the user	`BVZGM5TE9BMP3PP0VWGW943RGV1B`

Notes

The platform, credentials, and metadata are all read from the stored credential — nothing sensitive is sent on this route.

Submitting the same mailbox twice is safe.

Returns 404 only if none of the provided mailbox IDs resolve to a valid mailbox for this user.

Request

Authorization

API Key

Add parameter in header

cmr-x-api-key

Example:

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

Query Params

Body Params application/jsonRequired

Example

{
  "credentialId": "A1B2C3D4E5F6G7H8",
  "mailboxIds": [
    "4EV4X7Q6DJ4DCPKX3VM46RN4HRY4",
    "DZARY9058TM11AH8AQ6PFHWDPQTY"
  ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://customers.coldmailreseller.com/api/v1/integration/exports/platform-exports?userId=BVZGM5TE9BMP3PP0VWGW943RGV1B' \
--header 'cmr-x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
  "credentialId": "A1B2C3D4E5F6G7H8",
  "mailboxIds": [
    "4EV4X7Q6DJ4DCPKX3VM46RN4HRY4",
    "DZARY9058TM11AH8AQ6PFHWDPQTY"
  ]
}'

Responses

🟢200Success

application/json

Bodyapplication/json

Example

{
  "status": 200,
  "message": "Mailboxes will export shortly",
  "data": null
}

🟠403Forbidden

🟠404Not Found

🟠422Unprocessable Entity

Modified at 2026-06-23 16:21:02

Remove Platform Credential

Re-export a mailbox (Oauth)