Create a template

Creates a new template file inside the theme. The file_name determines the template type (e.g. layout.html, product.html, custom.css).

POST/themes/{theme_id}/templates

Authorization

AuthorizationBearer token (JWT) · headerrequired

Path parameters

theme_idstringrequired

Theme ID

Request body

requiredapplication/json

file_namestringrequired

Template filename (determines type)

bodystring

Template source code

Responses

201

Template created

_linksHalLinks

idstring

file_namestring

pathstring

bodystring

Full template source code

is_sectionboolean

schemaobject

Present only when is_section is true — the section's configurable schema.

parent_commitstring | null

updated_onstring<date-time>

401

Unauthorized

403

Access denied

422

Validation error

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (JWT)Remember on this deviceInclude my values in samples

Parameters

theme_idpath*Theme ID

Bodyapplication/json

file_namestring*Template filename (determines type)bodystringTemplate source code

Request

curl -X POST 'https://api.onbolder.com/v2/themes/abc123/templates' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "file_name": "collection.html",
  "body": "<h1>{{ collection.name }}</h1>"
}'

const response = await fetch("https://api.onbolder.com/v2/themes/abc123/templates", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"file_name\": \"collection.html\",\n  \"body\": \"<h1>{{ collection.name }}</h1>\"\n}"
});

import requests

response = requests.post(
    "https://api.onbolder.com/v2/themes/abc123/templates",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"file_name\": \"collection.html\",\n  \"body\": \"<h1>{{ collection.name }}</h1>\"\n}",
)

Response

{
  "_links": {
    "property1": {
      "href": "string",
      "templated": true,
      "method": "get",
      "title": "string",
      "type": "string"
    },
    "property2": {
      "href": "string",
      "templated": true,
      "method": "get",
      "title": "string",
      "type": "string"
    }
  },
  "id": "string",
  "file_name": "layout.html",
  "path": "string",
  "body": "string",
  "is_section": true,
  "schema": {},
  "parent_commit": "string",
  "updated_on": "2019-08-24T14:15:22Z"
}