Create Order (JSON)

Creates a new order for domain registration and mailbox setup.

✅ Confirmed Orders (`confirm: true`)

When confirm is set to true:

Order will be created and automatically queued for processing

Your wallet must have sufficient balance to cover the order cost

Processing begins immediately after creation

Returns 200 OK on success

⏸️ Unconfirmed Orders (`confirm: false`)

When confirm is set to false:

Order will be created but not processed

To process the order later, use the Process Order endpoint

Useful for reviewing order details before committing

Returns 201 OK on success

Partial Success Response

If the request contains multiple domains or mailbox entries, some items may be processed successfully while others fail validation.

What Happens

The order may still be created successfully

Successful items will be included in the order

Failed items will be returned in the metadata field

Each failed item contains the reason for failure

Common Failure Reasons in metadata

Workspace validation failed : The order could not be completed because the request failed during processing, as the domain is already associated with an existing Google Workspace account.

Contains restricted phrase : The order could not be completed because it contains restricted phrase(s) that may violate intellectual property, promote violence, or involve illegal activities.

Important Notes

Wallet Balance: Ensure sufficient balance in your wallet when using confirm: true

Service Provider: For Google mailboxes, the google object is required. For Microsoft mailboxes, microsoftOauthRoute is required

Email Warmup (`onWarmup`)

Mark any mailbox with "onWarmup": true to enroll it in email warmup automatically after provisioning.

{
  "mailboxes": {
    "example.com": [
      { "username": "alice", "firstName": "Alice", "lastName": "Smith", "onWarmup": true },
      { "username": "bob", "firstName": "Bob", "lastName": "Jones", "onWarmup": false }
    ]
  }
}

curl --location 'https://customers.coldmailreseller.com/api/v1/integration/orders/json?userId=H8M9JV2S9HMPYFQW393AZHQVD4XM' \ --header 'cmr-x-api-key: <api-key>' \ --header 'Content-Type: application/json' \ --data '{ "billingCycle": "MONTHLY", "domains": [ { "domain": "acmecorp.com", "years": 1 } ], "mailboxes": { "acmecorp.com": [ { "username": "alice", "firstName": "Alice", "lastName": "Johnson", "onWarmup": true } ] }, "serviceProvider": "GOOGLE", "autoRenew": true, "confirm": true, "google": { "googleOauthRoute": "string", "clientId": "string", "appName": "string" }, "microsoftOauthRoute": "https://yourapp.com/oauth/microsoft/callback" }'

{ "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" }

✅ Confirmed Orders (`confirm: true`)

⏸️ Unconfirmed Orders (`confirm: false`)

Partial Success Response

What Happens

Common Failure Reasons in metadata

Important Notes

Email Warmup (`onWarmup`)

Request

Responses

Create Order (JSON)

✅ Confirmed Orders (confirm: true)#

⏸️ Unconfirmed Orders (confirm: false)#

Partial Success Response#

What Happens#

Common Failure Reasons in metadata#

Important Notes#

Email Warmup (onWarmup)#

Request

Responses

✅ Confirmed Orders (`confirm: true`)

⏸️ Unconfirmed Orders (`confirm: false`)

Partial Success Response

What Happens

Common Failure Reasons in metadata

Important Notes

Email Warmup (`onWarmup`)