Subuser Management

このエンドポイントを含むWeb API v2の機能は、2025年2月に提供を終了します。

今後はWeb API v3をご利用ください。

このコマンドを使うことでサブユーザの作成、管理、削除を行うことができます。

サブユーザアカウントを作成および検索する場合username引数を使用します。他の場合はuser引数を使用します。サブユーザを作成する場合、user引数は存在しません。サブユーザを検索する場合、適切なusernameで認証を行っています。

APIを使用してサブユーザを作成する際の推奨方法については、こちらを参照してください。

Create a Subuser

URI引数 必須 条件 説明
username Yes 64文字以下 新しいサブユーザのusername
password Yes SendGrid password requirements参照 サブユーザの新しいパスワード
confirm_password Yes passwordパラメータと一致していること パスワードの確認
email Yes メールフォーマット。64文字以下 新しいサブユーザのメールアドレス
first_name Yes 50文字以下 新しいサブユーザのファーストネーム
last_name Yes 50文字以下 新しいサブユーザのラストネーム
address Yes 100文字以下 新しいサブユーザの住所
city Yes 100文字以下 新しいサブユーザの市
state Yes 100文字以下 新しいサブユーザの州
zip Yes 50文字以下 新しいサブユーザの郵便番号
country Yes ISO 3166-1 alpha-2 国コード 新しいサブユーザの国
phone Yes 50文字以下 新しいサブユーザの電話番号
website Yes 255文字以下 新しいサブユーザのWebサイト
company Yes 255文字以下 新しいサブユーザの会社
mail_domain No 親アカウントにセットアップ済みのWhitelabelレコード 新しいサブユーザのWhitelabel。WhitelabelレコードにIPを割り当てることにご注意ください。
Parameter Value Requirements Description 
1

3575195296

Call

POST https://api.sendgrid.com/apiv2/customer.add.json
POST Data api_user=apikey&api_key=your_sendgrid_api_key&username=subuser_username&website=domain.com&password=subuser_password&confirm_password=subuser_password&first_name=subuser_first_name&last_name=subuser_last_name&address="123

Response

1
2
3

{
  "message": "success"
}

Call

POST https://api.sendgrid.com/apiv2/customer.add.xml
POST Data api_user=apikey&api_key=your_sendgrid_api_key&username=subuser_username&website=domain.com&password=subuser_password&confirm_password=subuser_password&first_name=subuser_first_name&last_name=subuser_last_name&address="123

Response

1
2
3

<result>
   <message>success</message>
</result>

Delete Subuser

サブユーザを削除すると過去に送信したメール内の全てのクリックトラッキング対象のリンクが無効化されます。リンクをクリックしても意図したURLにリダイレクトされません。この変更は取り消すことができないため、サブユーザの削除は注意が必要です。

URI引数 必須 条件 説明
user Yes 存在するサブユーザ名 削除対象のサブユーザ
Parameter Value Requirements Description 
1

9940325328

Call

POST https://api.sendgrid.com/apiv2/customer.delete.json
POST Data api_user=apikey&api_key=your_sendgrid_api_key&user=subuser_username

Response

1
2
3

{
  "message": "success"
}

Call

POST https://api.sendgrid.com/apiv2/customer.delete.xml
POST Data api_user=apikey&api_key=your_sendgrid_api_key&user=subuser_username

Response

1
2
3

<result>
   <message>success</message>
</result>

Retrieve Subusers

サブユーザの完全な一覧を取得します。

URI引数 必須 条件 説明
task Yes getを指定します サブユーザのリストを取得します
username No 検索フィルタ。親アカウント配下に登録されているサブユーザ 結果をフィルタする文字列
email No 検索フィルタ。サブユーザに登録されているメールアドレス 結果をフィルタする文字列
active No 0または1 結果をフィルタするフラグ
first_name No 検索フィルタ。サブユーザのファーストネーム 結果をフィルタする文字列
last_name No 検索フィルタ。サブユーザのラストネーム 結果をフィルタする文字列
address No 検索フィルタ。サブユーザの住所 結果をフィルタする文字列
city No 検索フィルタ。サブユーザの市 結果をフィルタする文字列
state No 検索フィルタ。サブユーザの州 結果をフィルタする文字列
country No 検索フィルタ。サブユーザの国 結果をフィルタする文字列
zip No 検索フィルタ。サブユーザの郵便番号 結果をフィルタする文字列
phone No 検索フィルタ。サブユーザの電話番号 結果をフィルタする文字列
website No 検索フィルタ。サブユーザのWebサイト 結果をフィルタする文字列
company No 検索フィルタ。サブユーザの会社 結果をフィルタする文字列
Parameter Value Requirements Description 
1

