認証
ベアラー トークンとして API キーを送信します。キーには mail.manage 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X POST https://api.zinndigital.com/v1/mail/mailboxes/{mailboxId}/password \
-H "Authorization: Bearer zdk_live_…"ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブ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