ドキュメント本文へスキップ
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 で返され、完全な定義が求められるのは公開のときだけです。

同じキーを持つ 2 つのステップや、2 か所から到達するステップのように、構造そのものに反する定義は 422 invalid_automation で拒否されます。

settings には設定の一部だけを渡すことができ、残りは既定値のままです。timezone の既定値は UTC です。

1 つのワークスペースが持てるオートメーションは、既定で 100 件です。それを超えると 422 workspace_limit_reached で拒否されます。

リファレンス