POST /v1/mail/services/{mailServiceId}/responders
Set an auto-reply on a mailbox.
Authentifizierung
Senden Sie einen API-Schlüssel als Bearer-Token. Der Schlüssel muss über die Berechtigung mail.manage verfügen; ein Schlüssel ohne diese wird mit 403 statt 404 abgelehnt.
Dieser Endpunkt erfordert keine Organisations-ID. Ihr Schlüssel identifiziert bereits die zugehörige Organisation, und die Antwort ist entsprechend eingeschränkt.
Ausprobieren
Ersetzen Sie alles in spitzen Klammern durch Ihre eigenen Werte und den Platzhalter für den Schlüssel durch einen Schlüssel aus Ihrem 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> }'Angemeldet? Die API-Konsole in Ihrem Dashboard trägt automatisch Ihre echte Organisations-ID sowie Ihren eigenen Schlüssel ein und führt die Anfrage gegen die Live-API aus, sodass Sie die tatsächliche Antwort sehen können. Öffnen Sie diesen Endpunkt in der API-Konsole
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`.
Parameter
| Name | Typ | Erforderlich | Was es ist |
|---|---|---|---|
mailServiceId (path) | Uuid | Ja | Email service ID (UUIDv7). |
Anfragekörper
| Name | Typ | Erforderlich | Was es ist |
|---|---|---|---|
local | string | Ja | The mailbox to auto-reply for. |
subject | string | Nein | — |
content | string | Ja | — |
start_time | string | Nein | RFC 3339. Omit or `null` for no schedule - see `MailResponder`. |
end_time | string | Nein | RFC 3339, and must be after `start_time` when both are given. |
Antwort
| Name | Typ | Erforderlich | Was es ist |
|---|---|---|---|
id | string | Ja | The mail backend's identifier - the handle `DELETE` needs. |
local | string | Ja | The part before the `@`. |
address | string | Ja | The mailbox this replies for. |
subject | string | Ja | — |
content | string | Ja | The reply body. |
start_time | string | Ja | 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… |
end_time | string | Ja | When the auto-reply stops. `null` to run until switched off. |
Fehler, die dieser Endpunkt zurückgeben kann
401 · 403 · 404 · 422 · 429 · 503