پرش به مستندات
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 کیلوبایت JSON.

مخاطب باید از قبل وجود داشته باشد: نشانی ناشناخته با 404 contact_not_found پاسخ می‌دهد.

کسی که از قبل درون آن است، یا از خودکارسازی‌ای گذشته که افراد را فقط یک بار راه می‌دهد، با 409 already_enrolled رد می‌شود.

مخاطبی که لغو اشتراک کرده، ایمیلش برگشت خورده یا شکایت کرده با 409 contact_unreachable رد می‌شود.

فقط خودکارسازی فعال افراد را می‌پذیرد: 409 automation_not_live.

خارج کردن کسی مسیرش را با دلیل removed تمام می‌کند. حضوری که از قبل تمام شده با 409 automation_enrollment_finished پاسخ می‌دهد.

مرجع