[SANDBOX] - Order Pre-Warmup Mailboxes

POST

sandbox/pre-warmup/order

Creates a mock pre-warmup order at zero cost. Domain, mailbox, and subscription rows are exactly as in production. A $0 wallet debit is recorded. One or two webhooks fire asynchronously depending on the scenario field.

Scenarios

Sandbox only. The scenario field exists exclusively in the sandbox API. The live pre-warmup order endpoint does not accept or recognise this field — omit it entirely when switching to production.

Scenario	Records created	Webhooks fired
`success`	Domain, mailbox, subscription rows for all ordered domains	`prewarmup.order.success`
`full_failure`	None	`prewarmup.order.failed`
`partial_failure`	Domain, mailbox, subscription rows for all domains except the failed	`prewarmup.order.failed` (failed domains) + `prewarmup.order.success` (remaining domains)

Request

Authorization

API Key

Add parameter in header

cmr-x-api-key

Example:

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

Query Params

Body Params application/json

Example

{
    "order": [
        {
            "domain": "yourcompanynow.info",
            "forwardTo": "coldmailreseller.com"
        },
        {
            "domain": "example2.com",
            "forwardTo": "coldmailreseller.com"
        }
    ],
    "serviceProvider": "GOOGLE",
    "microsoftOauthRoute": "",
    "google": {
        "googleOauthRoute": "https://accounts.google.com/o/oauth2/v2/auth/oauthchooseaccount?access_type=offline...",
        "clientId": "549360251880-maeh4okn7btu9cjtf0l2bt1t5b22sbf8.apps.googleusercontent.com",
        "appName": "Outreach App"
    },
    "scenario": "success",
    "autoRenew": true
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'https://customers.coldmailreseller.com/api/v1/integrationsandbox/pre-warmup/order?userId=M8QJWQRZSXMHZTKKG37YV9MWTV48' \
--header 'cmr-x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "order": [
        {
            "domain": "yourcompanynow.info",
            "forwardTo": "coldmailreseller.com"
        },
        {
            "domain": "example2.com",
            "forwardTo": "coldmailreseller.com"
        }
    ],
    "serviceProvider": "GOOGLE",
    "microsoftOauthRoute": "",
    "google": {
        "googleOauthRoute": "https://accounts.google.com/o/oauth2/v2/auth/oauthchooseaccount?access_type=offline...",
        "clientId": "549360251880-maeh4okn7btu9cjtf0l2bt1t5b22sbf8.apps.googleusercontent.com",
        "appName": "Outreach App"
    },
    "scenario": "success",
    "autoRenew": true
}'

Responses

🟢201Created

application/json

Bodyapplication/json

Example

{
    "status": 201,
    "message": "Prewarmup order created and queued for processing, make sure to have enough balance in your wallet!",
    "data": {
        "orderId": "7MRN1VBVNF4K61MD0W24XE779E84"
    }
}

🟠422Unprocessable Entity

🟠404Not Found

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

[SANDBOX] - Get All Pre-Warmup Mailboxes

[SANDBOX] - Reset Pre-Warmup Data

[SANDBOX] - Order Pre-Warmup Mailboxes

Scenarios#

Request

Request Code Samples

Responses

Scenarios