Skip to main content
配信メッセージ更新
PATCH

Authorizations

Authorization
string
header
required

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

Path Parameters

account_id
string
required

配信アカウントID

scenario_id
string
required

シナリオID

message_id
string
required

メッセージID

Body

application/json

配信メッセージ更新リクエスト(部分更新)。指定したフィールドのみ変更され、省略した フィールドは既存値を維持します。channel / type は変更できません(異なる値を指定すると 422)。conditions / url_actions / line.messages は指定すると全件置換されます。

status
enum<string>

ステータス。draft→reserved で予約実行(配信予約作成)、reserved→draft で予約解除(配信予約削除)。

Available options:
draft,
reserved
title
string | null

管理名称

Maximum string length: 255
use_ab_test
boolean | null

A/Bテスト使用

send_type
enum<string>

送信タイプ(MessageCreateRequest と同じ。broadcast: immediately / scheduled、step: immediately / scheduled / scheduled_addition)

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

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

send_day
integer

送信日数(step / reminder 用。0〜500)

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用)

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

基準日の読者項目名(reminder用)

step_send_type
enum<string>

ステップ送信タイプ(step用)

Available options:
none,
immediately
mail
object

メール原稿(省略時は既存維持。項目は MailContent と同じ)。type は変更不可のため指定不要。本文に置換URL・rid パラメータ付き URL は指定できません(422)。

line
object

LINE原稿(省略時は既存維持)。messages 指定時は全件置換。sender_id のみの指定も可。

sms
object

SMS原稿(省略時は既存維持)

action_id
string | null

配信後に実行するアクションのID(アクション管理のアクションを使う場合に指定。アクション一覧 API の id、または取得応答で現在設定されている ID)。 null で解除。このメッセージだけで使うアクションは action_details で直接指定します。

action_details
object[] | null

配信後に実行するアクションを、このメッセージの中で直接作って指定する動作の配列(最大100件。要素の形式は配信アクションの details と同じ)。 現在このメッセージの中で直接作ったアクション(取得応答の action_details が配列)が設定されていればその動作を全件置換し、 未設定・アクション管理のアクションを参照中なら新しく作って参照を切り替えます(参照中のアクション管理のアクションは変更されません)。 一緒に送る action_id は省略するか現在値のままにしてください(別の ID は 422)。省略・null・空配列は指定なし(解除は action_id: null)。

Maximum array length: 100
shorten_type
enum<string>

URL置換方法

Available options:
shorten_url,
original_url
shorten_domain
string | null

URL置換ドメイン。null で解除。

conditions
object[]

配信条件(指定時は全件置換、空配列で条件解除)

url_actions
object[]

URLアクション(指定時は全件置換、空配列でクリア。送信時に自動生成される計測用の行は置換の対象外で残ります)。各行の項目と制約は UrlAction を参照。 各行の action_details を指定するときは、その行の action_id を省略するか、取得応答の同じ url の行の値のままにします。

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[]

draft → reserved への変更時と配信予約の再作成時に検出された配信安全制御の警告(媒体を問わない)と、 メールのメッセージで予約への変更・再作成時または reserved 状態で mail を変更したときに検出された 配信解除URL欠如・DKIM未設定の警告。警告がある場合のみ返されます。