mail

POST /v1/mail/services/{mailServiceId}/mailboxes

Create a mailbox.

Lahat ng mail endpoint

Pagpapatotoo

Magpadala ng API key bilang isang bearer token. Kailangang taglayin ng key ang pahintulot na mail.manage; ang key na wala nito ay tatanggihan gamit ang 403, hindi 404.

Ang endpoint na ito ay hindi nangangailangan ng id ng organisasyon. Natutukoy na ng iyong key ang organisasyong kinabibilangan nito, at nakatuon ang tugon dito.

Subukan ito

Palitan ang anuman sa loob ng mga panaklong na may anggulo ng iyong sariling mga halaga, at ang placeholder ng key na may key mula sa iyong 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> }'

Nakalagda? Ang API console sa iyong dashboard ay awtomatikong naglalagay ng iyong tunay na ID ng organisasyon at sariling susi, at pinapatakbo ang kahilingan laban sa live na API upang makita mo ang aktwal na tugon. Buksan ang endpoint na ito sa console ng API

Mga Detalye

Creates `local@domain` and returns it **with its password, once**. The password is never stored 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.

Mga Parameter

PangalanUriKailanganAno ito
mailServiceId (path)UuidOoEmail service ID (UUIDv7).

Katawan ng kahilingan

PangalanUriKailanganAno ito
localstringOoThe part before the `@`.
sendbooleanHindi
receivebooleanHindi

Tugon

PangalanUriKailanganAno ito
mailboxMailboxOoOne mailbox. Never carries a password — see `MailboxCreated`.
passwordobjectOoThe password, shown once. `null` when the backend reconciled to a mailbox that already existed and refused to rotate a live password.

Mga error na maibabalik ng endpoint na ito

401 · 403 · 404 · 409 · 422 · 429 · 503