POST /v1/mail/mailboxes/{mailboxId}/password
Reset a mailbox password.
احراز هویت
یک کلید API را به عنوان یک توکن حامل ارسال کنید. این کلید باید دارای مجوز 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). |
پاسخ
| نام | نوع | الزامی | چیست |
|---|---|---|---|
mailbox | Mailbox | بله | One mailbox. Never carries a password — see MailboxCreated. |
password | object | بله | 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