Monitor Records

Monitor Recordsはサブユーザが送信するメールのサンプルを指定した頻度で送信します。

最初のステップはモニターレコードを作成することです。モニターレコードを作成後、親アカウントはサブユーザに対してモニターレコードを適用することができます。一つのモニターレコードに複数のサブユーザを適用することができます。

Create Monitor Record

モニターレコードを作成します。

URI引数 必須 条件 説明
task Yes createを指定します モニターレコードを作成します
name Yes ユニークな名前を指定します。255文字以内。 モニターレコードを識別するユニークな名前
email Yes メール形式 メールのサンプルを送信する宛先メールアドレス
frequency Yes 正の整数 サンプルメールを送信する頻度
Parameter Value Requirements Description

Call

POST https://api.sendgrid.com/apiv2/customer.monitor.json
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&task=create&name=myMonitor&email=example@example.com&frequency=1000

Response

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

Call

POST https://api.sendgrid.com/apiv2/customer.monitor.xml
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&task=create&name=myMonitor&email=example@example.com&frequency=1000

Response

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

Edit Monitor Record

作成済みのモニターレコードを編集します。

URI引数 必須 条件 説明
task Yes editを指定します モニターレコードを編集します
name Yes 編集するモニターレコードの名前 編集するモニターレコードの名前
new_name No ユニークな名前を指定します。255文字以内。 新しいモニターレコードの名前
new_email No メール形式 メールのサンプルを送信する新しい宛先
new_frequency No 正の整数 サンプルメールを送信する頻度
Parameter Value Requirements Description

Call

POST https://api.sendgrid.com/apiv2/customer.monitor.json
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&task=edit&name=myMonitor&new_name=updatedMonitor&new_email=example@example.com&new_frequency=100

Response

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

Call

POST https://api.sendgrid.com/apiv2/customer.monitor.xml
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&task=edit&name=myMonitor&new_name=updatedMonitor&new_email=example@example.com&new_frequency=100

Response

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

Delete Monitor Record

SendGridのシステムからモニターレコードを削除します。どのユーザにも割り当てられていない場合のみ削除することができます。

URI引数 必須 条件 説明
task Yes deleteを指定します モニターレコードを削除します
name Yes 削除するモニターレコードの名前 削除するモニターレコードの名前
Parameter Value Requirements Description

Call

POST https://api.sendgrid.com/apiv2/customer.monitor.json
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&task=delete&name=recordToDelete

Response

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

Call

POST https://api.sendgrid.com/apiv2/customer.monitor.xml
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&task=delete&name=recordToDelete

Response

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

List All Monitor Records

親アカウントに作成済みの全てのモニターレコードの一覧を取得します。

URI引数 必須 条件 説明
task Yes listを指定します 全てのモニターレコードの一覧を取得します
Parameter Value Requirements Description

Call

POST https://api.sendgrid.com/apiv2/customer.monitor.json
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&task=list

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
[
  {
    "name": "sampleNameA",
    "email": "example@example.com",
    "frequency": "1000",
    "users": [

    ]
  },
  {
    "name": "sampleNameB",
    "email": "example@example.com",
    "frequency": "10000",
    "users": [
      "user1@example.com",
      "user2@example.com"
    ]
  }
]

Call

POST https://api.sendgrid.com/apiv2/customer.monitor.xml
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&task=list

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
<monitors>
   <monitor>
      <name>sampleNameA</name>
      <email>example@example.com</email>
      <frequency>1000</frequency>
      <users/>
   </monitor>
   <monitor>
      <name>sampleNameB</name>
      <email>example@example.com</email>
      <frequency>10000</frequency>
      <users>
         <user>user1@example.com</user>
         <user>user2@example.com</user>
      </users>
   </monitor>
</monitors>

Append a Subuser to a Monitor Record

作成済みのモニターレコードをサブユーザに割り当てます。

URI引数 必須 条件 説明
task Yes appendを指定します サブユーザにモニターレコードを割り当てます
user Yes 親アカウント配下に登録されているサブユーザ モニターレコードを割り当てるサブユーザ
name Yes 作成済みのモニターレコード 割り当てるモニターレコードの名前
Parameter Value Requirements Description

Call

POST https://api.sendgrid.com/apiv2/customer.monitor.json
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&task=append&name=myMonitor&user=example@example.com

Response

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

Call

POST https://api.sendgrid.com/apiv2/customer.monitor.xml
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&task=append&name=myMonitor&user=example@example.com

Response

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

Detach A Monitor Record From A Subuser

サブユーザからモニターレコードの割り当てを解除します。

URI引数 必須 条件 説明
task Yes detachを指定します サブユーザからモニターレコードの割り当て解除します
user Yes 親アカウント配下に登録されているサブユーザ モニターレコードを割り当て解除するサブユーザ
name No 作成済みのモニターレコード 割り当て解除するモニターレコードの名前。無指定の場合、全てのモニターレコードが割り当て解除されます。
Parameter Value Requirements Description

Call

POST https://api.sendgrid.com/apiv2/customer.monitor.json
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&task=detach&user=example@example.com

Response

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

Call

POST https://api.sendgrid.com/apiv2/customer.monitor.xml
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&task=detach&user=example@example.com

Response

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