Skip to contentSkip to navigationSkip to topbar
Rate this page:
On this page

Update footer mail settings



API Overview

api-overview page anchor

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(link takes you to an external page)


PATCH/v3/mail_settings/footer

Base url: https://api.sendgrid.com

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(link takes you to an external page).


Authentication

authentication page anchor
Authorizationstringrequired
Default: Bearer <<YOUR_API_KEY_HERE>>

on-behalf-ofstring

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.

SchemaExample
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.

200400401403404500
SchemaExample
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.

update-footer-mail-settings page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
curl

_23
const client = require('@sendgrid/client');
_23
client.setApiKey(process.env.SENDGRID_API_KEY);
_23
_23
const data = {
_23
"enabled": true,
_23
"html_content": "Example HTML content",
_23
"plain_content": "Example plain content"
_23
};
_23
_23
const request = {
_23
url: `/v3/mail_settings/footer`,
_23
method: 'PATCH',
_23
body: data
_23
}
_23
_23
client.request(request)
_23
.then(([response, body]) => {
_23
console.log(response.statusCode);
_23
console.log(response.body);
_23
})
_23
.catch(error => {
_23
console.error(error);
_23
});


Rate this page: