POST /v1/mail/services/{mailServiceId}/responders
Set an auto-reply on a mailbox.
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}/responders \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "local": <string>, "content": <string> }'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
Idempotent on local: re-posting for the same mailbox reconciles to the existing responder rather than creating a second one, which is the backend's own natural key. Requires mail.manage.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
mailServiceId (path) | Uuid | Yes | Email service ID (UUIDv7). |
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
local | string | Yes | The mailbox to auto-reply for. |
subject | string | No | — |
content | string | Yes | — |
start_time | string | No | RFC 3339. Omit or null for no schedule - see MailResponder. |
end_time | string | No | RFC 3339, and must be after start_time when both are given. |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
id | string | Yes | The mail backend's identifier - the handle DELETE needs. |
local | string | Yes | The part before the @. |
address | string | Yes | The mailbox this replies for. |
subject | string | Yes | — |
content | string | Yes | The reply body. |
start_time | string | Yes | When the auto-reply starts. null when unscheduled (it replies from now on). ⭐ This used to be declared "Opaque - do not parse, compare or render as a date" (#664), out of a… |
end_time | string | Yes | When the auto-reply stops. null to run until switched off. |
Errors this endpoint can return
401 · 403 · 404 · 422 · 429 · 503