ドキュメント本文へスキップ
API

テストメールを送信する

下書きのメールステップ 1 つを、サンプル値を入れて指定のアドレスに送信します。ほかの誰よりも先に内容を確認できます。

POST/automations/{id}/test

実際の呼び出しをワークスペースに対して実行します。

POST /automations/{id}/test

下書きのメールステップ 1 つを、サンプル値を入れて指定のアドレスに送信します。ほかの誰よりも先に内容を確認できます。

例

automations:write と emails:send が必要です。

curl
curl -X POST "$OE/automations/aut_7c2e9a1f4b8d30c65e1a9f27/test" -H "$AUTH" -H 'content-type: application/json' -d '{  "stepKey": "welcome",  "to": "[email protected]"}'
レスポンス
{  "object": "automation_test",  "automationId": "aut_7c2e9a1f4b8d30c65e1a9f27",  "emailId": "msg_8cd0a316930b4482a8b8440b",  "to": "[email protected]",  "stepKey": "welcome"}

to を省略すると、テストはキーまたはアプリが代理する人のアカウントのメールアドレスに送られます。

テストでは誰も追加されず、数値にも数えられません。件名は [Test] で始まり、配信停止リンクを開いても誰も配信停止されません。

stepKey には下書きの send_email ステップを指定する必要があります。そうでない場合は 422 invalid_automation が返ります。

リファレンス