POST /v1/mail/services/{mailServiceId}/mailboxes
Create a mailbox.
Аутентификация
Отправьте ключ 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). |
Тело запроса
| Имя | Тип | Обязательно | Что это |
|---|---|---|---|
local | string | Да | The part before the @. |
send | boolean | Нет | — |
receive | boolean | Нет | — |
Ответ
| Имя | Тип | Обязательно | Что это |
|---|---|---|---|
mailbox | Mailbox | Да | One mailbox. Never carries a password — see MailboxCreated. |
password | object | Да | 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