Skip to main content
配信メッセージ作成
POST

Authorizations

Authorization
string
header
required

APIキーをBearerトークンとして指定

Path Parameters

account_id
string
required

配信アカウントID

scenario_id
string
required

シナリオID

Body

application/json

配信メッセージ作成リクエスト。type に応じて送信タイミング系フィールドを指定します。 送信タイミングの詳細な指定方法は MCPツール(message_create)の説明も参照してください。

channel
enum<string>
required

媒体(作成後に変更不可)

Available options:
mail,
line,
sms,
action
Example:

"mail"

type
enum<string>
required

配信タイプ(作成後に変更不可)

Available options:
broadcast,
step,
reminder
Example:

"broadcast"

status
enum<string>
default:draft

ステータス。reserved(予約)にすると配信安全制御・DKIM/SMS前提チェックが実行されます。

Available options:
draft,
reserved
title
string

管理名称

Maximum string length: 255
use_ab_test
boolean

A/Bテスト使用

send_type
enum<string>

送信タイプ。type=broadcast / step では status=draft でも必須です。 broadcast: immediately(即時)/ scheduled(日時指定。send_date・send_hour・send_min も必須)。 step: immediately / scheduled(日数指定。send_day・send_hour・send_min も必須)/ scheduled_addition(追加配信。send_day・send_hour・send_min は任意)。 type=reminder では不要で、代わりに base_date・send_timing・send_day・send_hour・send_min が必須です。

Available options:
immediately,
scheduled,
scheduled_addition
send_date
string<date>

送信日(broadcast用、YYYY-MM-DD)

send_day
integer

送信日数(step / reminder 用。0〜500)。step: 登録からの日数(0=当日)。 reminder: 基準日からの日数(0以上)。

Required range: 0 <= x <= 500
send_hour
integer

送信時(0-23)

Required range: 0 <= x <= 23
send_min
integer

送信分(0-59)

Required range: 0 <= x <= 59
send_timing
enum<string>

送信タイミング(reminder用)。before=基準日の前、after=基準日の後、today=基準日当日、 addition_before/addition_after=追加配信。

Available options:
before,
after,
today,
addition_before,
addition_after
base_date
string

基準日の読者項目名(reminder用)。置き換え文字一覧の reader_item から取得。

step_send_type
enum<string>

ステップ送信タイプ(step用)。none=指定日時に送信、immediately=登録直後に即時送信。

Available options:
none,
immediately
mail
object

メール原稿(channel=mail 時に必須)

line
object

LINE原稿(channel=line 時に必須)

sms
object

SMS原稿(channel=sms 時に必須)

action_id
string | null

配信後に実行するアクションのID(アクション管理のアクションを使う場合に指定。アクション一覧 API の id)。 このメッセージだけで使うアクションは action_details で直接指定します(同時指定は 422)。 channel=action かつ status=reserved のときは action_id または action_details が必須です。

action_details
object[] | null

配信後に実行するアクションを、このメッセージの中で直接作って指定する動作の配列(最大100件。要素の形式は配信アクションの details と同じ)。 画面の「新規にアクションを追加」と同じ形で保存され、アクション一覧 API には含まれません。 action_id とは同時に指定できません。省略・null・空配列は指定なし。

Maximum array length: 100
shorten_type
enum<string>
default:shorten_url

URL置換方法(shorten_url: 置換URLを表示、original_url: 元のURLを表示)

Available options:
shorten_url,
original_url
shorten_domain
string

URL置換ドメイン

conditions
object[]

配信条件。グループ間はOR結合、グループ内の rules はAND結合。 使用可能な key / condition / value は配信条件タイプ定義を参照してください。

url_actions
object[]

URLアクションの配列(リスト形式。各行の項目と制約は UrlAction を参照)

Response

作成された配信メッセージ

data
object

配信メッセージの詳細(作成・更新・取得の応答)。共通フィールドに加え、type に応じた送信タイミング系フィールド (send_type / send_date / send_day / send_hour / send_min / base_date / send_timing / step_send_type)と、channel に応じた原稿(mail / line / sms)、 url_actions を含みます。原稿のフィールドは該当する媒体のときだけ含まれます。

warnings
string[]

予約(reserved)化時に検出された警告(DKIM未設定・配信安全制御など)。 警告がある場合のみ返されることがあります。