POST /v1/mail/services/{mailServiceId}/mailboxes
Create a mailbox.
Authentication
Send an API key as a bearer token. The key must carry the mail.manage permission; a key without it is refused with 403, not 404.
This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X POST https://api.zinndigital.com/v1/mail/services/{mailServiceId}/mailboxes \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "local": <string> }'Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
Creates local@domain. Send password to choose it (checked first; never echoed back), or omit it to get a generated one returned once. A password is never stored by us and cannot be read back — a lost one is replaced by resetMailboxPassword, not recovered. password is null when the backend reconciled to a mailbox that already existed and refused to rotate a live password; show that as "we could not display a password", never as a blank one. Requires mail.manage. Fails 409 on a duplicate address, and 422 when the service is not live yet or the domain is at its mailbox ceiling.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
mailServiceId (path) | Uuid | Yes | Email service ID (UUIDv7). |
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
local | string | Yes | The part before the @. |
send | boolean | No | — |
receive | boolean | No | — |
password | string | No | Optional. The password the person chose. Checked before the mailbox is created (12–128 characters, must not contain the address or domain name, must not appear in a known data… |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
mailbox | Mailbox | Yes | One mailbox. Never carries a password — see MailboxCreated. |
password | object | Yes | The password, shown once. null when the person chose it (chosen: true — a password somebody typed is never sent back), or when the backend reconciled to a mailbox that already… |
chosen | boolean | No | true when the password set is the one sent in the request. |
Errors this endpoint can return
401 · 403 · 404 · 409 · 422 · 429 · 503