On this page

Parse Settings

(warning)

This documentation is for the SendGrid Web API v2

We will deprecate this version on February 10, 2025. To access all the latest features and upcoming developments, please see our v3 API. For assistance with transitioning, refer to our migration guide.

(information)

Info

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

JSONXML

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

1{
2  "parse": [
3    {
4      "hostname": "parse.example1.com",
5      "url": "www.mydomain.com/parse.php",
6      "spam_check": 1
7    },
8    {
9      "hostname": "parse.example2.com",
10      "url": "www.mydomain.com/parse.php",
11      "spam_check": 0
12    }
13  ]
14}

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

JSONXML

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

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

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

JSONXML

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

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

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

JSONXML

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

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