Users API

アカウントのプロファイル管理を行うことができます。

GET User Profile [GET]

アカウントプロファイルを取得します。

Request

1

GET https://api.sendgrid.com/v3/user/profile HTTP/1.1

Response

1
2
3
4
5
6
7
8
9
10
11
12
13

HTTP/1.1 200
{
  "address": "814 West Chapman Avenue",
  "city": "Orange",
  "company": "SendGrid",
  "country": "US",
  "first_name": "Test",
  "last_name": "User",
  "phone": "555-555-5555",
  "state": "CA",
  "website": "http://www.sendgrid.com",
  "zip": "92868"
}

PATCH User Profile [PATCH]

アカウントプロファイルを更新します。

Request

1

PATCH https://api.sendgrid.com/v3/user/profile HTTP/1.1
Request Body
1
2
3

{
  "city": "Orange"
}

Response

1
2
3
4
5
6
7
8
9
10
11
12
13

HTTP/1.1 200
{
  "address": "814 West Chapman Avenue",
  "city": "Orange",
  "company": "SendGrid",
  "country": "US",
  "first_name": "Test",
  "last_name": "User",
  "phone": "555-555-5555",
  "state": "CA",
  "website": "http://www.sendgrid.com",
  "zip": "92868"
}

GET User Account [GET]

アカウント情報を取得します。

Request

1

GET https://api.sendgrid.com/v3/user/account HTTP/1.1

Response

1
2
3
4
5

HTTP/1.1 200
{
  "type": "free",
  "reputation": 99.7
}

GET User Email [GET]

アカウントのメールアドレスを取得します。

Request

1

GET https://api.sendgrid.com/v3/user/email HTTP/1.1

Response

1
2
3
4

HTTP/1.1 200
{
  "email": "test@example.com"
}

PUT User Email [PUT]

アカウントのメールアドレスを更新します。
注：親アカウントの登録メールアドレスを更新したい場合は、弊社（構造計画研究所）マイページとの不整合を防ぐため、 このAPIは利用せずに弊社までお問い合わせください。

Request

1

PUT https://api.sendgrid.com/v3/user/email HTTP/1.1
Request Body
1
2
3

{
  "email": "test@example.com"
}

Response

1
2
3
4

HTTP/1.1 200
{
  "email": "test@example.com"
}

GET User Username [GET]

ユーザ名を取得します。

Request

1

GET https://api.sendgrid.com/v3/user/username HTTP/1.1

Response

1
2
3
4
5

HTTP/1.1 200
{
  "username": "test_username",
  "user_id": 1
}

PUT User Username [PUT]

ユーザ名を更新します。
注：親アカウントのユーザ名は更新できません。サブユーザのみ更新可能です。

Request

1

PUT https://api.sendgrid.com/v3/user/username HTTP/1.1
Request Body
1
2
3

{
  "username": "test_username"
}

Response

1
2
3
4

HTTP/1.1 200
{
  "username": "test_username"
}

GET User Credits [GET]

現在のクレジットを取得します。

Request

1

GET https://api.sendgrid.com/v3/user/credits HTTP/1.1

Response

1
2
3
4
5
6
7
8
9
10

HTTP/1.1 200
{
  "remain": 200,
  "total": 200,
  "overage": 0,
  "used": 0,
  "last_reset": "2013-01-01",
  "next_reset": "2013-02-01",
  "reset_frequency": "monthly"
}

PUT User Password [PUT]

アカウントのパスワードを更新します。
注：親アカウントのパスワードは更新できません。サブユーザのみ更新可能です。

Request

1

PUT https://api.sendgrid.com/v3/user/password HTTP/1.1
Request Body
1
2
3
4

{
  "new_password": "new_password",
  "old_password": "old_password"
}

Response

1
2
3

HTTP/1.1 200
{
}