Skip to contentSkip to navigationSkip to topbar
Twilio SendGrid Docs
On this page

Delete a parse setting

API Overview

api-overview page anchor

Twilio SendGrid's Inbound Parse Webhook allows you to receive emails as multipart/form-data at a URL of your choosing. SendGrid will grab the content, attachments, and the headers from any email it receives for your specified hostname.

See "Setting up the Inbound Parse Webhook" for help configuring the Webhook. You can also manage the Inbound Parse Webhook in the Twilio SendGrid App(link takes you to an external page).

To begin processing email using SendGrid's Inbound Parse Webhook, you will have to setup MX Records, choose the hostname (or receiving domain) that will be receiving the emails you want to parse, and define the URL where you want to POST your parsed emails. If you do not have access to your domain's DNS records, you must work with someone in your organization who does.

Operation overview

operation-overview page anchor

DELETE/v3/user/webhooks/parse/settings/{hostname}

Base url: https://api.sendgrid.com (for global users and subusers)

Base url: https://api.eu.sendgrid.com (for EU regional subusers)

This endpoint allows you to delete a specific inbound parse setting by hostname.

You can retrieve all your Inbound Parse settings and their associated host names with the "Retrieve all parse settings" endpoint.

Operation details

operation-details page anchor

Authentication

authentication page anchor

Headers

headers page anchor
Property nameTypeRequiredDescription
Authorizationstringrequired
Default: Bearer <<YOUR_API_KEY_HERE>>
on-behalf-ofstringOptional

The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.

Path parameters

path-parameters page anchor
Property nameTypeRequiredDescription
hostnamestringrequired

The hostname associated with the inbound parse setting that you would like to retrieve.

Responses

responses page anchor
204401403404500
Schema
Property nameTypeRequiredDescriptionChild properties

No properties defined

Delete a parse settingLink to code sample: Delete a parse setting
1
const client = require('@sendgrid/client');

2
client.setApiKey(process.env.SENDGRID_API_KEY);

3


4
const hostname = "lt-38.hamilton-robinson.org";

5


6
const request = {

7
  url: `/v3/user/webhooks/parse/settings/${hostname}`,

8
  method: 'DELETE',

9
  

10
}

11


12
client.request(request)

13
  .then(([response, body]) => {

14
    console.log(response.statusCode);

15
    console.log(response.body);

16
  })

17
  .catch(error => {

18
    console.error(error);

19
  });