POST /v1/mail/services/{mailServiceId}/responders
Set an auto-reply on a mailbox.
Authenticatie
Stuur een API-sleutel mee als bearer token. De sleutel moet over de permissie mail.manage beschikken; een sleutel zonder deze permissie wordt geweigerd met een 403 in plaats van een 404.
Dit eindpunt vereist geen organisatie-id. Uw sleutel identificeert al de organisatie waartoe deze behoort, en het antwoord is hierop afgestemd.
Probeer het
Vervang alles tussen punthaakjes door uw eigen waarden en de sleutelplaatsvervanger door een sleutel uit uw 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> }'Ingelogd? De API-console in je dashboard vult je echte organisatie-id en je eigen sleutel in, en voert het verzoek uit tegen de live API zodat je de daadwerkelijke respons kunt zien. Open dit eindpunt in de 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
| Naam | Type | Verplicht | Wat dit is |
|---|---|---|---|
mailServiceId (path) | Uuid | Ja | Email service ID (UUIDv7). |
Aanvraaglichaam
| Naam | Type | Verplicht | Wat dit is |
|---|---|---|---|
local | string | Ja | The mailbox to auto-reply for. |
subject | string | Nee | — |
content | string | Ja | — |
start_time | string | Nee | RFC 3339. Omit or `null` for no schedule - see `MailResponder`. |
end_time | string | Nee | RFC 3339, and must be after `start_time` when both are given. |
Reactie
| Naam | Type | Verplicht | Wat dit is |
|---|---|---|---|
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. |
Fouten die dit eindpunt kan retourneren
401 · 403 · 404 · 422 · 429 · 503