Create Placement Order

POST

/placement

Creates a placement test order for one or more mailboxes.

Charges the partner wallet and queues seed emails to test inbox deliverability across Gmail and Outlook mailboxes

If aiInsight: true, an additional AI-powered deliverability report is generated once results are ready — this incurs an extra charge.

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

Order created and queued. Use orderId to poll results via GET /placement/reports.

Bodyapplication/json

🟠401Unauthorized

🟠400Bad Request

🟠402Payment Required

🟠404Not Found

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://customers.coldmailreseller.com/api/v1/integration/placement?userId=H8M9JV2S9HMPYFQW393AZHQVD4XM' \
--header 'cmr-x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "mailboxIds": [
        "GP6M2J2DHXM3F2J40S8AP316R2QR",
        "4X9K1L7N2P5Q8R3S6T0U"
    ],
    "spamassassin": true,
    "blacklist": true,
    "aiInsight": false
}'

Response Example

200 - Example 1

{
    "status": 200,
    "message": "Success",
    "data": {
        "orderId": "7K2M9P4Q1R8S5T3U6V0W2X4Y8Z1A"
    }
}

Modified at 2026-08-10 06:33:39

Order Pre-warmup

Get Placement Reports