On this page

Update footer 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/footer

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 Footer mail settings.

The Footer setting will insert a custom footer at the bottom of your text and HTML email message bodies.

You can insert your HTML or plain text directly using this endpoint, or you can create the footer using the Mail Settings menu in 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

enabledbooleanOptional

Indicates if the Footer mail setting is currently enabled.

html_contentstringOptional

The custom HTML content of your email footer.

plain_contentstringOptional

The plain text content of your email footer.

Responses

200400401403404500

SchemaExample

Property nameTypeRequiredDescriptionChild properties

enabledboolean

Indicates if the Footer mail setting is currently enabled.

html_contentstring

The custom HTML content of your email footer.

plain_contentstring

The plain text content of your email footer.

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