تخطَّ إلى المستندات
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.

المرجع