POST /v1/mail/services/{mailServiceId}/responders
Set an auto-reply on a mailbox.
Autenticación
Envía una clave de API como token de portador. La clave debe tener el permiso mail.manage; una clave que no lo tenga se rechazará con un código 403, no 404.
Este endpoint no requiere ningún id de organización. Su clave ya identifica la organización a la que pertenece, y la respuesta está delimitada a ella.
Pruébalo
Reemplaza cualquier elemento entre corchetes angulares por tus propios valores, y el marcador de posición key con una clave de tu panel de control.
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> }'¿Has iniciado sesión? La consola de la API en tu panel de control rellena el ID de tu organización real y tu propia clave, y ejecuta la solicitud contra la API en vivo para que puedas ver la respuesta real. Abre este endpoint en la consola de la API
Detalles
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`.
Parámetros
| Nombre | Tipo | Obligatorio | ¿Qué es esto? |
|---|---|---|---|
mailServiceId (path) | Uuid | Sí | Email service ID (UUIDv7). |
Cuerpo de la solicitud
| Nombre | Tipo | Obligatorio | ¿Qué es esto? |
|---|---|---|---|
local | string | Sí | The mailbox to auto-reply for. |
subject | string | No | — |
content | string | Sí | — |
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. |
Respuesta
| Nombre | Tipo | Obligatorio | ¿Qué es esto? |
|---|---|---|---|
id | string | Sí | The mail backend's identifier - the handle `DELETE` needs. |
local | string | Sí | The part before the `@`. |
address | string | Sí | The mailbox this replies for. |
subject | string | Sí | — |
content | string | Sí | The reply body. |
start_time | string | Sí | 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 | Sí | When the auto-reply stops. `null` to run until switched off. |
Errores que este endpoint puede devolver
401 · 403 · 404 · 422 · 429 · 503