On this page

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

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 legacy email template settings.

This setting refers to our original email templates. We currently support more fully featured Dynamic Transactional Templates.

The legacy email template setting wraps an HTML template around your email content. This can be useful for sending out marketing email and/or other HTML formatted messages. For instructions on using legacy templates, see how to "Create and Edit Legacy Transactional Templates. For help migrating to our current template system, see "Migrating from Legacy Templates".

Operation details

Authentication

API Key

Headers

Property nameTypeRequiredDescription

Authorizationstringrequired

Default: Bearer <<YOUR_API_KEY_HERE>>

on-behalf-ofstring

Optional

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

enabledboolean

Optional

Indicates if you want to enable the legacy email template mail setting.

html_contentstring

Optional

The new HTML content for your legacy email template.

Responses

200400401403404500

SchemaExample

Property nameTypeRequiredDescriptionChild properties

enabledboolean

Indicates if the legacy email template mail setting is enabled.

html_contentstring

The HTML content of your legacy email template.

Update template mail settings

1const client = require("@sendgrid/client");
2client.setApiKey(process.env.SENDGRID_API_KEY);
3
4const data = {
5  enabled: true,
6  html_content: "<% body %>",
7};
8
9const request = {
10  url: `/v3/mail_settings/template`,
11  method: "PATCH",
12  body: data,
13};
14
15client
16  .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  });