Order Sandbox Pre-warmup

POST

/sandbox/pre-warmup/order

Places a sandbox pre-warmup order with a configurable outcome for testing.

Use the scenario field to simulate different fulfillment outcomes.

Scenarios

"success" — all items succeed (default).

"full_failure" — all items fail.

"partial_failure" — some items fail.

{
  "order": [{ "domain": "sandbox-prewarm.com" }],
  "serviceProvider": "GOOGLE",
  "scenario": "partial_failure"
}

Note: Returns 201 on success.

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

🟢201Created

application/json

Prewarmup order created and queued for processing, make sure to have enough balance in your wallet!

Bodyapplication/json

🟠422Unprocessable Entity

🟠400Bad Request — no workspace

🟠404Not Found

🟠401Unauthorized

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://customers.coldmailreseller.com/api/v1/integration/sandbox/pre-warmup/order?userId=H8M9JV2S9HMPYFQW393AZHQVD4XM' \
--header 'cmr-x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "order": [
        {
            "domain": "sandbox-prewarm.com",
            "forwardTo": "https://acmecorp.com"
        }
    ],
    "serviceProvider": "GOOGLE",
    "scenario": "success",
    "autoRenew": true,
    "billingCycle": "MONTHLY",
    "google": {
        "googleOauthRoute": "string",
        "clientId": "string",
        "appName": "string"
    },
    "microsoftOauthRoute": "string"
}'

Response Example

201 - Example 1

{
    "status": 201,
    "message": "Prewarmup order created and queued for processing, make sure to have enough balance in your wallet!",
    "data": {
        "orderId": "H8M9JV2S9HMPYFQW393AZHQVD4XM"
    },
    "actionId": "ACT_7a078272-0fa7-4db4-a85b-c78697dacea1"
}

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

Get Sandbox Pre-warmup Domains

Reset Sandbox Pre-warmup

Order Sandbox Pre-warmup

Scenarios#

Request

Responses

Scenarios