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, за да можете да видите действителния отговор. Отворете този крайpoint в 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. |
Грешки, които този крайpoint може да върне
401 · 403 · 404 · 422 · 429 · 503