The following Parse API settings allow you to manage the Inbound Parse Webhook.In addition to configuring the Inbound Parse via our API, you may also configure the Inbound Parse in the Settings menu available from your SendGrid dashboard. For more inforamtion, see our User Guide.

Get Parse Settings [GET]

Retrieves all of your current inbound parse settings.
URI Parameter Required Requirements Description
limit No number Number of settings to return.
Example: 20
offset No number Paging offset.
Example: 1

Request

1
GET https://api.sendgrid.com/v3/user/webhooks/parse/settings?limit={limit}&offset={offset} HTTP/1.1

Response

1
2
3
4
5
6
7
8
9
10
11
HTTP/1.1 200
{
  "result": [
    {
      "url": "http://mydomain.com/parse",
      "hostname": "mail.mydomain.com",
      "spam_check": true,
      "send_raw": true
    }
  ]
}

Create Parse Setting [POST]

Creates a new inbound parse setting.

Request

1
POST https://api.sendgrid.com/v3/user/webhooks/parse/settings HTTP/1.1
Request Body
1
2
3
4
5
6
{
  "hostname": "myhostname.com",
  "url": "http://email.myhosthame.com",
  "spam_check": true,
  "send_raw": false
}

Response

1
2
3
4
5
6
7
HTTP/1.1 201
{
  "url": "http://email.myhostname.com",
  "hostname": "myhostname.com",
  "spam_check": false,
  "send_raw": true
}

Get Parse Setting [GET]

Retrieves a specific inbound parse setting.

Request

1
GET https://api.sendgrid.com/v3/user/webhooks/parse/settings/{hostname} HTTP/1.1

Response

1
2
3
4
5
6
7
HTTP/1.1 200
{
  "url": "http://mydomain.com/parse",
  "hostname": "mail.mydomain.com",
  "spam_check": true,
  "send_raw": true
}

Update Parse Setting [PATCH]

Updates one of your current inbound parse settings.

Request

1
PATCH https://api.sendgrid.com/v3/user/webhooks/parse/settings/{hostname} HTTP/1.1
Request Body
1
2
3
4
5
{
  "url": "http://newdomain.com/parse",
  "spam_check": false,
  "send_raw": true
}

Response

1
2
3
4
5
6
7
HTTP/1.1 200
{
  "url": "http://mydomain.com/parse",
  "hostname": "mail.mydomain.com",
  "spam_check": true,
  "send_raw": true
}

Delete Parse Setting [DELETE]

Deletes one of your current inbound parse settings.

Request

1
DELETE https://api.sendgrid.com/v3/user/webhooks/parse/settings/{hostname} HTTP/1.1

Response

1
HTTP/1.1 204