Parse Settings

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

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

Parse WebhookについてはInbound Parse Webhookを参照してください。

Get Current Settings

URI引数 必須 条件 説明
task Yes getを指定します Parse設定を取得します
user Yes 親アカウント配下に登録されているサブユーザ 設定を取得するサブユーザ
Parameter Value Requirements Description 
1

2057656631

Call

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

Response

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

{
  "parse": [
    {
      "hostname": "parse.example1.com",
      "url": "www.mydomain.com/parse.php",
      "spam_check": 1
    },
    {
      "hostname": "parse.example2.com",
      "url": "www.mydomain.com/parse.php",
      "spam_check": 0
    }
  ]
}

Call

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

Response

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

<parse>
   <entry>
      <hostname>parse.example1.com</hostname>
      <url>www.mydomain.com/parse.php</url>
      <spam_check>1</spam_check>
   </entry>
   <entry>
      <hostname>parse.example2.com</hostname>
      <url>www.mydomain.com/parse.php</url>
      <spam_check>0</spam_check>
   </entry>
</parse>

Create New Entry

URI引数 必須 条件 説明
task Yes setを指定します Parse設定を行います
user Yes 親アカウント配下に登録されているサブユーザ 更新対象のサブユーザ
hostname Yes 255文字以内 メールを受信するドメイン名。MXレコードが設定されている必要があります。
url Yes 適切なPOST先URL パース後のPOST先URL
Parameter Value Requirements Description 
1

387227150

Call

POST https://api.sendgrid.com/apiv2/customer.parse.json
POST Data api_user=apikey&api_key=your_sendgrid_api_key&hostname=www.example.com&url=www.mydomain.com/parse.php&spam_check=1&task=set&user=subuser_username

Response

1
2
3

{
  "message": "success"
}

Call

POST https://api.sendgrid.com/apiv2/customer.parse.xml
POST Data api_user=apikey&api_key=your_sendgrid_api_key&hostname=www.example.com&url=www.mydomain.com/parse.php&spam_check=1&task=set&user=subuser_username

Response

1
2
3

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

Edit Entry

URI引数 必須 条件 説明
task Yes updateを指定します Parse設定の編集を行います
user Yes 親アカウント配下に登録されているサブユーザ 更新対象のサブユーザ
hostname Yes 255文字以内 更新対象のホスト名
url Yes 適切なPOST先URL パース後のPOST先URL
Parameter Value Requirements Description 
1

9786593167

Call

POST https://api.sendgrid.com/apiv2/customer.parse.json
POST Data api_user=apikey&api_key=your_sendgrid_api_key&hostname=www.example.com&url=www.mydomain.com/parse.php&spam_check=1&task=update&user=subuser_username

Response

1
2
3

{
  "message": "success"
}

Call

POST https://api.sendgrid.com/apiv2/customer.parse.xml
POST Data api_user=apikey&api_key=your_sendgrid_api_key&hostname=www.example.com&url=www.mydomain.com/parse.php&spam_check=1&task=update&user=subuser_username

Response

1
2
3

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

Delete Entry

URI引数 必須 条件 説明
task Yes deleteを指定します Parse設定を行います
user Yes 親アカウント配下に登録されているサブユーザ 削除対象のサブユーザ
hostname Yes 作成済みのホスト名 削除対象のホスト名
Parameter Value Requirements Description 
1

5237414779

Call

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

Response

1
2
3

{
  "message": "success"
}

Call

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

Response

1
2
3

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