Saltar para a documentação
API

Adicionar e retirar pessoas

Coloca um contacto no primeiro passo de uma automação ativa, seja qual for o acionador, ou retira alguém antes de terminar.

POST/automations/{id}/enrollments

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

POST /automations/{id}/enrollments

Coloca um contacto no primeiro passo de uma automação ativa, seja qual for o acionador, ou retira alguém antes de terminar.

Exemplo

Requer automations:write. Indique o contacto por email ou por contactId, nunca pelos dois.

curl
curl -X POST "$OE/automations/aut_7c2e9a1f4b8d30c65e1a9f27/enrollments" -H "$AUTH" -H 'content-type: application/json' -d '{  "email": "[email protected]",  "data": { "orderId": "A-1042" }}'curl -X POST "$OE/automations/aut_7c2e9a1f4b8d30c65e1a9f27/enrollments/aen_2d8f1b6c9e3a47d05b1c8e62/exit" -H "$AUTH"
Resposta
{  "object": "automation_enrollment",  "id": "aen_2d8f1b6c9e3a47d05b1c8e62",  "automationId": "aut_7c2e9a1f4b8d30c65e1a9f27",  "version": 2,  "contact": { "id": "5b0e7c1a-2f4d-4c8b-9a36-1e7d0c5f8b24", "email": "[email protected]", "name": "Ana Lima" },  "status": "active",  "source": "trigger",  "stepKey": "pause",  "waiting": true,  "waitingForEvent": null,  "heldFor": null,  "nextRunAt": "2026-10-14T08:02:11.000Z",  "exitReason": null,  "lastError": null,  "startedAt": "2026-10-11T08:02:03.000Z",  "finishedAt": null,  "updatedAt": "2026-10-11T08:02:11.000Z"}

data contém valores que os passos podem ler sempre que um valor vem do evento, no máximo 50 chaves e 4 KB de JSON.

O contacto tem de existir: um endereço desconhecido responde 404 contact_not_found.

Quem já está dentro, ou já passou por uma automação que só deixa entrar uma vez, é recusado com 409 already_enrolled.

Um contacto que cancelou a subscrição, cujo endereço devolveu correio ou que apresentou queixa é recusado com 409 contact_unreachable.

Só uma automação ativa aceita pessoas: 409 automation_not_live.

Retirar alguém termina o seu percurso com o motivo removed. Uma inscrição que já terminou responde 409 automation_enrollment_finished.

Referência