On this page

Edit a transactional template.

API Overview

An HTML template that can establish a consistent design for transactional emails.

Each parent account, as well as each Subuser, can create up to 300 different transactional templates. Templates are specific to the parent account or Subuser, meaning templates created on a parent account will not be accessible from the parent's Subuser accounts.

Transactional templates are templates created specifically for transactional email and are not to be confused with Marketing Campaigns designs. For more information about transactional templates, please see our Dynamic Transactional Templates documentation.

Operation overview

PATCH/v3/templates/{template_id}

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 edit the name of a transactional template.

To edit the template itself, create a new transactional template version.

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.

Path parameters

Property nameTypeRequiredDescription

template_idstringrequired

Request body

Encoding type:application/json

SchemaExample

Property nameTypeRequiredDescriptionChild properties

namestringOptional

The name of the transactional template.

Max length: 100

Responses

200

SchemaExample

Property nameTypeRequiredDescriptionChild properties

idstring<uuid>

The ID of the transactional template.

Min length: 36Max length: 36

namestring

The name for the transactional template.

Max length: 100

generationenum<string>

Defines the generation of the template.

Possible values:

legacydynamic

updated_atstring

The date and time that this transactional template version was updated.

Pattern: ^(\d{4}-\d{2}-\d{2}) ((\d{2}):(\d{2}):(\d{2}))$

versionsarray[object]

The different versions of this transactional template.

Show child properties for versions

warningobject

Show child properties for warning

Edit a transactional template.

1const client = require('@sendgrid/client');
2client.setApiKey(process.env.SENDGRID_API_KEY);
3
4const template_id = "ZGkrHSypTsudrGkmdpJJ";
5const data = {
6  "name": "new_example_name"
7};
8
9const request = {
10  url: `/v3/templates/${template_id}`,
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  });