Mailboxes
Create Mailbox
Section titled “Create Mailbox”POST /users/Create a new email account (mailbox) under an existing domain.
Request Body
Section titled “Request Body”| Field | Type | Required | Description |
|---|---|---|---|
domain_name | string | Yes | Parent domain (must exist and belong to your partner) |
email | string | Yes | Full email address (e.g. user@mycompany.com) |
password | string | Yes | Password for IMAP/SMTP login. Securely hashed by EmBoux. |
Example
Section titled “Example”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": "hello@mycompany.com", "password": "secure-pass-123" }'Response 201 Created
Section titled “Response 201 Created”{ "id": 1, "domain_id": 1, "email": "hello@mycompany.com", "created_at": "2025-01-15T10:31:00"}Errors
Section titled “Errors”| Status | Detail |
|---|---|
400 | Email already exists |
403 | Mailbox quota exceeded for this domain |
404 | Domain not found |
List Mailboxes
Section titled “List Mailboxes”GET /users/?domain_id={id}Query Parameters
Section titled “Query Parameters”| Parameter | Type | Required | Description |
|---|---|---|---|
domain_id | integer | No | Filter by domain. Omit to list all. |
Example
Section titled “Example”curl "https://api.emboux.com/users/?domain_id=1" \ -H "Authorization: Bearer YOUR_API_KEY"Response 200 OK
Section titled “Response 200 OK”[ { "id": 1, "domain_id": 1, "email": "hello@mycompany.com", "created_at": "2025-01-15T10:31:00" }]Update Password
Section titled “Update Password”PUT /users/{email}Request Body
Section titled “Request Body”| Field | Type | Required | Description |
|---|---|---|---|
password | string | Yes | New password |
Example
Section titled “Example”curl -X PUT https://api.emboux.com/users/hello@mycompany.com \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"password": "new-secure-pass"}'Response 200 OK
Section titled “Response 200 OK”{"message": "Contraseña actualizada correctamente"}Delete Mailbox
Section titled “Delete Mailbox”DELETE /users/{email}Example
Section titled “Example”curl -X DELETE https://api.emboux.com/users/hello@mycompany.com \ -H "Authorization: Bearer YOUR_API_KEY"