Run in Apidog
Creates a new order for domain registration and mailbox setup. Query Parameters# Parameter Type Required Description userId string Yes The ID of the user
Request Body# The request body should be in application/json format. domains# Description : List of domains to be registered
Domain Object Fields:# Field Type Required Description domain string Yes The name of the domain to register years integer Yes Number of years for domain registration forwardTo string No Destination to which the domain should forward
mailboxes# Description : Mapping of domain names to their mailbox configurations. Domain on which mailboxes are to be assigned.
Mailbox Array Fields:# Field Type Required Description username string Yes Username for the mailbox firstName string Yes First name of the mailbox user lastName string Yes Last name of the mailbox user profilePicture string No URL of the user's profile picture
billingCycle# Description : Billing cycle for the order
confirm# Description : If true, automatically process the order. Please make sure to have enough balance in your wallet.
serviceProvider# Description : Type of email service provider
Allowed values : GOOGLE, MICROSOFT
microsoftOauthRoute# Required : No (Required for Microsoft mailboxes)
Description : OAuth route for Microsoft mailboxes to export them
google# Required : No (Required for Google mailboxes)
Description : Google-specific OAuth configuration
Google Object Fields:# Field Type Required Description googleOauthRoute string No The Google OAuth URL clientId string No Client ID of your platform appName string No App name shown after entering client ID in Admin Console
autoRenew# Description : Indicates whether the order will be automatically renewed
Note : This flag applies to mailboxes renewal only
Order Processing# ✅ 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
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
Each failed item contains the reason for failure
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
Request Add parameter in header cmr-x-api-key
Example: cmr-x-api-key: ********************
or
Body Params application/json
{
"domains" : [
{
"domain" : "domain.com" ,
"years" : 1 ,
"forwardTo" : "coldmailreseller.com"
}
] ,
"mailboxes" : {
"domain.com" : [
{
"username" : "email1" ,
"firstName" : "john" ,
"lastName" : "doe" ,
"profilePicture" : "https://unsplash.com/photos/a-white-sculpture-is-shown-against-a-white-background-As9ruviI79Q"
} ,
{
"username" : "email1" ,
"firstName" : "john" ,
"lastName" : "doe" ,
"profilePicture" : "https://unsplash.com/photos/a-white-sculpture-is-shown-against-a-white-background-As9ruviI79Q"
}
]
} ,
"billingCycle" : "MONTHLY" ,
"confirm" : false ,
"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"
} ,
"autoRenew" : false } Request Code Samples
curl --location 'https://customers.coldmailreseller.com/api/v1/integration/orders/json?userId=undefined' \
--header 'cmr-x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"domains": [
{
"domain": "domain.com",
"years": 1,
"forwardTo": "coldmailreseller.com"
}
],
"mailboxes": {
"domain.com": [
{
"username": "email1",
"firstName": "john",
"lastName": "doe",
"profilePicture": "https://unsplash.com/photos/a-white-sculpture-is-shown-against-a-white-background-As9ruviI79Q"
},
{
"username": "email1",
"firstName": "john",
"lastName": "doe",
"profilePicture": "https://unsplash.com/photos/a-white-sculpture-is-shown-against-a-white-background-As9ruviI79Q"
}
]
},
"billingCycle": "MONTHLY",
"confirm": false,
"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"
},
"autoRenew": false
}' Responses application/json
Generate Code
{
"status" : 200 ,
"message" : "Order created and queued for processing" ,
"data" : {
"orderId" : "3BFTT324G0MKSYPV3FR2JQ3NFCAP" ,
} ,
"actionId" : "ACT_7a078272-0fa7-4db4-a85b-c78697dacea1"
}
Modified at 2026-06-23 16:21:02
