Profile

アカウントのプロファイルを管理します。

get

SendGridのプロファイル情報を閲覧します。プロファイル情報を表示するためのパラメータは必要ありません。

Parameter Value Requirements Description

Call

GET https://api.sendgrid.com/api/profile.get.json?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
[
  {
    "username": "sampleuser@example.com",
    "email": "sampleemail@example.com",
    "active": "true",
    "first_name": "john",
    "last_name": "doe",
    "address": "555 any street",
    "city": "any city",
    "state": "CA",
    "zip": "91234",
    "country": "US",
    "phone": "555-555-5555",
    "website": "example.com"
  }
]

Call

GET https://api.sendgrid.com/api/profile.get.xml?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
<users>
   <user>
      <username>sampleuser@example.com</username>
      <email>sampleemail@example.com</email>
      <active>true</active>
      <first_name>john</first_name>
      <last_name>doe</last_name>
      <address>
555 any street
</address>
      <city>any city</city>
      <state>CA</state>
      <zip>91234</zip>
      <country>US</country>
      <phone>555-555-5555</phone>
      <website>example.com</website>
   </user>
</users>

set

URI引数 必須 条件 説明
first_name No 氏名(名)
last_name No 氏名(姓)
address No 会社住所
city No 会社所在地(市・区)
state No 会社所在地(州)
country No 会社所在地(国)
zip No 会社郵便番号
phone No ご連絡先電話番号
website No 会社Webサイト
Parameter Value Requirements Description

Call

POST https://api.sendgrid.com/api/profile.set.json
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&first_name=newFirstName&last_name=&newLastName

Response

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

Call

POST https://api.sendgrid.com/api/profile.set.xml
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&first_name=newFirstName&last_name=&newLastName

Response

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

setPassword

URI引数 必須 条件 説明
password Yes SendGridのパスワードポリシーについては SendGrid password requirements を参照してください 新しいパスワード
confirm_password Yes Must match password parameter 新しいパスワードの確認
Parameter Value Requirements Description

Call

POST https://api.sendgrid.com/api/password.set.json
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&password=newPassword&confirm_password=newPassword

Response

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

Call

POST https://api.sendgrid.com/api/password.set.xml
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&password=newPassword&confirm_password=newPassword

Response

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

setUsername

あなたのアカウントのusernameはSMTP サーバとWebサイトへのログインに使用されます。変更はすぐに反映されます。

URI引数 必須 条件 説明
username Yes 100文字以内。既に使用されていないこと。SendGrid.comドメインを含まないこと SMTPサーバとWebサイトで認証される新しいusernameです。変更はすぐに反映されます。
Parameter Value Requirements Description

Call

POST https://api.sendgrid.com/api/profile.setUsername.json
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&username=yournewusername@domain.com

Response

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

Call

POST https://api.sendgrid.com/api/profile.setUsername.xml
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&username=yournewusername@domain.com

Response

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

setEmail

新しいメールアドレスに対して確認のためにメールを送信します。そのメールに含まれる確認用リンクをクリックすることでメールが変更されます。

URI引数 必須 条件 説明
email Yes 正しいメールアドレス形式で100文字以内 お客様と連絡をとるための新しいメールアドレスです。変更はすぐに反映されます。
Parameter Value Requirements Description

Call

POST https://api.sendgrid.com/api/profile.setEmail.json
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&email=yournewemail@domain.com

Response

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

Call

POST https://api.sendgrid.com/api/profile.setEmail.xml
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&email=yournewemail@domain.com

Response

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