mail

POST /v1/mail/mailboxes/{mailboxId}/password

Reset a mailbox password.

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/mailboxes/{mailboxId}/password \
  -H "Authorization: Bearer zdk_live_…"

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

Mints a **new** password and returns it once. Always a reset, never a read: there is no column holding the old one and no path that could write one. Requires `mail.manage`.

Parametri

NomeTipoObbligatorioChe cos'è
mailboxId (path)UuidMailbox ID (UUIDv7).

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 · 422 · 429 · 503