Saltar para a documentação
API

Definir uma resposta de ausência

Guardar a resposta de um endereço ou catch-all, substituindo o que estivesse guardado.

PUT/out-of-office

Executa a chamada real no seu espaço de trabalho.

PUT /out-of-office

Guardar a resposta de um endereço ou catch-all, substituindo o que estivesse guardado.

Exemplo

Requer settings:write. address vai na query, e message é o único campo obrigatório: texto simples 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."  }'
Resposta
{  "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"}

Omita startsAt para começar agora, ou para manter o início de uma resposta que já está ativa, e omita endsAt ou envie null para manter a resposta ativa até ser desligada. subject aceita no máximo 255 caracteres, e se ficar vazio a resposta responde com Re: e o assunto recebido. enabled: false mantém o texto e põe a resposta em pausa, e contactsOnly: true responde apenas a contactos e a pessoas a quem o espaço de trabalho já escreveu.

Cada remetente recebe a resposta uma vez por todo o período de ausência, dentro da mesma conversa, a partir do endereço onde o correio chegou. Alterar startsAt começa um novo período em que todos voltam a receber resposta uma vez, e alterar apenas o texto ou endsAt não. Sem endsAt um remetente volta a receber resposta passados 30 dias. A resposta leva Auto-Submitted: auto-replied, sem rastreio e sem assinatura, conta para os envios mensais, e continua a sair numa conversa silenciada.

O correio que não alertaria ninguém não recebe resposta: o spam, o correio que uma regra moveu para a lixeira, as newsletters e o restante correio em massa, o correio automático, as devoluções, os remetentes bloqueados e os endereços do próprio espaço de trabalho. A resposta guardada para o endereço exato aplica-se primeiro, depois a do endereço sem o seu sufixo com +, depois a do catch-all, e um catch-all nunca responde por um endereço que alguém criou à mão.

Um 422 invalid_parameter significa que address está em falta, não é um endereço do espaço de trabalho ou indica um domínio inteiro, que a mensagem está vazia, ou que endsAt não é posterior a startsAt ou já passou. Nada corre num temporizador: as datas são verificadas quando chega correio.

Referência