Hitelesítés
Küldjön egy API-kulcsot bearer tokenként. A kulcsnak rendelkeznie kell a(z) mail.manage jogosultsággal; az ezzel nem rendelkező kulcsok esetén a rendszer 403-as hibát ad vissza 404 helyett.
Ez a végpont nem fogad el szervezeti azonosítót. Az Ön kulcsa már azonosítja azt a szervezetet, amelyhez tartozik, és a válasz is erre vonatkozik.
Próbálja ki
Cserélje ki a hegyes zárójelek közötti részt a saját értékeivel, a kulcshelyőrzőt pedig a vezérlőpultján található kulccsal.
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> }'Be van jelentkezve? A vezérlőpultban lévő API-konzol kitölti a valós szervezetazonosítóját és a saját kulcsát, és a kérést az éles API-n futtatja, hogy láthassa a tényleges választ. Nyissa meg ezt a végpontot az API konzolban
Részletek
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.
Paraméterek
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
mailServiceId (path) | Uuid | Igen | Email service ID (UUIDv7). |
Kérés törzse
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
local | string | Igen | The part before the `@`. |
send | boolean | Nem | — |
receive | boolean | Nem | — |
Válasz
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
mailbox | Mailbox | Igen | One mailbox. Never carries a password — see `MailboxCreated`. |
password | object | Igen | The password, shown once. `null` when the backend reconciled to a mailbox that already existed and refused to rotate a live password. |
Hibák, amelyeket ez a végpont visszaadhattatlan
401 · 403 · 404 · 409 · 422 · 429 · 503