mail

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

Reset a mailbox password.

Alle mail-eindpunten

Authenticatie

Stuur een API-sleutel mee als bearer token. De sleutel moet over de permissie mail.manage beschikken; een sleutel zonder deze permissie wordt geweigerd met een 403 in plaats van een 404.

Dit eindpunt vereist geen organisatie-id. Uw sleutel identificeert al de organisatie waartoe deze behoort, en het antwoord is hierop afgestemd.

Probeer het

Vervang alles tussen punthaakjes door uw eigen waarden en de sleutelplaatsvervanger door een sleutel uit uw dashboard.

curl -X POST https://api.zinndigital.com/v1/mail/mailboxes/{mailboxId}/password \
  -H "Authorization: Bearer zdk_live_…"

Ingelogd? De API-console in je dashboard vult je echte organisatie-id en je eigen sleutel in, en voert het verzoek uit tegen de live API zodat je de daadwerkelijke respons kunt zien. Open dit eindpunt in de API-console

Details

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`.

Parameters

NaamTypeVerplichtWat dit is
mailboxId (path)UuidJaMailbox ID (UUIDv7).

Reactie

NaamTypeVerplichtWat dit is
mailboxMailboxJaOne mailbox. Never carries a password — see `MailboxCreated`.
passwordobjectJaThe password, shown once. `null` when the backend reconciled to a mailbox that already existed and refused to rotate a live password.

Fouten die dit eindpunt kan retourneren

401 · 403 · 404 · 422 · 429 · 503