8560564044

Call

POST https://api.sendgrid.com/apiv2/customer.profile.json
POST Data api_user=apikey&api_key=your_sendgrid_api_key&task=get

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30

[
  {
    "username": "username",
    "email": "example1@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"
  },
  {
    "username": "username",
    "email": "example2@example.com",
    "active": "false",
    "first_name": "jane",
    "last_name": "doe",
    "address": "555 any street",
    "city": "any city",
    "state": "CA",
    "zip": "91234",
    "country": "US",
    "phone": "555-555-5555",
    "website": "example.com"
  }
]

Call

POST https://api.sendgrid.com/apiv2/customer.profile.xml
POST Data api_user=apikey&api_key=your_sendgrid_api_key&task=get

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36

<users>
   <user>
      <username>username</username>
      <email>example1@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>
   <user>
      <username>username</username>
      <email>example2@example.com</email>
      <active>false</active>
      <first_name>jane</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>

Update Subuser Username

サブユーザのusernameはAPIおよびWebサイトへアクセスする際に使用されています。変更はすぐに反映されます。

URI引数 必須 条件 説明
task Yes setUsernameを指定します サブユーザのusernameを変更することを意味します。
user Yes 親アカウント配下に登録されているサブユーザ usernameを変更するサブユーザ
username Yes 適切なusername形式 新しいサブユーザのusername
Parameter Value Requirements Description 
1

980201064

Call

POST https://api.sendgrid.com/apiv2/customer.profile.json
POST Data api_user=apikey&api_key=your_sendgrid_api_key&task=setUsername&user=subuser_username&username=newsubuser_username

Response

1
2
3

{
  "message": "success"
}

Call

POST https://api.sendgrid.com/apiv2/customer.profile.xml
POST Data api_user=apikey&api_key=your_sendgrid_api_key&task=setUsername&user=subuser_username&username=newsubuser_username

Response

1
2
3

<result>
   <message>success</message>
</result>

Update Subuser Password

パスワードは暗号化されているため取得することはできませんが、サブユーザのパスワードをリセットすることができます。

URI引数 必須 条件 説明
user Yes 親アカウント配下に登録されているサブユーザ パスワードをリセットするサブユーザ
password Yes SendGrid password requirements参照 サブユーザの新しいパスワード
confirm_password Yes passwordパラメータと一致していること パスワードの確認
Parameter Value Requirements Description 
1

3492053713

Call

POST https://api.sendgrid.com/apiv2/customer.password.json
POST Data api_user=apikey&api_key=your_sendgrid_api_key&user=subuser_username&password=newPassword&confirm_password=newPassword

Response

1
2
3

{
  "message": "success"
}

Call

POST https://api.sendgrid.com/apiv2/customer.password.xml
POST Data api_user=apikey&api_key=your_sendgrid_api_key&user=subuser_username&password=newPassword&confirm_password=newPassword

Response

1
2
3

<result>
   <message>success</message>
</result>

Update Subuser Email Address

メールアドレスはサブユーザに対する連絡先アドレスで、ユーザに対してSendGridが連絡する際に使用されます。メールの送信者情報とは関連性はありません。

URI引数 必須 条件 説明
task Yes setEmailを指定します サブユーザのメールアドレスを変更することを意味します。
user Yes 親アカウント配下に登録されているサブユーザ メールアドレスを変更するサブユーザ
email Yes 適切なメール形式 新しいサブユーザの管理用メールアドレス
Parameter Value Requirements Description 
1

3254297074

Call

POST https://api.sendgrid.com/apiv2/customer.profile.json
POST Data api_user=apikey&api_key=your_sendgrid_api_key&task=setEmail&user=subuser_username&email=newsubuser_username

Response

1
2
3

{
  "message": "success"
}

Call

POST https://api.sendgrid.com/apiv2/customer.profile.xml
POST Data api_user=apikey&api_key=your_sendgrid_api_key&task=setEmail&user=subuser_username&email=newsubuser_username

Response

1
2
3

<result>
   <message>success</message>
</result>

Update Subuser Profile

サブユーザのプロファイル情報を編集します。

