Categories

マーケティングメール機能(Legacy Newsletter)の提供は、 2017年9月30日をもって終了いたします。
後継機能となるマーケティングキャンペーンへの移行はお済みでしょうか? 移行方法についてはこちらをご確認ください。

このモジュールを使うことでマーケティングメールのカテゴリの作成と管理ができます。

create

新しいカテゴリを作成します。

URI引数 必須 条件 説明
category Yes None 作成するカテゴリ名称
Parameter Value Requirements Description

Call

POST https://api.sendgrid.com/api/newsletter/category/create.json
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&category=CATEGORY

Response

1
2
3
{
  "message": "success"
}

Call

POST https://api.sendgrid.com/api/newsletter/category/create.xml
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&category=CATEGORY

Response

1
2
3
<result>
   <message>success</message>
</result>

add

マーケティングメールにカテゴリを割り当てます。

URI引数 必須 条件 説明
category Yes 作成済みのカテゴリ マーケティングメールに割り当てるカテゴリ
name Yes 作成済みのマーケティングメール カテゴリを追加するマーケティングメール
Parameter Value Requirements Description

Call

POST https://api.sendgrid.com/api/newsletter/category/add.json
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&category=CATEGORY&name=NEWSLETTER

Response

1
2
3
{
  "message": "success"
}

Call

POST https://api.sendgrid.com/api/newsletter/category/add.xml
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&category=CATEGORY&name=NEWSLETTER

Response

1
2
3
<result>
   <message>success</message>
</result>

remove

マーケティングメールから指定したカテゴリまたは全てのカテゴリを削除します。

URI引数 必須 条件 説明
name Yes 作成済みのマーケティングメール カテゴリを削除するマーケティングメール
category No 作成済みかつマーケティングメールに追加されたカテゴリ 名前を指定してカテゴリを削除します。カテゴリが指定されなかった場合、マーケティングメールから全てのカテゴリが削除されます。
Parameter Value Requirements Description

Call

POST https://api.sendgrid.com/api/newsletter/category/remove.json
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&category=CATEGORY&name=NEWSLETTER

Response

1
2
3
{
  "message": "success"
}

Call

POST https://api.sendgrid.com/api/newsletter/category/remove.xml
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&category=CATEGORY&name=NEWSLETTER

Response

1
2
3
<result>
   <message>success</message>
</result>

list

全カテゴリのリストを取得します。

URI引数 必須 条件 説明
category No 作成済みカテゴリ 全てのカテゴリのリストから特定のカテゴリが存在するか検索します。
Parameter Value Requirements Description

Call

POST https://api.sendgrid.com/api/newsletter/category/list.json
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password

Response

1
[ { "category": "CATEGORY" }, { "category": "CATEGORY2" } ]

Call

POST https://api.sendgrid.com/api/newsletter/category/list.xml
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password

Response

1
2
3
4
5
6
7
8
<categories>
   <category>
      <category>CATEGORY</category>
   </category>
   <category>
      <category>CATEGORY2</category>
   </category>
</categories>