mail

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

Create a mailbox.

Wszystkie punkty końcowe mail

Wszystkie dokumentacje dla programistów

Uwierzytelnianie

Wyślij klucz API jako token bearer. Klucz musi posiadać uprawnienie mail.manage; klucz bez niego jest odrzucany z kodem 403, a nie 404.

Ten punkt końcowy nie wymaga identyfikatora organizacji. Twój klucz już identyfikuje organizację, do której należy, a odpowiedź jest do niej ograniczona.

Wypróbuj

Zastąp wszystko w nawiasach ostrych własnymi wartościami, a zastępczy znacznik klucza kluczem ze swojego pulpitu nawigacyjnego.

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

Zalogowany? Konsola API w Twoim panelu uzupełnia rzeczywiste identyfikator organizacji oraz Twój własny klucz i wykonuje żądanie względem aktywnego API, dzięki czemu możesz zobaczyć rzeczywistą odpowiedź. Otwórz ten punkt końcowy w konsoli API

Szczegóły

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.

Parametry

NazwaTypWymaganeCo to jest
mailServiceId (path)UuidTakEmail service ID (UUIDv7).

Treść żądania

NazwaTypWymaganeCo to jest
localstringTakThe part before the @.
sendbooleanNie
receivebooleanNie

Odpowiedź

NazwaTypWymaganeCo to jest
mailboxMailboxTakOne mailbox. Never carries a password — see MailboxCreated.
passwordobjectTakThe password, shown once. null when the backend reconciled to a mailbox that already existed and refused to rotate a live password.

Błędy, które ten punkt końcowy może zwrócić

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