پرش به مستندات
API

ساختن یک خودکارسازی

یک پیش‌نویس از یک `definition`، از یک `starter`، یا اگر هیچ‌کدام را نفرستید یک پیش‌نویس خالی می‌سازد، و کل خودکارسازی را برمی‌گرداند. تا منتشرش نکنید چیزی اجرا نمی‌شود.

POST/automations

فراخوانی واقعی را روی فضای کاری شما اجرا می‌کند.

POST /automations

یک پیش‌نویس از یک definition، از یک starter، یا اگر هیچ‌کدام را نفرستید یک پیش‌نویس خالی می‌سازد، و کل خودکارسازی را برمی‌گرداند. تا منتشرش نکنید چیزی اجرا نمی‌شود.

نمونه

به automations:write نیاز دارد.

curl
curl -X POST "$OE/automations" -H "$AUTH" -H 'content-type: application/json' -d '{  "name": "Welcome series",  "starter": "welcome-series",  "settings": { "timezone": "Europe/London" }}'
پاسخ
{  "object": "automation",  "id": "aut_7c2e9a1f4b8d30c65e1a9f27",  "name": "Welcome series",  "description": null,  "status": "live",  "triggerKind": "audience_joined",  "stepCount": 4,  "emailCount": 2,  "hasUnpublishedChanges": false,  "publishedVersion": 2,  "pausedReason": null,  "lastError": null,  "counts": { "active": 38, "completed": 412, "exited": 9 },  "createdBy": "q7Vd3kX9mT2pLw8RzN4bYc6HfJ1sGa5E",  "publishedAt": "2026-10-02T09:14:00.000Z",  "pausedAt": null,  "archivedAt": null,  "createdAt": "2026-10-01T16:40:12.000Z",  "updatedAt": "2026-10-02T09:14:00.000Z",  "definition": {    "trigger": { "kind": "audience_joined", "audienceId": "aud_4c1b8e2a7d9f05c36b4e8a71", "includeImported": false },    "entry": "welcome",    "steps": [      {        "key": "welcome",        "kind": "send_email",        "next": "pause",        "templateId": "tpl_9c1f0a4b7e05d3862c1f0a44",        "templateVersion": null,        "from": { "email": "[email protected]", "name": "Acme" },        "replyTo": null,        "subject": null,        "props": { "firstName": { "source": "contact", "field": "firstName" } }      },      { "key": "pause", "kind": "wait", "next": "opened", "wait": { "mode": "duration", "amount": 3, "unit": "days" } },      {        "key": "opened",        "kind": "branch",        "condition": { "kind": "email_opened", "stepKey": "welcome" },        "yes": null,        "no": "nudge"      },      {        "key": "nudge",        "kind": "send_email",        "next": null,        "templateId": "tpl_8f3a1c2e9b7d4a60",        "templateVersion": null,        "from": { "email": "[email protected]", "name": "Acme" },        "replyTo": null,        "subject": "{{firstName|Hello}}, did you see this?",        "props": {}      }    ]  },  "published": { "trigger": { "kind": "audience_joined", "…": "…" }, "entry": "welcome", "steps": ["…"] },  "settings": {    "timezone": "Europe/London",    "sendWindow": { "days": [1, 2, 3, 4, 5], "startMinute": 540, "endMinute": 1020 },    "reentryDays": null,    "exitOnLeave": true,    "listAudienceId": null  },  "problems": []}

پیش‌نویس می‌تواند ناتمام باشد. هر چه کم باشد در problems برمی‌گردد، و فقط انتشار است که تعریف کامل می‌خواهد.

تعریفی که خود ساختار را بشکند، مثل دو گام با یک کلید یا گامی که از دو جا به آن می‌رسند، با 422 invalid_automation رد می‌شود.

settings هر زیرمجموعه‌ای از تنظیمات را می‌پذیرد، و بقیه پیش‌فرض خود را نگه می‌دارند. پیش‌فرض timezone مقدار UTC است.

هر فضای کاری به‌طور پیش‌فرض 100 خودکارسازی نگه می‌دارد. خودکارسازی بعدی با 422 workspace_limit_reached رد می‌شود.

مرجع