1. Platform
Cold Mail Reseller
  • Cold Mail Reseller API Documentation
  • Users
    • Retrieve all users
      GET
    • Get User Details
      GET
    • Create User
      POST
    • Update User Details
      PUT
    • Delete User
      DELETE
  • Geo
    • Get Countries List
      GET
    • Get States of a Country
      GET
  • Domains
    • Renewal
      • Domain Renewal Overview
      • Get domain renewal pricing
      • Renew domain
      • Enable or disable domain auto-renew
    • Get Domains For User
      GET
    • Suggest Available Domains
      POST
    • Get Single Available Domain
      POST
    • Check If Workspace Exists
      POST
    • Add domain forwarding
      POST
    • Add email forwarding
      POST
    • Add Google Client ID to Domain
      POST
    • Remove domains
      DELETE
  • Dns
    • Get dns records for a domain
      GET
    • Adds dns record
      POST
    • Update dns records
      PUT
    • Delete dns records
      DELETE
  • Orders
    • Get Order Details
    • Get Order Status
    • Creates order json
    • Order mailboxes (json)
    • Process the Order
    • Create Order
    • Add mailboxes to a subscription
  • Mailboxes
    • Get mailboxes for user
    • Get mailbox details by id
    • Get Mailbox Admin Details
    • Update mailbox details
    • Remove mailbox
  • Subscriptions
    • 1+ Year Subscriptions
      • One Plus Year Subscription Overview
      • Subscription Recreation
    • Get All Subscriptions
    • Renew Subscriptions
    • Toggle Auto renewal
    • Cancel Subscription
  • Webhooks
    • Overview
    • Events
      • Mailbox Events
      • Prewarmup Events
      • Domain Events
      • Subscription Events
  • Export
    • Platform
      • Platform Exports API
      • Get Connected Platforms
        GET
      • Add Platform Credentials
        POST
      • Remove Platform Credential
        DELETE
      • Export Mailboxes
        GET
    • Re-export a mailbox (Oauth)
      POST
  • Pre-warmup
    • Sandbox
      • Sandbox Pre-Warmup Integration
      • [SANDBOX] - Get All Pre-Warmup Mailboxes
      • [SANDBOX] - Order Pre-Warmup Mailboxes
      • [SANDBOX] - Reset Pre-Warmup Data
    • Get All Pre-Warmup Mailboxes
    • Order Pre-Warmup Mailboxes
  • Get Wallet Details
    GET
  • Send error
    POST
  1. Platform

Export Mailboxes

GET
/exports/platform-exports
Queues mailboxes for export to the platform linked to the given credentialId.

Query Parameters#

NameTypeRequiredDescriptionExample
userIdstringYesUnique identifier for the userBVZGM5TE9BMP3PP0VWGW943RGV1B

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: ********************
or
Query Params

Body Params application/jsonRequired

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

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
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
Previous
Remove Platform Credential
Next
Re-export a mailbox (Oauth)
Built with