POST /v1/mail/mailboxes/{mailboxId}/password
Reset a mailbox password.
Аутентификация
Отправьте ключ 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). |
Ответ
| Имя | Тип | Обязательно | Что это |
|---|---|---|---|
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