Zur Dokumentation springen
API

Personen aufnehmen und herausnehmen

Nimmt einen Kontakt beim ersten Schritt in eine aktive Automatisierung auf, egal welchen Auslöser sie hat, oder nimmt jemanden heraus, bevor er fertig ist.

POST/automations/{id}/enrollments

Führt jeden der 2 Aufrufe in Ihrem Workspace aus.

POST /automations/{id}/enrollments

Nimmt einen Kontakt beim ersten Schritt in eine aktive Automatisierung auf, egal welchen Auslöser sie hat, oder nimmt jemanden heraus, bevor er fertig ist.

Beispiel

Erfordert automations:write. Geben Sie den Kontakt mit email oder mit contactId an, nie mit beidem.

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"
Antwort
{  "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 enthält Werte, die die Schritte überall dort lesen können, wo ein Wert aus dem Ereignis kommt, höchstens 50 Schlüssel und 4 KB JSON.

Der Kontakt muss bereits existieren: Eine unbekannte Adresse antwortet mit 404 contact_not_found.

Wer bereits darin ist oder eine Automatisierung durchlaufen hat, die Personen nur einmal einlässt, wird mit 409 already_enrolled abgelehnt.

Ein Kontakt, der sich abgemeldet hat, unzustellbar war oder sich beschwert hat, wird mit 409 contact_unreachable abgelehnt.

Nur eine aktive Automatisierung nimmt Personen auf: 409 automation_not_live.

Jemanden herauszunehmen beendet seinen Durchlauf mit dem Grund removed. Eine bereits beendete Teilnahme antwortet mit 409 automation_enrollment_finished.

Referenz