Перейти к документации
API

Как добавить и убрать людей

Помещает контакт на первый шаг активной автоматизации, каким бы ни был её триггер, или убирает человека до того, как он закончит.

POST/automations/{id}/enrollments

Выполняет любой из 2 запросов в вашем рабочем пространстве.

POST /automations/{id}/enrollments

Помещает контакт на первый шаг активной автоматизации, каким бы ни был её триггер, или убирает человека до того, как он закончит.

Пример

Требуется automations:write. Укажите контакт через email или через contactId, но не через оба сразу.

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"
Ответ
{  "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 содержит значения, которые шаги могут читать везде, где значение берётся из события: не более 50 ключей и 4 KB JSON.

Контакт уже должен существовать: неизвестный адрес отвечает 404 contact_not_found.

Тот, кто уже внутри или уже прошёл автоматизацию, которая пускает людей один раз, отклоняется с 409 already_enrolled.

Контакт, который отписался, чей адрес вернул письмо или который пожаловался, отклоняется с 409 contact_unreachable.

Людей принимает только активная автоматизация: 409 automation_not_live.

Когда человека убирают, его прохождение завершается с причиной removed. Участие, которое уже завершилось, отвечает 409 automation_enrollment_finished.

Справочник