URI引数 必須 条件 説明
task Yes setを指定します サブユーザのプロファイル情報を編集します
user Yes 親アカウント配下に登録されているサブユーザ 編集対象のサブユーザ
first_name No サブユーザのファーストネーム 新しいサブユーザのファーストネーム
last_name No サブユーザのラストネーム 新しいサブユーザのラストネーム
address No サブユーザの住所 新しいサブユーザの住所
city No サブユーザの市 新しいサブユーザの市
state No サブユーザの州 新しいサブユーザの州
country No サブユーザの国 新しいサブユーザの国
zip No サブユーザの郵便番号 新しいサブユーザの郵便番号
phone No サブユーザの電話番号 新しいサブユーザの電話番号
website No サブユーザのWebサイト 新しいサブユーザのWebサイト
company No サブユーザの会社 新しいサブユーザの会社
Parameter Value Requirements Description 
1

7886776158

Call

POST https://api.sendgrid.com/apiv2/customer.profile.json
POST Data api_user=apikey&api_key=your_sendgrid_api_key&task=set&user=subuser_username&first_name=newFirstName&last_name=newLastName

Response

1
2
3

{
  "message": "success"
}

Call

POST https://api.sendgrid.com/apiv2/customer.profile.xml
POST Data api_user=apikey&api_key=your_sendgrid_api_key&task=set&user=subuser_username&first_name=newFirstName&last_name=newLastName

Response

1
2
3

<result>
   <message>success</message>
</result>

Disable a Subuser

サブユーザのactiveフラグを0に設定します。これにより、サブユーザがメール送信をできないように設定します。Webダッシュボードへのログインには影響を与えません。

URI引数 必須 条件 説明
user Yes 親アカウント配下に登録されているサブユーザ 無効化対象のサブユーザ
Parameter Value Requirements Description 
1

2670479085

Call

POST https://api.sendgrid.com/apiv2/customer.disable.json
POST Data api_user=apikey&api_key=your_sendgrid_api_key

Response

1
2
3

{
  "message": "success"
}

Call

POST https://api.sendgrid.com/apiv2/customer.disable.xml
POST Data api_user=apikey&api_key=your_sendgrid_api_key

Response

1
2
3

<result>
   <message>success</message>
</result>

Enable a Subuser

サブユーザのactiveフラグを1に設定します。これにより、サブユーザにメール送信を許可します。Webダッシュボードへのログインには影響を与えません。新規サブユーザの初期状態は有効状態です。

URI引数 必須 条件 説明
user Yes 親アカウント配下に登録されているサブユーザ 有効化対象のサブユーザ
Parameter Value Requirements Description 
1

1586933073

Call

POST https://api.sendgrid.com/apiv2/customer.enable.json
POST Data api_user=apikey&api_key=your_sendgrid_api_key&user=subuser_username

Response

1
2
3

{
  "message": "success"
}

Call

POST https://api.sendgrid.com/apiv2/customer.enable.xml
POST Data api_user=apikey&api_key=your_sendgrid_api_key&user=subuser_username

Response

1
2
3

<result>
   <message>success</message>
</result>

Disable Website Access To A Subuser

Webダッシュボードへのログインを拒否します。メール送信には影響を与えません。

URI引数 必須 条件 説明
user Yes 親アカウント配下に登録されているサブユーザ Webサイトへのアクセスを無効化する対象のサブユーザ
Parameter Value Requirements Description 
1

1559754071

Call

POST https://api.sendgrid.com/apiv2/customer.website_disable.json
POST Data api_user=apikey&api_key=your_sendgrid_api_key

Response

1
2
3

{
  "message": "success"
}

Call

POST https://api.sendgrid.com/apiv2/customer.website_disable.xml
POST Data api_user=apikey&api_key=your_sendgrid_api_key

Response

1
2
3

<result>
   <message>success</message>
</result>

Enable Website Access To A Subuser

Webダッシュボードへのログインを許可します。メール送信には影響を与えません。新規サブユーザの初期状態は有効状態です。

URI引数 必須 条件 説明
user Yes 親アカウント配下に登録されているサブユーザ Webサイトへのアクセスを有効化する対象のサブユーザ
Parameter Value Requirements Description 
1

3039115972

Call

POST https://api.sendgrid.com/apiv2/customer.website_enable.json
POST Data api_user=apikey&api_key=your_sendgrid_api_key&user=subuser_username

Response

1
2
3

{
  "message": "success"
}

Call

POST https://api.sendgrid.com/apiv2/customer.website_enable.xml
POST Data api_user=apikey&api_key=your_sendgrid_api_key&user=subuser_username

Response

1
2
3

<result>
   <message>success</message>
</result>