Ir a la documentación
API

Configurar una respuesta de ausencia

Guarda la respuesta de una dirección o de un catch-all, sustituyendo lo que hubiera guardado.

PUT/out-of-office

Ejecuta la llamada real en tu espacio de trabajo.

PUT /out-of-office

Guarda la respuesta de una dirección o de un catch-all, sustituyendo lo que hubiera guardado.

Ejemplo

Requiere settings:write. address va en la cadena de consulta, y message es el único campo obligatorio: texto plano de 1 a 10.000 caracteres.

curl
curl -X PUT "$OE/[email protected]" -H "$AUTH" -H "Content-Type: application/json" \  -d '{    "startsAt": "2026-12-22T00:00:00Z",    "endsAt": "2027-01-04T08:00:00Z",    "subject": "Away until 4 January",    "message": "I am away until 4 January and will answer when I am back."  }'
Respuesta
{  "object": "out_of_office",  "address": "[email protected]",  "enabled": true,  "active": true,  "startsAt": "2026-12-22T00:00:00.000Z",  "endsAt": "2027-01-04T08:00:00.000Z",  "subject": "Away until 4 January",  "message": "I am away until 4 January and will answer when I am back.",  "contactsOnly": false,  "updatedAt": "2026-12-22T09:14:03.117Z"}

Omite startsAt para empezar ahora, o para conservar el inicio de una respuesta que ya está activa, y omite endsAt o pon null para mantener la respuesta activa hasta que se desactive. subject admite como máximo 255 caracteres, y si se deja vacío la respuesta sale con Re: y el asunto recibido. enabled: false conserva el texto y pone la respuesta en pausa, y contactsOnly: true responde solo a los contactos y a las personas a las que el espacio de trabajo ha escrito.

Cada remitente recibe la respuesta una sola vez para todo el periodo de ausencia, dentro de la misma conversación, desde la dirección a la que llegó el correo. Cambiar startsAt empieza un periodo nuevo en el que se responde a todos una vez más, y cambiar solo el texto o endsAt no. Sin endsAt se vuelve a responder a un remitente pasados 30 días. La respuesta lleva Auto-Submitted: auto-replied, no lleva seguimiento ni firma, cuenta para los envíos mensuales y sale igualmente en una conversación silenciada.

El correo que no avisaría a nadie no recibe respuesta: el spam, el correo que una regla movió a la papelera, los boletines y otro correo masivo, el correo automático, los rebotes, los remitentes bloqueados y las direcciones propias del espacio de trabajo. Primero se aplica la respuesta guardada para la dirección exacta, luego la de la dirección sin su sufijo plus, y luego la del catch-all, y un catch-all nunca responde por una dirección que alguien creó a mano.

Un 422 invalid_parameter significa que falta address, que no es una dirección del espacio de trabajo o que nombra un dominio entero, que el mensaje está vacío, o que endsAt no es posterior a startsAt o ya ha pasado. Nada funciona con temporizador: las fechas se comprueban cuando llega el correo.

Referencia