メインコンテンツへスキップ

はじめに

Campaignsは、APIの呼び出しからキャンペーンを開始する機能をサポートしています。

キャンペーンを開始する

エンドポイント
キャンペーンを開始するために呼び出すエンドポイントは、以下のとおりです。 https://campaigns-prod.domolabs.io/api/v1/campaigns/start
オブジェクト
以下のJSONオブジェクトを使用して、上記のエンドポイントにPOSTイベントを呼び出します。
{ "campaignId": 0, "domoAccessToken": "", "domoAccessTokenOwnerEmailAddress": "", "emailAddresses": [], "instance": "" }
キャンペーンID
開始するキャンペーンのID。キャンペーンIDは、キャンペーンを編集し[SETTINGS]タブに移動することで確認できます。
CampaignId.png
Domoアクセストークン
Domoで生成されたDomoアクセストークン。Domoアクセストークンは、ログインして管理者設定セクションに移動し、[セキュリティ]に進み、[アクセストークン]を選択することで生成できます。ここで、APIの呼び出しに使用する新しいアクセストークンを簡単に生成できます。
AccessToken.PNG
Domoアクセストークン所有者のメールアドレス
上記で指定した Domoアクセストークン を所有しているユーザーのメールアドレス。
メールアドレス(オプション)
キャンペーンを配信するメールアドレスのリスト。メールアドレスが選択されていない場合、キャンペーン全体が開始され、配布リストのすべての受信者に配信されます。
インスタンス
お客様のDomoインスタンス(例: domo.domo.com )。
まとめ
パス https://campaigns-prod.domolabs.io/api/v1/campaigns/start
右のバージョン以降 1.0
説明 キャンペーンを実行して、配布リストのすべてのユーザーまたは選択したユーザーリストにメールを送信します。
認証 なし、Roles:anonymous
生成
application/json
消費
application/json
Bodyオブジェクト
startcampaign
Responseステータスコード
200 - OK
Responseオブジェクト
void
日本語