Create a template

POST /v3/templates

Creates a template.

At a minimum, you must provide the following required attributes in the request body:

Attribute	Type	Description	Example(s)
`name`	string	The name of the template.	`"Alert bar template"`
`friendlyId`	string	The unique ID of the template. Only lowercase alphanumeric characters and underscores are allowed.	`"alert_bar_template_1"`
`type`	string enum (uppercase)	The type of the template.	Must be one of: `"WEB"` `"DECISION"` `"CONDITION"` `"JS_MODULE"`
`status`	string enum (uppercase)	The current status of the template.	Must be one of: `"DRAFT"` `"PUBLISHED"`
`description`	string	The description of the connection.	`"Alert bar web template"`
`render`	boolean	Determines whether to render a preview of the web template in the Sitecore Personalize app. Only set this to `true` if you're confident that your web template can render. Do not set this to `true` for more sophisticated web templates that use handlebars loops.	`true, false`
`defaultTemplate`	boolean	Determines whether this is a default template. When you create a template, you must set this value to `false`.	`false`
`customTemplate`	boolean	Determines whether this is a custom template. When you create a template, you must set this value to `true`.	`true`
`templateElements` optional	JSON array of JSON objects	Custom HTML, CSS, JavaScript, and FreeMarker codes that define the template.	`"mys3cr3tstr1ingforauth1!x"`

The optional templateElements array of objects lets you include HTML, CSS, JavaScript, and FreeMarker codes in your templates. For the objects in templateElements, use the following attributes:

Attribute	Type	Description	Example(s)
`id`	string enum (lowercase)	The type of code that you include in the `template` attribute. For example, to include CSS code in the template, set this value to `"css"`, then specify the custom CSS code in the `template` attribute.	Must be one of: `"html"` `"css"` `"js"` `"freemarker"`
`template`	string	Stringified HTML, CSS, JavaScript, or FreeMarker code. For FreeMarker code, you must at a minimum include an opening and a closing curly bracket `{}`.	HTML: `"<div id=\"test\">My test div</div>"` CSS: `"#test {text-transform: uppercase}"` JavaScript: `"insertHTMLBefore(\"body\");"` FreeMarker: `"{}"`

Attribute

Type

Description

Example(s)

id

string enum (lowercase)

The type of code that you include in the template attribute.

For example, to include CSS code in the template, set this value to "css", then specify the custom CSS code in the template attribute.

Must be one of:

"html"
"css"
"js"
"freemarker"

template

string

Stringified HTML, CSS, JavaScript, or FreeMarker code.

For FreeMarker code, you must at a minimum include an opening and a closing curly bracket {}.

HTML: "<div id=\"test\">My test div</div>"
CSS: "#test {text-transform: uppercase}"
JavaScript: "insertHTMLBefore(\"body\");"
FreeMarker: "{}"

Here's an example of the templateElements array of objects:

"templateElements": [
  {
    "id": "html",
    "template": "<div id=\"test\">My test div</div>"
  },
  {
    "id": "css",
    "template": "#test {text-transform: uppercase}"
  },
  {
    "id": "js",
    "template": "insertHTMLBefore(\"body\");\n\nconst testDiv = document.querySelector(\"#test\");\ntestDiv.insertAdjacentHTML(\"afterbegin\", \"<p>Hello from JavaScript</p>\")"
  },
  {
    "id": "freemarker",
    "template": "{}"
  }
]

In the response, the ref key contains the template reference.

You use the template reference to interact with a specific template, for example, to retrieve or update it.

curl -X POST '<baseURL>/v3/templates' \
-H 'Authorization: Bearer <accessToken>' \
-H 'Accept: application/json' \
--data-raw '
{
    "name": "Alert bar template",
    "friendlyId": "alert_bar_template_1",
    "type": "WEB",
    "status": "DRAFT",
    "description": "Alert bar template WEB",
    "render": false,
    "defaultTemplate": false,
    "customTemplate": true,
    "templateElements": [
    {
        "id": "html",
        "template": "<div id=\"test\">My test div</div>"
    },
    {
        "id": "css",
        "template": "#test {text-transform: uppercase}"
    },
    {
        "id": "js",
        "template": "insertHTMLBefore(\"body\");\n\nconst testDiv = document.querySelector(\"#test\");\ntestDiv.insertAdjacentHTML(\"afterbegin\", \"<p>Hello from JavaScript</p>\")"
    },
    {
        "id": "freemarker",
        "template": "{}"
    }
    ]
}'

{
    "clientKey": "pqsPERS3lw12v5a9rrHPW1c4hET73GxQ",
    "href": "<baseURL>/v3/templates/340ced1b-c9b7-43f0-9eec-2b9f0b7693fa",
    "ref": "340ced1b-c9b7-43f0-9eec-2b9f0b7693fa",
    "name": "Alert bar template",
    "description": "Alert bar template WEB",
    "modifiedByRef": "zwxCA58jwLzfeU2mNGgalCpoJzNVYOJl@clients",
    "modifiedAt": "2025-07-12T10:56:46.53994Z",
    "revision": 1,
    "archived": false,
    "friendlyId": "alert_bar_template_1",
    "type": "WEB",
    "status": "DRAFT",
    "templateElements": [
        {
            "id": "html",
            "template": "<div id=\"test\">My test div</div>"
        },
        {
            "id": "css",
            "template": "#test {text-transform: uppercase}"
        },
        {
            "id": "js",
            "template": "insertHTMLBefore(\"body\");\n\nconst testDiv = document.querySelector(\"#test\");\ntestDiv.insertAdjacentHTML(\"afterbegin\", \"<p>Hello from JavaScript</p>\")"
        },
        {
            "id": "freemarker",
            "template": "{}"
        }
    ],
    "render": false,
    "defaultTemplate": false,
    "tags": [],
    "customTemplate": true
}

If you have suggestions for improving this article, let us know!