mail

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

Create a mailbox.

Всички крайни точки в mail

Упълномощаване

Изпратете API ключ като токен за носене. Ключът трябва да притежава разрешението 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, за да можете да видите действителния отговор. Отворете този крайpoint в 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.

Грешки, които този крайpoint може да върне

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