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

Edit a transactional template version.



API Overview

api-overview page anchor

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


PATCH/v3/templates/{template_id}/versions/{version_id}

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

This endpoint allows you to edit the content of your template version.


Authentication

authentication page anchor
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.

Property nameTypeRequiredDescription
template_idstring<uuid>required

The ID of the original template


version_idstring<uuid>required

The ID of the template version

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.

200
SchemaExample
Property nameTypeRequiredDescriptionChild properties
warningsarray[object]

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.

Max length: 1048576

plain_contentstring

Plain text content of the Design.

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

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.

edit-a-transactional-template-version page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
curl

_30
const client = require('@sendgrid/client');
_30
client.setApiKey(process.env.SENDGRID_API_KEY);
_30
_30
const template_id = "f15982c1-a82c-4e87-a6b2-a4a63b4b7644";
_30
const version_id = "f15982c1-a82c-4e87-a6b2-a4a63b4b7644";
_30
const data = {
_30
"template_id": "Excepteur Ut qui",
_30
"active": 1,
_30
"name": "pariatur non incididunt commodo",
_30
"html_content": "dolor",
_30
"generate_plain_content": false,
_30
"subject": "aliquip nulla Ut",
_30
"editor": "design",
_30
"plain_content": "labore dolore"
_30
};
_30
_30
const request = {
_30
url: `/v3/templates/${template_id}/versions/${version_id}`,
_30
method: 'PATCH',
_30
body: data
_30
}
_30
_30
client.request(request)
_30
.then(([response, body]) => {
_30
console.log(response.statusCode);
_30
console.log(response.body);
_30
})
_30
.catch(error => {
_30
console.error(error);
_30
});


Rate this page: