POST /v1/mail/services/{mailServiceId}/retry

認証

ベアラー トークンとして API キーを送信します。キーには mail.manage 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。

このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。

試してみる

アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。

curl -X POST https://api.zinndigital.com/v1/mail/services/{mailServiceId}/retry \
  -H "Authorization: Bearer zdk_live_…"

ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く

詳細

Re-enters the provisioning workflow for a service in `failed`. Setting email up is a multi-step operation against two backends — the mail account and the domain's DNS zone — and a failure part-way leaves a service that is real, may already hold a paid mailbox package, and is not usable. The automatic sweep cannot recover it: that re-drives services still `pending`, never one that failed after that point, so before this endpoint the only options were to look at the failure or delete the service. Safe to call twice. The provisioning workflow id is derived from the service id so a duplicate start converges on the run already going, the mail-account step is an ensure, and the DNS step is a convergent write. Calling it on a service that is already `pending` or `provisioning` is answered with its current state rather than an error — the caller asked for the state it is already in. Any other status is `409`. Requires `mail.manage`.

パラメータ