Saltar para a documentação
API

Pausar, retomar e arquivar

Pausar trava uma automação ativa sem perder ninguém: ninguém novo entra e todos os que estão dentro ficam no seu passo. Retomar continua a partir daí, e arquivar encerra a automação de vez.

POST/automations/{id}/pause

Executa qualquer uma das 3 chamadas no seu espaço de trabalho.

POST /automations/{id}/pause

Pausar trava uma automação ativa sem perder ninguém: ninguém novo entra e todos os que estão dentro ficam no seu passo. Retomar continua a partir daí, e arquivar encerra a automação de vez.

Exemplo

Requer automations:write. Retomar requer também emails:send.

curl
curl -X POST "$OE/automations/aut_7c2e9a1f4b8d30c65e1a9f27/pause" -H "$AUTH"curl -X POST "$OE/automations/aut_7c2e9a1f4b8d30c65e1a9f27/resume" -H "$AUTH"curl -X POST "$OE/automations/aut_7c2e9a1f4b8d30c65e1a9f27/archive" -H "$AUTH"
Resposta
{  "object": "automation",  "id": "aut_7c2e9a1f4b8d30c65e1a9f27",  "name": "Welcome series",  "description": null,  "status": "live",  "triggerKind": "audience_joined",  "stepCount": 4,  "emailCount": 2,  "hasUnpublishedChanges": false,  "publishedVersion": 2,  "pausedReason": null,  "lastError": null,  "counts": { "active": 38, "completed": 412, "exited": 9 },  "createdBy": "q7Vd3kX9mT2pLw8RzN4bYc6HfJ1sGa5E",  "publishedAt": "2026-10-02T09:14:00.000Z",  "pausedAt": null,  "archivedAt": null,  "createdAt": "2026-10-01T16:40:12.000Z",  "updatedAt": "2026-10-02T09:14:00.000Z",  "definition": {    "trigger": { "kind": "audience_joined", "audienceId": "aud_4c1b8e2a7d9f05c36b4e8a71", "includeImported": false },    "entry": "welcome",    "steps": [      {        "key": "welcome",        "kind": "send_email",        "next": "pause",        "templateId": "tpl_9c1f0a4b7e05d3862c1f0a44",        "templateVersion": null,        "from": { "email": "[email protected]", "name": "Acme" },        "replyTo": null,        "subject": null,        "props": { "firstName": { "source": "contact", "field": "firstName" } }      },      { "key": "pause", "kind": "wait", "next": "opened", "wait": { "mode": "duration", "amount": 3, "unit": "days" } },      {        "key": "opened",        "kind": "branch",        "condition": { "kind": "email_opened", "stepKey": "welcome" },        "yes": null,        "no": "nudge"      },      {        "key": "nudge",        "kind": "send_email",        "next": null,        "templateId": "tpl_8f3a1c2e9b7d4a60",        "templateVersion": null,        "from": { "email": "[email protected]", "name": "Acme" },        "replyTo": null,        "subject": "{{firstName|Hello}}, did you see this?",        "props": {}      }    ]  },  "published": { "trigger": { "kind": "audience_joined", "…": "…" }, "entry": "welcome", "steps": ["…"] },  "settings": {    "timezone": "Europe/London",    "sendWindow": { "days": [1, 2, 3, 4, 5], "startMinute": 540, "endMinute": 1020 },    "reentryDays": null,    "exitOnLeave": true,    "listAudienceId": null  },  "problems": []}

Uma espera continua a contar enquanto a automação está em pausa. Quem tiver terminado a espera entretanto avança assim que ela é retomada.

As pessoas que cumpriram o acionador enquanto estava em pausa não são adicionadas depois.

Retomar volta a verificar a versão ativa, e é recusado com 422 invalid_automation enquanto faltar um remetente, um modelo ou uma audiência de que ela precisa.

Arquivar não pode ser desfeito. Todos os que estão dentro saem com o motivo archived, e a automação deixa de contar para o plano.

Só uma automação publicada pode ser pausada ou retomada: 409 automation_not_published.

Referência