On this page

Update forward bounce mail settings

API Overview

Mail Settings instruct SendGrid to apply specific settings to every email that you send over SendGrid's v3 API or SMTP Relay. These settings include how to embed a custom footer, how to manage blocks, spam, and bounces, and more.

For a full list of Twilio SendGrid's Mail Settings, and what each one does, see our Mail Settings documentation.

You can also manage your Mail Settings in the Twilio SendGrid App

Operation overview

PATCH/v3/mail_settings/forward_bounce

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 update your current bounce forwarding mail settings.

Enabling the Forward Bounce setting allows you to specify an email address to which bounce reports will be forwarded.

You can also configure the Forward Spam mail settings in the Mail Settings section of the Twilio SendGrid App.

Operation details

Authentication

API Key

Headers

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.

Request body

Encoding type:application/json

SchemaExample

Property nameTypeRequiredDescriptionChild properties

emailstring or nullOptional

The email address that you would like your bounce reports forwarded to.

enabledbooleanOptional

Indicates if the bounce forwarding mail setting is enabled.

Responses

200400401403404500

SchemaExample

Property nameTypeRequiredDescriptionChild properties

emailstring or null

The email address that you would like your bounce reports forwarded to.

enabledboolean

Indicates if the bounce forwarding mail setting is enabled.

Update forward bounce mail settings

1const client = require('@sendgrid/client');
2client.setApiKey(process.env.SENDGRID_API_KEY);
3
4const data = {
5  "email": "john_doe@example.com",
6  "enabled": false
7};
8
9const request = {
10  url: `/v3/mail_settings/forward_bounce`,
11  method: 'PATCH',
12  body: data
13}
14
15client.request(request)
16  .then(([response, body]) => {
17    console.log(response.statusCode);
18    console.log(response.body);
19  })
20  .catch(error => {
21    console.error(error);
22  });