Run in Apidog
This endpoint allows you to create mailbox orders for your domain. The behavior varies depending on your subscription status and confirmation parameter. Request Scenarios# 🟢 Scenario 1: Active Subscription# When you already have an active subscription , this endpoint adds new mailboxes to the existing subscription. Adding additional mailboxes to your current plan
Scaling mailbox capacity within an existing subscription
🟠 Scenario 2: Cancelled Subscription# When your subscription has been cancelled , this endpoint creates mailboxes and automatically generates a new subscription . Creating a new subscription for an existing domain whose previous subscription was cancelled
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
Important Notes# Mutually Exclusive Parameters Provide either subscriptionId or domainId
Do not provide both in the same request
Wallet Balance Requirement Ensure sufficient balance in your wallet when using confirm: true
Insufficient balance will result in order creation failure
Automatic Subscription Creation A new subscription is created automatically when using domainId
When creating a new subscription (Scenario 2), the autoRenew parameter to specify renewal preferences
When using subscriptionId, mailboxes are added seamlessly to the existing plan
Summary# Parameter Type Required Description subscriptionId string Conditional* ID of the active subscription to add mailboxes to domainId string Conditional* ID of the domain used to create a new subscription autoRenew boolean Conditional** Auto-renewal setting for new subscriptions (Scenario 2 only) confirm boolean Required true: Process immediately, false: Create without processing
* One of subscriptionId or domainId must be provided based on your subscription statusdomainId (Scenario 2) to create a new subscription Request Add parameter in header cmr-x-api-key
Example: cmr-x-api-key: ********************
or
Body Params application/json
{
"subscriptionId" : "" ,
"mailboxes" : {
"center.org" : [
{
"username" : "email1" ,
"firstName" : "john" ,
"lastName" : "doe" ,
"profilePicture" : "https://unsplash.com/photos/a-blurry-image-of-a-tree-outside-of-a-window-8NIxpSFzzg8"
}
]
} ,
"confirm" : false ,
"autoRenew" : true ,
"google" : {
"googleOauthRoute" : "https://accounts.google.com/o/oauth2/v2/auth/oauthchooseaccount?access_type=offline..." ,
"clientId" : "549360251880-maeh4okn7btu9cjtf0l2bt1t5b22sbf8.apps.googleusercontent.com" ,
"appName" : "Outreach App"
}
} Request Code Samples
curl --location --request POST 'https://customers.coldmailreseller.com/api/v1/integration/orders/create-mailbox-order/json?userId' \
--header 'cmr-x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
"subscriptionId": "",
"mailboxes": {
"center.org": [
{
"username": "email1",
"firstName": "john",
"lastName": "doe",
"profilePicture": "https://unsplash.com/photos/a-blurry-image-of-a-tree-outside-of-a-window-8NIxpSFzzg8"
}
]
},
"confirm": false,
"autoRenew": true,
"google": {
"googleOauthRoute": "https://accounts.google.com/o/oauth2/v2/auth/oauthchooseaccount?access_type=offline...",
"clientId": "549360251880-maeh4okn7btu9cjtf0l2bt1t5b22sbf8.apps.googleusercontent.com",
"appName": "Outreach App"
}
}' 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-02-09 12:03:56
