Run in Apidog
Creates a new order, which can include mailboxes and domain purchases. Domain and Mailbox Registration Request# This endpoint allows you to register domains and mailboxes, set a billing cycle, and upload files associated with the user. Request Body (FormData)# domains# Description : A list of domain registration details.
[ { "domain" : "onecompanycenter.com" , "years" : 1 } ] domain (string): The name of the domain to register (e.g., onecompanycenter.com).
years (number): The number of years for which the domain should be registered (e.g., 1 year).
forwardTo (string): The destination to which the domain should be forwarded. (optional)
maskForwarding (boolean): Indicates whether forwarding should be masked. (optional)
mailboxes# Description : A mapping of domain names to mailbox details. Each domain can have multiple mailboxes.
{
"onecompanycenter.com" : [
{
"username" : "john" ,
"firstName" : "john" ,
"lastName" : "doe"
}
]
} username (string): The username of the mailbox (e.g., john).
firstName (string): The first name of the mailbox user (e.g., john).
lastName (string): The last name of the mailbox user (e.g., doe).
billingCycle# Description : The billing cycle for the domain registration and mailbox setup. Only the value MONTHLY is accepted.
files# Description : A mapping of mailboxes to files that need to be uploaded. The file should be associated with the specific mailbox. (key is username@domainName, value is the image)
{
"john@onecompanycenter.com" : <binary image>
} file (binary): A file associated with the mailbox (e.g., profile picture). The file is submitted as binary data.
confirm (optional)# Description : If true, automatically process the order. Please make sure to have enough balance in your wallet.
serviceProvider# Description : Represents the type of mailbox. Default is GOOGLE.
Example : GOOGLE or MICROSOFT
microsoftOauthRoute# Description : This is only for microsoft mailboxes to export them.
google# googleOauthRoute (string): Google oauth url.
clientId (number): Client id of your platform.
appName (string): Appname that comes after entering client id on google admin console.
autoRenew (optional)# Description : Indicates whether order will be auto renewed or not.
Notes# Please keep the order Id provided safe with you, it will be required to process the order afterwards.
Ensure all fields are included in the FormData when sending the request.
The files field must be provided as binary image data for the corresponding mailbox.
Request Add parameter in header cmr-x-api-key
Example: cmr-x-api-key: ********************
or
Body Params multipart/form-data
Request Code Samples
curl --location --request POST 'https://customers.coldmailreseller.com/api/v1/integration/orders?userId=' \
--header 'cmr-x-api-key: <api-key>' \
--form 'domains="[{\"domain\":\"domain.com\",\"years\":1}]"' \
--form 'mailboxes="{ \"domain.com\": [ { \"username\": \"email1\", \"firstName\": \"john\", \"lastName\": \"doe\" }, { \"username\": \"email2\", \"firstName\": \"john\", \"lastName\": \"doe\" } ]}"' \
--form 'billingCycle="MONTHLY"' \
--form 'email1@domain.com=@""' \
--form 'email2@domain.com=@""' \
--form 'confirm=""' \
--form 'microsoftOauthRoute=""' \
--form 'google="{ \"googleOauthRoute\": \"\", \"clientId\": \"\", \"appName\": \"\" }"' \
--form 'autoRenew=""' Responses application/json Generate Code
{
"status" : 201 ,
"message" : "Order created successfully" ,
"data" : {
"orderId" : "3BFTT324G0MKSYPV3FR2JQ3NFCAP"
}
} Modified at 2025-10-11 19:43:04
