Ir a la documentación
API

Añadir y quitar personas

Mete a un contacto en una automatización activa por su primer paso, sea cual sea su desencadenante, o saca a alguien antes de que termine.

POST/automations/{id}/enrollments

Ejecuta cualquiera de las 2 llamadas en tu espacio de trabajo.

POST /automations/{id}/enrollments

Mete a un contacto en una automatización activa por su primer paso, sea cual sea su desencadenante, o saca a alguien antes de que termine.

Ejemplo

Requiere automations:write. Indica el contacto con email o con contactId, nunca con los dos.

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"
Respuesta
{  "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 contiene valores que los pasos pueden leer allí donde un valor viene del evento, como máximo 50 claves y 4 KB de JSON.

El contacto tiene que existir ya: una dirección desconocida responde 404 contact_not_found.

Quien ya está dentro, o quien pasó por una automatización que solo deja entrar una vez, se rechaza con 409 already_enrolled.

Un contacto que se dio de baja, rebotó o se quejó se rechaza con 409 contact_unreachable.

Solo una automatización activa admite personas: 409 automation_not_live.

Sacar a alguien termina su recorrido con el motivo removed. Una inscripción que ya terminó responde 409 automation_enrollment_finished.

Referencia