Aller à la documentation
API

Ajouter et retirer des personnes

Fait entrer un contact dans une automatisation en ligne à sa première étape, quel que soit son déclencheur, ou retire quelqu'un avant la fin.

POST/automations/{id}/enrollments

Exécute l'un des 2 appels sur votre espace de travail.

POST /automations/{id}/enrollments

Fait entrer un contact dans une automatisation en ligne à sa première étape, quel que soit son déclencheur, ou retire quelqu'un avant la fin.

Exemple

Nécessite automations:write. Désignez le contact par email ou par contactId, jamais les deux.

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"
Réponse
{  "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 contient les valeurs que les étapes peuvent lire partout où une valeur vient de l'événement, au plus 50 clés et 4 Ko de JSON.

Le contact doit déjà exister : une adresse inconnue répond 404 contact_not_found.

Une personne déjà en cours, ou passée par une automatisation qui n'admet chacun qu'une fois, est refusée avec 409 already_enrolled.

Un contact désabonné, dont l'adresse a été rejetée ou qui s'est plaint est refusé avec 409 contact_unreachable.

Seule une automatisation en ligne accepte des personnes : 409 automation_not_live.

Retirer quelqu'un met fin à son parcours avec le motif removed. Une inscription déjà terminée répond 409 automation_enrollment_finished.

Référence