Skip to content

Mailboxes

POST /users/

Create a new email account (mailbox) under an existing domain.

FieldTypeRequiredDescription
domain_namestringYesParent domain (must exist and belong to your partner)
emailstringYesFull email address (e.g. [email protected])
passwordstringYesPassword for IMAP/SMTP login. Securely hashed by EmBoux.
Terminal window
curl -X POST https://api.emboux.com/users/ \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"domain_name": "mycompany.com",
"email": "[email protected]",
"password": "secure-pass-123"
}'
{
"id": 1,
"domain_id": 1,
"email": "[email protected]",
"created_at": "2025-01-15T10:31:00"
}
StatusDetail
400Email already exists
403Mailbox quota exceeded for this domain
404Domain not found

GET /users/?domain_id={id}
ParameterTypeRequiredDescription
domain_idintegerNoFilter by domain. Omit to list all.
Terminal window
curl "https://api.emboux.com/users/?domain_id=1" \
-H "Authorization: Bearer YOUR_API_KEY"
[
{
"id": 1,
"domain_id": 1,
"email": "[email protected]",
"created_at": "2025-01-15T10:31:00"
}
]

PUT /users/{email}
FieldTypeRequiredDescription
passwordstringYesNew password
Terminal window
curl -X PUT https://api.emboux.com/users/[email protected] \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"password": "new-secure-pass"}'
{"message": "Contraseña actualizada correctamente"}

DELETE /users/{email}
Terminal window
curl -X DELETE https://api.emboux.com/users/[email protected] \
-H "Authorization: Bearer YOUR_API_KEY"