Emails

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

このエンドポイントで宛先リストのエントリの管理を行います。

add

宛先リストにメールアドレスを追加します。

URI引数 必須 条件 説明
list Yes 作成済みの宛先リスト メールアドレスを追加したい宛先リスト
data Yes JSON文字列に必要とされる適切なフォーマット。最大1000エントリ。 宛先リストに対して追加する名前、メールアドレス、その他追加のフィールドを指定します。
Parameter Value Requirements Description

Call

POST https://api.sendgrid.com/api/newsletter/lists/email/add.json
POST Data list=Test&data=%7B%22email%22%3A%22example%40gmail.com%22%2C%22name%22%3A%22example%22%7D&api_user=your_sendgrid_username&api_key=your_sendgrid_password

Response

1
2
3
{
  "inserted": 1
}

Call

POST https://api.sendgrid.com/api/newsletter/lists/email/add.xml
POST Data list=Test&data=%7B%22email%22%3A%22example%40gmail.com%22%2C%22name%22%3A%22example%22%7D&api_user=your_sendgrid_username&api_key=your_sendgrid_password

Response

1
2
3
<result>
   <inserted>1</inserted>
</result>

emailnameはdataパラメータ内のJSONで必須です。また、任意のキーについてもJSONで指定する必要があります。

宛先リストにアドレスを追加:

1
2
3
4
5
curl -X POST https://api.sendgrid.com/api/newsletter/lists/email/add.json \
     -d 'api_user=your_sendgrid_username' \
     -d 'api_key=your_sendgrid_password' \
     -d 'list=my_list' \
     -d 'data={"email":"address@domain.com","name":"contactName"}'

複数のデータフィールド付きで宛先リストにアドレスを追加:

1
2
3
4
5
curl -X POST https://api.sendgrid.com/api/newsletter/lists/email/add.json \
     -d 'api_user=your_sendgrid_username' \
     -d 'api_key=your_sendgrid_password' \
     -d 'list=my_list' \
     -d 'data={"email":"grouch@trashcan.com","name":"Oscar","city":"New York","street":"123 Sesame St"}'

宛先リストに複数のアドレスを追加:

1
2
3
4
5
6
curl -X POST https://api.sendgrid.com/api/newsletter/lists/email/add.json \
     -d 'api_user=your_sendgrid_username' \
     -d 'api_key=your_sendgrid_password' \
     -d 'list=my_list' \
     -d 'data[]={"email":"address1@domain.com","name":"contactName1"}' \
     -d 'data[]={"email":"address2@domain.com","name":"contactName2"}'

get

宛先リストのメールアドレスと関連したフィールドを取得します。

URI引数 必須 条件 説明
list Yes 作成済みの宛先リスト 検索する宛先リスト
email No メールアドレスまたはメールアドレスのリスト 宛先リストから検索するメールアドレス
unsubscribed No 1 配信停止になったアドレスリストを取得します
limit No 最大1000 結果を取得する件数を制限します。
offset No 整数 結果を取得する位置のオフセットを指定します。
Parameter Value Requirements Description

Call

GET https://api.sendgrid.com/api/newsletter/lists/email/get.json?list=Test&limit=100&offset=0&api_user=your_sendgrid_username&api_key=your_sendgrid_password

Response

1
2
3
4
5
6
[
  {
    "email": "dominic.may@sendgrid.com",
    "name": ""
  }
]

Call

GET https://api.sendgrid.com/api/newsletter/lists/email/get.xml?list=Test&limit=100&offset=0&api_user=your_sendgrid_username&api_key=your_sendgrid_password

Response

1
2
3
4
5
6
<emails>
   <email>
      <email>dominic.may@sendgrid.com</email>
      <name> </name>
   </email>
</emails>

count

宛先リストのエントリ数を取得します。

URI引数 必須 条件 説明
list Yes 作成済みの宛先リスト 対象とする宛先リスト
Parameter Value Requirements Description

Call

GET https://api.sendgrid.com/api/newsletter/lists/email/count.json?list=Test&api_user=your_sendgrid_username&api_key=your_sendgrid_password

Response

1
2
3
{
  "count": 2
}

Call

GET https://api.sendgrid.com/api/newsletter/lists/email/count.xml?list=Test&api_user=your_sendgrid_username&api_key=your_sendgrid_password

Response

1
2
3
<result>
   <count>2</count>
</result>

delete

宛先リストからメールアドレスを削除します。

URI引数 必須 条件 説明
list Yes 作成済みの宛先リスト メールアドレスを削除する宛先リスト
email[] Yes メールアドレスまたはメールアドレスのリスト 宛先リストから削除する一つ以上のメールアドレス。複数アドレスを削除する場合、email[]引数で指定します。
Parameter Value Requirements Description

Call

POST https://api.sendgrid.com/api/newsletter/lists/email/delete.json
POST Data list=Test&email[]=example@gmail.com&api_user=your_sendgrid_username&api_key=your_sendgrid_password

Response

1
2
3
{
  "removed": 1
}

Call

POST https://api.sendgrid.com/api/newsletter/lists/email/delete.xml
POST Data list=Test&email[]=example@gmail.com&api_user=your_sendgrid_username&api_key=your_sendgrid_password

Response

1
2
3
<result>
   <removed>1</removed>
</result>