Marketing Emails

このエンドポイントでMarketing Emailの追加、閲覧、削除を行います。

add

マーケティングメールを追加します。

URI引数 必須 条件 説明
identity Yes 作成済みのアイデンティティ 作成するマーケティングメールで使用されるアイデンティティ(送信者アドレス)
name Yes なし 作成するマーケティングメールで使用される名前
subject Yes なし 作成するマーケティングメールで使用される件名
text Yes textまたはhtmlのいずれか一方の指定が必須(※) 作成するマーケティングメールの本文のテキストパート
html Yes textまたはhtmlのいずれか一方の指定が必須(※) 作成するマーケティングメールの本文のHTMLパート

※カスタムタグを利用する場合textおよびhtml両パラメータの指定が必要です。

Parameter Value Requirements Description

Call

POST https://api.sendgrid.com/api/newsletter/add.json
POST Data identity=Sender_Address&name=SendGrid_Test&subject=testsubject&text=testtextbody&html=%3Chtml%3E%3Cp%3Etest_html_body%3C%2Fp%3E%3C%2Fhtml%3E&api_user=your_sendgrid_username&api_key=your_sendgrid_password

Response

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

Call

POST https://api.sendgrid.com/api/newsletter/add.xml
POST Data identity=Sender_Address&name=SendGrid_Test&subject=testsubject&text=testtextbody&html=%3Chtml%3E%3Cp%3Etest_html_body%3C%2Fp%3E%3C%2Fhtml%3E&api_user=your_sendgrid_username&api_key=your_sendgrid_password

Response

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

edit

マーケティングメールを編集します。

URI引数 必須 条件 説明
identity Yes 作成済みのアイデンティティ 編集するマーケティングメールの新しいアイデンティティ
name Yes 作成済みのマーケティングメール 編集するマーケティングメールの名前
newname No なし 編集するマーケティングメールの新しい名前
subject Yes なし 編集するマーケティングメールの新しい件名
text Yes textまたはhtmlのいずれか一方の指定が必須(※) 編集するマーケティングメールの新しい本文のテキストパート
html Yes textまたはhtmlのいずれか一方の指定が必須(※) 編集するマーケティングメールの新しいHTMLパート

※カスタムタグを利用する場合textおよびhtml両パラメータの指定が必要です。

Parameter Value Requirements Description

Call

POST https://api.sendgrid.com/api/newsletter/edit.json
POST Data identity=Sender_Address&name=SendGrid_Edit_Test&newname=new_name_test&subject=test_subject&text=test_text&html=%3Chtml%3E%3Cp%3ETest_html_text%3C%2Fp%3E%3C%2Fhtml%3E&api_user=your_sendgrid_username&api_key=your_sendgrid_password

Response

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

Call

POST https://api.sendgrid.com/api/newsletter/edit.xml
POST Data identity=Sender_Address&name=SendGrid_Edit_Test&newname=new_name_test&subject=test_subject&text=test_text&html=%3Chtml%3E%3Cp%3ETest_html_text%3C%2Fp%3E%3C%2Fhtml%3E&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/get.json
POST Data name=SendGrid_Test&api_user=your_sendgrid_username&api_key=your_sendgrid_password

Response

1
2
3
4
5
6
7
8
9
10
11
12
{
  "can_edit": true,
  "name": "SendGrid NL Test",
  "text": null,
  "newsletter_id": 38074,
  "total_recipients": 1,
  "html": null,
  "type": "html",
  "date_schedule": null,
  "identity": "d22de3a53fac1abef944c80c19032c2c",
  "subject": null
}

Call

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

Response

1
2
3
4
5
6
7
8
9
10
11
<newsletter>
   <can_edit>True</can_edit>
   <name>SendGrid NL Test</name>
   <text/>
   <newsletter_id>38074</newsletter_id>
   <total_recipients>1</total_recipients>
   <type>html</type>
   <date_schedule/>
   <identity>d22de3a53fac1abef944c80c19032c2c</identity>
   <subject/>
</newsletter>

list

作成済みのマーケティングメールのリストを取得します。

URI引数 必須 条件 説明
name No 作成済みのマーケティングメール 作成済みのマーケティングメールを検索するか全てのマーケティングメールのリストを取得する
Parameter Value Requirements Description

Call

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

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
[
  {
    "name": "Just Testing",
    "newsletter_id": 560308
  },
  {
    "name": "LSRC",
    "newsletter_id": 560869
  },
  {
    "name": "LSRC test",
    "newsletter_id": 560908
  },
  {
    "name": "Test",
    "newsletter_id": 38074
  }
]

Call

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

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
<newsletters>
   <newsletter>
      <name>Just Testing</name>
      <newsletter_id>560308</newsletter_id>
   </newsletter>
   <newsletter>
      <name>LSRC</name>
      <newsletter_id>560869</newsletter_id>
   </newsletter>
   <newsletter>
      <name>LSRC test</name>
      <newsletter_id>560908</newsletter_id>
   </newsletter>
   <newsletter>
      <name>Test</name>
      <newsletter_id>38074</newsletter_id>
   </newsletter>
</newsletters>

delete

作成済みのマーケティングメールを削除します。

URI引数 必須 条件 説明
name Yes 作成済みのマーケティングメール 指定したマーケティングメールを削除します
Parameter Value Requirements Description

Call

POST https://api.sendgrid.com/api/newsletter/delete.json
POST Data name=SendGrid_Test1&api_user=your_sendgrid_username&api_key=your_sendgrid_password

Response

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

Call

POST https://api.sendgrid.com/api/newsletter/delete.xml
POST Data name=SendGrid_Test1&api_user=your_sendgrid_username&api_key=your_sendgrid_password

Response

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