新しいメールマガジンを登録します。

リクエスト

メソッド

POST

URL

https:////mailmag/rest_api=1.0/

ヘッダー

パラメータ名値
Content-Type application/json
但しファイルを転送する場合は、multipart/form-data

すべてのリソースで共通のリクエストヘッダーは、こちらをご参照ください。

コンテント

更新したいフィールドのみを指定します。

フィールド名型説明
title 文字列 メールマガジン件名
text 文字列 メールマガジン本文
distributed 日時 配信予約日時
target メンバーターゲッティングオブジェクト 配信ターゲット
to_field 文字列 配信先メールアドレス（メンバーコンテンツフィールドID）
from_email 文字列 配信元メールアドレス（未指定の場合は、管理者メールアドレスが使用されます）
text_type 文字列 本文の形式
  • text: プレーンテキスト形式（デフォルト）
  • html: HTML形式
status 数値 配信ステータス
  • 1: 配信予約（デフォルト）
  • -1: 下書き保存
acl ACLオブジェクト 個別アクセスコントロール (ACL)

リクエスト例

curl　-v　-X　POST
　　　　　　　-H　"CONTENT-TYPE:　application/json"　
　　　　　　　-H　"X-ECHO-APP-ID:　fd15eacfaf2388fac2980fef163c6116"　
　　　　　　　-H　"X-ECHO-APP-KEY:　0cdf8bc765d7d9604e83becf93137d42"　
　　　　　　　"https://hogehoge.echopf.com/members/mailmag/rest_api=1.0/"
　　　　　　　-d　'{"title":"mailmag　title",　"text":"mailmag　text",　"to_field":"email",　"target":{"members":"*"},　"distributed":"2016-10-10　10:10:10"}'

レスポンス

HTTPステータス

ステータスコード内容
201 追加成功

ヘッダー

パラメータ名値
Content-Type application/json

コンテント

登録したメールマガジンデータが出力されます。

フィールド名型説明
メ
ー
ル
マ
ガ
ジ
ン
オ
ブ
ジ
ェ
ク
ト		 refid 文字列 メールマガジンID
title 文字列 メールマガジン件名
text 文字列 メールマガジン本文
distributed 日時 配信予約日時
target メンバーターゲッティングオブジェクト 配信ターゲット
to_field 文字列 配信先メールアドレス（メンバーコンテンツフィールドID）
from_email 文字列 配信元メールアドレス
text_type 文字列 本文の形式
status 数値 配信ステータス
  • 0: 配信完了
  • 1: 配信予約
  • -1: 下書き保存
  • 9: テスト配信予約済
created 日時 登録日時
modified 日時 最終更新日時
acl ACLオブジェクト アクセスコントロール (ACL)

レスポンス例

{
　　"refid":"240",
　　"to_field":"email",
　　"from_email":"[email protected]",
　　"title":"mailmag　title",
　　"text":"mailmag　text",
　　"text_type":"text",
　　"status":-1,
　　"distributed":"2015-11-11　10:10:10",
　　"created":"2015-11-10　10:10:10",
　　"modified":"2015-11-10　10:10:10",
　　"target":{
　　　　"members":"*"
　　},
　　"resource_type":"mailmag",
　　"acl":{
　　　　"*":{
　　　　　　"get":true,
　　　　　　"list":true,
　　　　　　"edit":true,
　　　　　　"delete":true
　　　　}
　　}
}