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

Authentication

Send an API key as a bearer token. The key must carry the mail.manage permission; a key without it is refused with 403, not 404.

This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.

Try it

Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.

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

Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console

Details

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`.

Parameters