mail

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

Reset a mailbox password.

כל נקודות הקצה מסוג mail

אימות

שלחו מפתח API כאסימון נושא (bearer token). על המפתח לכלול את הרשאה mail.manage; מפתח שאינו כולל אותה יידחה בסטטוס 403, ולא 404.

נקודת קצה זו אינה דורשת מזהה ארגון. המפתח שלך כבר מזהה את הארגון שאליו הוא שייך, והתגובה מוגבלת אליו בלבד.

נסה זאת

החלף כל דבר בסוגריים זוויתיים בערכים משלך, ואת מציין מיקום המפתח במפתח מלוח הבקרה שלך.

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

מחובר? קונסולת ה-API בלוח הבקרה שלך מזינה את מזהה הארגון האמיתי שלך ואת המפתח שלך, ומריצה את הבקשה מול ה-API הפיזי כך שתוכל לראות את התגובה בפועל. פתח נקודת קצה זו במסוף ה-API

פרטים

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

פרמטרים

שםסוגנדרשמה זה
mailboxId (path)UuidכןMailbox ID (UUIDv7).

תשובה

שםסוגנדרשמה זה
mailboxMailboxכןOne mailbox. Never carries a password — see `MailboxCreated`.
passwordobjectכןThe password, shown once. `null` when the backend reconciled to a mailbox that already existed and refused to rotate a live password.

שגיאות שנקודה קצה זו עשויה להחזיר

401 · 403 · 404 · 422 · 429 · 503