mail

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

Create a mailbox.

Усі кінцеві точки mail

Автентифікація

Надішліть ключ API як маркер носія (bearer token). Ключ повинен мати дозвіл mail.manage; ключ без нього відхиляється з кодом 403, а не 404.

Цей кінцевий пункт не потребує ідентифікатора організації. Ваш ключ уже ідентифікує організацію, якій він належить, і відповідь обмежується її межами.

Спробувати

Замініть усе в кутових дужках власними значеннями, а заповнювач ключа — ключем із вашої панелі керування.

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> }'

Увійшли в систему? Консоль API у вашій панелі керування автоматично підставляє ваш реальний ідентифікатор організації та ваш власний ключ, а також виконує запит до робочого API, щоб ви могли побачити справжню відповідь. Відкрийте цю кінцеву точку в консолі API

Деталі

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.

Параметри

НазваТипОбов'язковеЩо це таке
mailServiceId (path)UuidТакEmail service ID (UUIDv7).

Тіло запиту

НазваТипОбов'язковеЩо це таке
localstringТакThe part before the `@`.
sendbooleanНі
receivebooleanНі

Відповідь

НазваТипОбов'язковеЩо це таке
mailboxMailboxТакOne mailbox. Never carries a password — see `MailboxCreated`.
passwordobjectТакThe password, shown once. `null` when the backend reconciled to a mailbox that already existed and refused to rotate a live password.

Помилки, які може повертати ця кінцева точка

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