mail

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

Create a mailbox.

Tutti gli endpoint mail

Autenticazione

Invia una chiave API come token di tipo bearer. La chiave deve disporre dell'autorizzazione mail.manage; una chiave sprovvista di tale autorizzazione viene rifiutata con 403 anziché 404.

Questo endpoint non richiede alcun ID organizzazione. La tua chiave identifica già l'organizzazione a cui appartiene e la risposta è limitata ad essa.

Provalo

Sostituisci qualsiasi elemento tra parentesi angolari con i tuoi valori e il segnaposto key con una chiave dalla tua dashboard.

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

Hai effettuato l'accesso? La console API nella tua dashboard inserisce il tuo ID organizzazione reale e la tua chiave personale, ed esegue la richiesta sull'API live in modo da poter vedere la risposta effettiva. Apri questo endpoint nella console API

Dettagli

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.

Parametri

NomeTipoObbligatorioChe cos'è
mailServiceId (path)UuidEmail service ID (UUIDv7).

Corpo della richiesta

NomeTipoObbligatorioChe cos'è
localstringThe part before the `@`.
sendbooleanNo
receivebooleanNo

Risposta

NomeTipoObbligatorioChe cos'è
mailboxMailboxOne mailbox. Never carries a password — see `MailboxCreated`.
passwordobjectThe password, shown once. `null` when the backend reconciled to a mailbox that already existed and refused to rotate a live password.

Errori che questo endpoint può restituire

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