1. Orders
  • Welcome to the Cold Mail Reseller API
  • Get Started
    • Overview
    • Authentication
    • Quick Start
  • Core Concepts
    • Users
    • Domains
    • DNS Management
    • Mailboxes
    • Subscriptions
    • Pre-Warmup
    • Domain Renewal
    • 1+ Year Subscriptions
    • Mailbox Warmup
    • Platform Exports
    • OAuth Exports
    • Sandbox API
  • API Reference
    • Users
      • List Users
      • Get User
      • Create User
      • Update User
      • Delete User
    • Geo
      • List Countries
      • List States
    • Domains
      • Domain Renewal
        • Get Domain Renewal Prices
        • Renew Domains
        • Toggle Domain Auto-Renew
      • Get Domains by User
      • Check Domain Availability
      • Check Single Domain Availability
      • Check Workspace Existence
      • Set Domain Forwarding
      • Set Email Forwarding
      • Delete Domains
    • DNS
      • Get DNS Records
      • Add DNS Records
      • Update DNS Record
      • Update Nameservers
      • Delete DNS Record
    • Mailboxes
      • List Mailboxes
      • Get Mailboxes by User
      • Get Mailbox
      • Get Admin Mailbox Details
      • Update Mailbox Details
      • Delete Mailbox
    • Mailbox Warmup
      • Add Warmup to Mailbox
      • Toggle Warmup
      • Update Warmup Settings
      • Set Warmup Status
      • Disable Warmup
    • Orders
      • Get Order Status
        GET
      • Get Order Details
        GET
      • Create Order
        POST
      • Create Order (JSON)
        POST
      • Create Mailbox Order (JSON)
        POST
      • Process Order
        POST
    • Subscriptions
      • 1+ Year Subscription
        • Recreate Subscription
      • Get Subscriptions
      • Renew Subscriptions
      • Cancel Subscription
      • Toggle Auto-Renewal
    • Exports
      • Platform Exports
        • Get Platform Credentials
        • Add Platform Credential
        • Export Mailboxes to Platform
        • Remove Platform Credential
      • OAuth Exports
        • Perform OAuth
        • Add Client ID to Domains
    • Pre-Warmup
      • Sandbox
        • Get Sandbox Pre-warmup Domains
        • Order Sandbox Pre-warmup
        • Reset Sandbox Pre-warmup
      • Get Pre-warmup Domains
      • Order Pre-warmup
    • Placement Test
      • Create Placement Order
      • Get Placement Reports
  • Resources
    • Errors
    • Rate Limits
    • Pagination
    • Sandbox
    • MCP
  • Webhooks
    • Overview
    • Events
      • Domain Events
      • Mailbox Events
      • Subscription Events
      • Prewarmup Events
      • Mailbox Warmup Events
  • Schemas
    • Error
    • Success
    • MessageResponse
    • User
    • Domain
    • ErrorResponse
    • Mailbox
    • Subscription
    • DnsRecord
    • Error Response
    • Pagination Meta
    • Action Error Response
    • PrewarmupOrderResult
    • OrderCreationResult
  1. Orders

Create Order

Deprecated
POST
/orders
Creates a new order to register domains and provision mailboxes (file upload).

Confirmation behavior#

confirm: true — order is queued immediately and returns 200.
confirm omitted — order is saved as a draft and returns 201. Process the draft later via POST /orders/process-order.

Partial success#

If some domains fail validation (restricted phrases, workspace errors, or unavailability), the order is created for valid domains only. The metadata object in the response contains per-domain results.
Note: Use POST /orders/json for a JSON-only version without file upload.

Request

Authorization
API Key
Add parameter in header
cmr-x-api-key
Example:
cmr-x-api-key: ********************
or
Query Params

Body Params multipart/form-dataRequired

Responses

🟢200Success
application/json
Order created and queued for processing (confirm=true)
Bodyapplication/json

🟢201Created
🟠401Unauthorized
🟠422Validation Error
🟠400Bad Request
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://customers.coldmailreseller.com/api/v1/integration/orders?userId=H8M9JV2S9HMPYFQW393AZHQVD4XM' \
--header 'cmr-x-api-key: <api-key>' \
--form 'domains="[{\"domain\":\"acmecorp.com\",\"years\":1}]"' \
--form 'mailboxes="{\"acmecorp.com\":[{\"username\":\"alice\",\"firstName\":\"Alice\",\"lastName\":\"Johnson\"}]}"' \
--form 'billingCycle="MONTHLY"' \
--form 'serviceProvider="GOOGLE"' \
--form 'autoRenew="true"' \
--form 'confirm="true"' \
--form 'google="{\"googleOauthRoute\":\"https://yourapp.com/oauth/google/callback\",\"clientId\":\"client-id\",\"appName\":\"MyApp\"}"' \
--form 'microsoftOauthRoute="https://yourapp.com/oauth/microsoft/callback"' \
--form '{username}@{domainName}=@""'
Response Response Example
200 - Example 1
{
    "status": 200,
    "message": "Order created and queued for processing",
    "data": {
        "orderId": "ord_R8K2LQPZA9XM",
        "metadata": {
            "property1": "Success",
            "property2": "Success"
        }
    },
    "actionId": "ACT_7a078272-0fa7-4db4-a85b-c78697dacea1"
}
Modified at 2026-08-06 06:20:56
Previous
Get Order Details
Next
Create Order (JSON)
Built with