Add mailboxes to a subscription Deprecated
Run in Apidog
Creates a new order, which can only include mailboxes on already registered domains.GOOGLE mailboxes) Request Body (FormData)# subscriptionId# Description : The subscriptionId on which domain is assigned.
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).
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, the order will be created and automatically queued for processing . Your wallet must have sufficient balance to cover the order cost. If false, the order will be created but not processed. To process it later, use the Process Order endpoint .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.
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
⏸️ Unconfirmed Orders (confirm: false)# When confirm is set to false: Order will be created but not processed
Useful for reviewing order details before committing
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.
💰 Wallet Balance : Ensure sufficient balance in your wallet when using confirm: true. Insufficient balance will result in order creation failure.
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/create-mailbox-order?userId' \
--header 'cmr-x-api-key: <api-key>' \
--form 'subscriptionId=""' \
--form 'mailboxes="{\"domain.com\": [{\"username\": \"john\", \"firstName\": \"John\", \"lastName\": \"Doe\"}, {\"username\": \"john.d\", \"firstName\": \"John\", \"lastName\": \"Doe\"}]}"' \
--form 'john@domain.com=@""' Responses application/json Generate Code
{
"status" : 200 ,
"message" : "Order created and queued for processing, make sure to have enough balance in your wallet!" ,
"data" : {
"orderId" : "RJK7NR2W194HAGHGTX75D391P3NB"
}
}
Modified at 2026-01-22 11:49:39
