API ReferenceMailboxes
Create Mailbox
Create a mailbox on a specific cluster/domain
Create Mailbox
Creates a new email mailbox on a specific cluster's domain. The mail server must already be deployed on the cluster.
Request
-
clusterId(integer) (required) — The cluster ID to create the mailbox on -
email(string) (required) — Full email address for the mailbox (e.g.,john@outreach-company.com) -
password(string) — Password for the mailbox. Auto-generated if not provided.
curl -X POST https://api.hermes.camie.ai/v1/mailboxes/cluster/202 \
-H "Authorization: Bearer hermes_your_api_key" \
-H "Content-Type: application/json" \
-d '{
"email": "john@outreach-company.com",
"password": "securePassword123"
}'const res = await fetch('https://api.hermes.camie.ai/v1/mailboxes/cluster/202', {
method: 'POST',
headers: {
'Authorization': 'Bearer hermes_your_api_key',
'Content-Type': 'application/json'
},
body: JSON.stringify({
email: 'john@outreach-company.com',
password: 'securePassword123'
})
});Response (201 Created)
{
"success": true,
"data": {
"id": 50,
"email": "john@outreach-company.com",
"clusterId": 202,
"isActive": true,
"createdAt": "2026-03-14T16:00:00.000Z"
}
}📝 Note: The mailbox is configured with IMAP (993/SSL) and SMTP (465/SSL) automatically. Use these credentials in your email campaigns.
Workflow Example
A typical setup flow:
- Buy a domain →
my-outreach.com - Create a cluster with that domain
- Create mailboxes on the cluster (this endpoint)
- Create a campaign using those mailboxes