Sender Address

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

このエンドポイントでマーケティングメールに関連した送信者アドレス(正式にはアイデンティティ)の作成と管理を行います。

add

新しいアドレスを作成します。

URI引数 必須 条件 説明
identity Yes なし 作成するアイデンティティの名前
name Yes なし このアドレスで使用する名前を指定します
email Yes RFC 5322に準拠した電子メールアドレス形式 このアドレスで使用するメールアドレスを指定します
replyto No RFC 5322に準拠した電子メールアドレス形式 Reply-Toフィールドで使用するメールアドレスを指定します。定義しなかった場合、デフォルトは email パラメータです。
address Yes なし このアドレスで使用する住所です
city Yes なし このアドレスで使用する市です
state Yes なし このアドレスで使用する州です
zip Yes なし このアドレスで使用する郵便番号です
country Yes なし このアドレスで使用する国です
Parameter Value Requirements Description

Call

POST https://api.sendgrid.com/api/newsletter/identity/add.json
POST Data identity=Sender_Address1&name=Grant&email=grant.hull%40sendgrid.com&address=929_Pearl_Stree&city=Boulder&state=Colorado&zip=80302&country=US&api_user=your_sendgrid_username&api_key=your_sendgrid_password

Response

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

Call

POST https://api.sendgrid.com/api/newsletter/identity/add.xml
POST Data identity=Sender_Address1&name=Grant&email=grant.hull%40sendgrid.com&address=929_Pearl_Stree&city=Boulder&state=Colorado&zip=80302&country=US&api_user=your_sendgrid_username&api_key=your_sendgrid_password

Response

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

edit

作成済みのアドレスを編集します。

URI引数 必須 条件 説明
identity Yes 作成済みのアドレス 編集するアドレスの名前
newidentity No なし このアドレスで使用する新しい名前を指定します
name No なし このアドレスで使用する新しい名前を指定します
email Yes RFC 5322に準拠した電子メールアドレス形式 このアドレスで使用するメールアドレスを指定します
replyto No RFC 5322に準拠した電子メールアドレス形式 Reply-Toフィールドで使用するメールアドレスを指定します。定義しなかった場合、デフォルトは email パラメータです。
address No なし このアドレスで使用する新しい住所です
city Yes なし このアドレスで使用する新しい市です
state Yes なし このアドレスで使用する新しい州です
zip Yes なし このアドレスで使用する新しい郵便番号です
country Yes なし このアドレスで使用する新しい国です
Parameter Value Requirements Description

Call

POST https://api.sendgrid.com/api/newsletter/identity/edit.json
POST Data identity=Sender_Address2&newidentity=Sender_Address3&name=Grant&email=grant.hull%40sendgrid.com&address=929_Pearl_Street&city=Boulder&state=Colorado&zip=80302&country=US&api_user=your_sendgrid_username&api_key=your_sendgrid_password

Response

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

Call

POST https://api.sendgrid.com/api/newsletter/identity/edit.xml
POST Data identity=Sender_Address2&newidentity=Sender_Address3&name=Grant&email=grant.hull%40sendgrid.com&address=929_Pearl_Street&city=Boulder&state=Colorado&zip=80302&country=US&api_user=your_sendgrid_username&api_key=your_sendgrid_password

Response

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

get

指定したアドレスに関連する情報を取得します。

URI引数 必須 条件 説明
identity Yes 作成済みのアドレス 指定したアドレスのコンテンツを取得します
Parameter Value Requirements Description

Call

POST https://api.sendgrid.com/api/newsletter/identity/get.json
POST Data identity=Sender_Address&api_user=your_sendgrid_username&api_key=your_sendgrid_password

Response

1
2
3
4
5
6
7
8
9
10
11
{
  "city": "Boulder",
  "name": "Name",
  "zip": "80302",
  "replyto": "Email Address",
  "country": "US",
  "state": "CO",
  "address": "929 Pearl Street ste 200 ",
  "email": "example@sendgrid.com",
  "identity": "Sender_Address "
}

Call

POST https://api.sendgrid.com/api/newsletter/identity/get.xml
POST Data identity=Sender_Address&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
<identity>
   <city>Boulder</city>
   <name>Example Name</name>
   <zip>80302</zip>
   <replyto>example@sendgrid.com</replyto>
   <country>US</country>
   <state>CO</state>
   <address>
929 Pearl Street ste 200

</address>
   <email>example@sendgrid.com</email>
   <identity>Sender_Address </identity>
</identity>

list

アカウント内の全てのアドレスを取得するか指定したアドレスが存在するか確認します。

URI引数 必須 条件 説明
identity No 作成済みのアドレス 指定したアドレスを確認します。(全てのアドレスリストを取得する場合、このパラメータを指定しないでください)
Parameter Value Requirements Description

Call

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

Response

1
2
3
4
5
[
  {
    "identity": "Sender_Address4"
  }
]

Call

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

Response

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

delete

アカウントからアドレスを削除します。

URI引数 必須 条件 説明
identity Yes 作成済みのアドレス 指定したアドレスを削除します
Parameter Value Requirements Description

Call

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

Response

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

Call

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

Response

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