On this page

Edit a transactional template version.

API Overview

Represents the code for a particular transactional template. Each transactional template can have multiple versions, each version with its own subject and content. Each user can have up to 300 versions across all templates.

For more information about transactional templates, please see our Transactional Templates documentation. You can also manage your Transactional Templates in the Dynamic Templates section of the Twilio SendGrid App.

Operation overview

PATCH/v3/templates/{template_id}/versions/{version_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 content of your 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_idstring<uuid>required

The ID of the original template

version_idstring<uuid>required

The ID of the template version

Request body

Encoding type:application/json

SchemaExample

Property nameTypeRequiredDescriptionChild properties

activeenum<integer>Optional

Set the version as the active version associated with the template (0 is inactive, 1 is active). Only one version of a template can be active. The first version created for a template will automatically be set to Active.

Possible values:

01

namestringrequired

Name of the transactional template version.

Max length: 100

html_contentstringOptional

The HTML content of the version. Maximum of 1048576 bytes allowed.

Max length: 1048576

plain_contentstringOptional

Text/plain content of the transactional template version. Maximum of 1048576 bytes allowed.

Max length: 1048576Default: <generated from html_content if left empty>

generate_plain_contentbooleanOptional

If true, plain_content is always generated from html_content. If false, plain_content is not altered.

Default: true

subjectstringrequired

Subject of the new transactional template version.

Max length: 255

editorenum<string>Optional

The editor used in the UI.

Possible values:

codedesign

test_datastringOptional

For dynamic templates only, the mock json data that will be used for template preview and test sends.

Responses

200

SchemaExample

Property nameTypeRequiredDescriptionChild properties

warningsarray[object]

Show child properties for warnings

activeenum<integer>

Set the version as the active version associated with the template. Only one version of a template can be active. The first version created for a template will automatically be set to Active.

Possible values:

01

namestring

Name of the transactional template version.

Max length: 100

html_contentstring

The HTML content of the Design.

plain_contentstring

Plain text content of the Design.

generate_plain_contentboolean

If true, plain_content is always generated from html_content. If false, plain_content is not altered.

Default: true

subjectstring

Subject of the new transactional template version.

Max length: 255

editorenum<string>

The editor used in the UI.

Possible values:

codedesign

test_datastring

For dynamic templates only, the mock json data that will be used for template preview and test sends.

idstring<uuid>

ID of the transactional template version.

template_idstring

ID of the transactional template.

updated_atstring

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

thumbnail_urlstring

A Thumbnail preview of the template's html content.

Edit a transactional template version.

1const client = require("@sendgrid/client");
2client.setApiKey(process.env.SENDGRID_API_KEY);
3
4const template_id = "f15982c1-a82c-4e87-a6b2-a4a63b4b7644";
5const version_id = "f15982c1-a82c-4e87-a6b2-a4a63b4b7644";
6const data = {
7  template_id: "Excepteur Ut qui",
8  active: 1,
9  name: "pariatur non incididunt commodo",
10  html_content: "dolor",
11  generate_plain_content: false,
12  subject: "aliquip nulla Ut",
13  editor: "design",
14  plain_content: "labore dolore",
15};
16
17const request = {
18  url: `/v3/templates/${template_id}/versions/${version_id}`,
19  method: "PATCH",
20  body: data,
21};
22
23client
24  .request(request)
25  .then(([response, body]) => {
26    console.log(response.statusCode);
27    console.log(response.body);
28  })
29  .catch((error) => {
30    console.error(error);
31  });