Parse Settings

Retrieve, add, edit, and delete your customers' parse settings.

Get Current Settings

URI Parameter	Required	Requirements	Description
task	Yes	Must be set to `get`	Retrieve Parse settings
user	Yes	Customer must be registered under your account	The customer who we will update
method	Yes	Must be set to `parse`	Allows you to access parse functionality

These are Reseller only APIs. For more information, see Reseller Overview.

Call

POST	`https://api.sendgrid.com/apiv2/reseller.manage.json`
POST Data	`api_user=your_sendgrid_username&api_key=your_sendgrid_password&method=parse&task=get&method=parse&user=eexampexample@example.com`

Response

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

Call

POST	`https://api.sendgrid.com/apiv2/reseller.manage.xml`
POST Data	`api_user=your_sendgrid_username&api_key=your_sendgrid_password&method=parse&task=get&method=parse&user=eexampexample@example.com`

Response

<parse>
   <entry>
      <hostname>www.example.com</hostname>
      <url>www.mydomain.com/parse.php</url>
      <spam_check>1</spam_check>
   </entry>
</parse>

Create New Entry

URI Parameter	Required	Requirements	Description
task	Yes	Must be set to `set`	Set Parse settings
hostname	Yes	No more than 255 characters	Hostname we will use with your email
url	Yes		The parse destination
user	Yes	Customer must be registered under your account	The customer who we will update
method	Yes	Must be set to `parse`	Allows you to access parse functionality

Call

POST	`https://api.sendgrid.com/apiv2/reseller.manage.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&method=parse&task=set&method=parse&user=eexampexample@example.com`

Response

{
  "message": "success"
}

Call

POST	`https://api.sendgrid.com/apiv2/reseller.manage.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&method=parse&task=set&method=parse&user=eexampexample@example.com`

Response

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

Edit Entry

URI Parameter	Required	Requirements	Description
task	Yes	Must be set to `update`	Set Parse settings
hostname	Yes	No more than 255 characters	Hostname entry you want to update
url	Yes		The parse destination
user	Yes	Customer must be registered under your account	The customer who we will update
method	Yes	Must be set to `parse`	Allows you to access parse functionality

Call

POST	`https://api.sendgrid.com/apiv2/reseller.manage.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&method=parse&task=update&user=eexampexample@example.com`

Response

{
  "message": "success"
}

Call

POST	`https://api.sendgrid.com/apiv2/reseller.manage.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&method=parse&task=update&user=eexampexample@example.com`

Response

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

Delete Entry

URI Parameter	Required	Requirements	Description
task	Yes	Must be set to `delete`	Set Parse settings
user	Yes	Customer must be registered under your account	The customer who we will update
hostname	Yes	Must be the hostname you wish to delete	The host name you will remove for your customer
method	Yes	Must be set to `parse`	Allows you to access parse functionality

Call

POST	`https://api.sendgrid.com/apiv2/reseller.manage.json`
POST Data	`api_user=your_sendgrid_username&api_key=your_sendgrid_password&hostname=www.example.com&task=delete&method=parse&user=eexampexample@example.com`

Response

{
  "message": "success"
}

Call

POST	`https://api.sendgrid.com/apiv2/reseller.manage.xml`
POST Data	`api_user=your_sendgrid_username&api_key=your_sendgrid_password&hostname=www.example.com&task=delete&method=parse&user=eexampexample@example.com`

Response

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

Rate this page:

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.

This documentation is for the SendGrid Web API v2

Need some help?

Thank you for your feedback!

Thanks for your feedback!

Step 1

Step 2

Step 3