Recipients

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

このエンドポイントでマーケティングメールに対して割り当てる宛先リストを管理します。

add

マーケティングメールに宛先リストを割り当てます。

URI引数 必須 条件 説明
list Yes なし マーケティングメールに割り当てる宛先リストの名前
name Yes なし マーケティングメールの名前
Parameter Value Requirements Description

Call

POST https://api.sendgrid.com/api/newsletter/recipients/add.json
POST Data name=SendGrid%20NL%20Test2&list=test&api_user=your_sendgrid_username&api_key=your_sendgrid_password

Response

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

Call

POST https://api.sendgrid.com/api/newsletter/recipients/add.xml
POST Data name=SendGrid%20NL%20Test2&list=test&api_user=your_sendgrid_username&api_key=your_sendgrid_password

Response

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

get

指定したマーケティングメールに割り当てられた全て宛先リストを取得します。

URI引数 必須 条件 説明
name Yes なし 宛先リストを取得するマーケティングメールの名前
Parameter Value Requirements Description

Call

POST https://api.sendgrid.com/api/newsletter/recipients/get.json
POST Data name=test&api_user=your_sendgrid_username&api_key=your_sendgrid_password

Response

1
2
3
4
5
[
  {
    "list": "Training Contacts"
  }
]

Call

POST https://api.sendgrid.com/api/newsletter/recipients/get.xml
POST Data name=test&api_user=your_sendgrid_username&api_key=your_sendgrid_password

Response

1
2
3
4
5
<lists>
   <list>
      <list>Training Contacts</list>
   </list>
</lists>

delete

マーケティングメールから宛先リストの割り当てを削除します。

URI引数 必須 条件 説明
name Yes 作成済みのマーケティングメール 宛先リストの割当を解除するマーケティングメール
list Yes 作成済みの宛先リスト マーケティングメールからこの宛先リストを削除します
Parameter Value Requirements Description

Call

POST https://api.sendgrid.com/api/newsletter/recipients/delete.json
POST Data name=SendGrid%20NL%20Test1&list=test&api_user=your_sendgrid_username&api_key=your_sendgrid_password

Response

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

Call

POST https://api.sendgrid.com/api/newsletter/recipients/delete.xml
POST Data name=SendGrid%20NL%20Test1&list=test&api_user=your_sendgrid_username&api_key=your_sendgrid_password

Response

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