Lists

このエンドポイントでMarketing Email機能に関連づいた宛先リストの作成と管理を行います。

add

宛先リストを追加します。

URI引数 必須 条件 説明
list Yes なし 名前を指定して宛先リストを作成します
name No なし メールアドレスに関連したカラム名 name の名前を指定します。
Parameter Value Requirements Description

Call

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

Response

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

Call

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

Response

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

カラムを追加する場合は新しいカラム名を指定してEmails Addエンドポイントを利用することで追加することができます。


edit

宛先リストの名前を変更します。

URI引数 必須 条件 説明
list Yes 作成済みの宛先リスト 名前を変更する宛先リスト
newlist Yes なし 宛先リストの新しい名前を指定します。
Parameter Value Requirements Description

Call

POST https://api.sendgrid.com/api/newsletter/lists/edit.json
POST Data list=test7890&newlist=test567&api_user=your_sendgrid_username&api_key=your_sendgrid_password

Response

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

Call

POST https://api.sendgrid.com/api/newsletter/lists/edit.xml
POST Data list=test7890&newlist=test567&api_user=your_sendgrid_username&api_key=your_sendgrid_password

Response

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

get

アカウントに登録された宛先リストのリストを取得します。または特定のリストの存在チェックをします。

URI引数 必須 条件 説明
list No なし 指定したリストをチェックします(全リストを取得する場合このパラメータを指定しないでください)
Parameter Value Requirements Description

Call

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

Response

1
2
3
4
5
6
[
  {
    "id": 1,
    "list": "test"
  }
]

Call

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

Response

1
2
3
4
5
6
<lists>
   <list>
      <id>1</id>
      <list>test</list>
   </list>
</lists>

delete

宛先リストを削除します。

URI引数 必須 条件 説明
list Yes 作成済みの宛先リスト 宛先リストを削除します
Parameter Value Requirements Description

Call

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

Response

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

Call

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

Response

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