Menu

Expand

This documentation is for the SendGrid Web API v2

To access all the latest features and upcoming developments, please see our v3 API.

Parse Settings

Please refer to the Parse Documentation for documentation on Parse.

Get Current Settings

URI Parameter Required Requirements Description
task Yes Must be set to get Task to retrieve Parse records
user Yes Subuser must be under your account The subuser to retrieve records for

Call

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

Response

{
  "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=your_sendgrid_username&api_key=your_sendgrid_password&task=get&user=subuser_username

Response

<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 Parameter Required Requirements Description
task Yes Must be set to set Task to set Parse record
user Yes Subuser must be under your account The subuser setup parse on
hostname Yes Valid DNS entry Hostname to catch email from. Must have mx record
url Yes Valid POST URL The URL to POST the Parse data

Call

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

Response

{
  "message": "success"
}

Call

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

Response

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

Edit Entry

URI Parameter Required Requirements Description
task Yes Must be set to update Task to edit Parse record
user Yes Subuser must be under your account The subuser who owns the Parse record to update
hostname Yes No more than 255 characters Hostname entry you want to update
url Yes Valid POST URL The new URL to POST the Parse data

Call

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

Response

{
  "message": "success"
}

Call

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

Response

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

Delete Entry

URI Parameter Required Requirements Description
task Yes Must be set to delete Task to delete Parse record
user Yes Subuser must be under your account The subuser who owns the Parse record being removed.
hostname Yes Must be an existing hostname on the user The Parse record to remove

Call

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

Response

{
  "message": "success"
}

Call

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

Response

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

Need some help?

We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the SendGrid tag on Stack Overflow.