mail

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

Create a mailbox.

Semua titik akhir mail

Autentikasi

Kirim kunci API sebagai token bearer. Kunci tersebut harus memiliki izin mail.manage; kunci tanpa izin tersebut akan ditolak dengan status 403, bukan 404.

Endpoint ini tidak memerlukan id organisasi. Kunci Anda telah mengidentifikasi organisasi tempatnya berafiliasi, dan respons akan dibatasi untuk organisasi tersebut.

Coba

Ganti apa pun di dalam tanda kurung sudut dengan nilai Anda sendiri, dan placeholder kunci dengan kunci dari dasbor Anda.

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

Sudah masuk? Konsol API di dasbor Anda akan mengisi ID organisasi asli dan kunci Anda sendiri, serta menjalankan permintaan terhadap API langsung sehingga Anda dapat melihat respons aktualnya. Buka titik akhir ini di konsol API

Detail

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.

Parameter

NamaJenisWajibTentang apa ini
mailServiceId (path)UuidYaEmail service ID (UUIDv7).

Isi permintaan

NamaJenisWajibTentang apa ini
localstringYaThe part before the `@`.
sendbooleanTidak
receivebooleanTidak

Tanggapan

NamaJenisWajibTentang apa ini
mailboxMailboxYaOne mailbox. Never carries a password — see `MailboxCreated`.
passwordobjectYaThe password, shown once. `null` when the backend reconciled to a mailbox that already existed and refused to rotate a live password.

Kesalahan yang dapat dikembalikan oleh titik akhir ini

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