provider Settings - Inbound Parse PATCH /user/webhooks/parse/settings/{hostname}
@utdk/sendgrid /user/webhooks/parse/settings/{hostname}
Update a parse setting
**This endpoint allows you to update 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.
hostname path required
The hostname associated with the inbound parse setting that you would like to retrieve.
string
on-behalf-of header
string

Try it

Authentication
Configure credentials for Email Activity (beta)
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

patchUserWebhooksParseSettingsHostname
PATCH/user/webhooks/parse/settings/{hostname}
**This endpoint allows you to update 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.

Parameters

required

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

Input

A specific and unique domain or subdomain that you have created to use exclusively to parse your incoming email. For example, `parse.yourdomain.com`.

Indicates if you would like SendGrid to post the original MIME-type content of your parsed email. When this parameter is set to `true`, SendGrid will send a JSON payload of the content of your email.

Indicates if you would like SendGrid to check the content parsed from your emails for spam before POSTing them to your domain.

The public URL where you would like SendGrid to POST the data parsed from your email. Any emails sent with the given hostname provided (whose MX records have been updated to point to SendGrid) will be parsed and POSTed to this URL.

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import sendgrid from '@utdk/sendgrid';

await sendgrid.patchUserWebhooksParseSettingsHostname({
  "on-behalf-of": "The subuser's username. This header generates the API call as if the subuser account was making the call."
})