Update a theme

Update theme settings or title.

PUT/themes/{id}

Authorization

AuthorizationBearer token (JWT) · headerrequired

Path parameters

idstringrequired

Theme ID

Request body

requiredapplication/json

titlestring

settings_jsonstring

Raw JSON string of theme settings. Note: the request field is settings_json, not settings (the response field, returned as settings, is named differently from the request field).

parent_idstring

Reassigns the dev theme's parent (production) theme.

last_updated_onstring<date-time>

Optimistic-locking timestamp; rejects the update if the theme changed since.

Responses

200

Theme updated

_linksHalLinks

idstring

Opaque theme identifier

linkedboolean

Whether this is a linked (inherited) theme

parent_idstring | null

productionboolean

true for the live/public theme

publicboolean

Alias for production

accessibleboolean

titlestring

settingsstring

Raw JSON string of theme settings

created_onstring<date-time>

updated_onstring<date-time>

_embeddedobject

Show properties

templatesThemeTemplate[]

Show properties

Array of ThemeTemplate

_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>

assetsThemeAsset[]

Show properties

Array of ThemeAsset

_linksHalLinks

idstring

file_namestring

content_typestring

file_sizeinteger

digeststring

urlstring

CDN URL for this asset

updated_onstring<date-time>

401

Unauthorized

403

Access denied

404

Theme not found

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

idpath*Theme ID

Bodyapplication/json

titlestringsettings_jsonstringRaw JSON string of theme settings. Note: the request field is `settings_json`, not `settings` (the response field, returned as `settings`, is named differently from the request field). parent_idstringReassigns the dev theme's parent (production) theme.last_updated_onstringOptimistic-locking timestamp; rejects the update if the theme changed since.

Request

curl -s -X PUT \
  -H "Authorization: Bearer $BOLDER_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"title":"My Updated Theme"}' \
  "https://api.onbolder.com/v2/themes/abc123"

curl -X PUT 'https://api.onbolder.com/v2/themes/abc123' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "title": "Updated Theme Title",
  "settings_json": "{\"bg_color\":\"#333\"}"
}'

const response = await fetch("https://api.onbolder.com/v2/themes/abc123", {
  method: "PUT",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"title\": \"Updated Theme Title\",\n  \"settings_json\": \"{\\\"bg_color\\\":\\\"#333\\\"}\"\n}"
});

import requests

response = requests.put(
    "https://api.onbolder.com/v2/themes/abc123",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"title\": \"Updated Theme Title\",\n  \"settings_json\": \"{\\\"bg_color\\\":\\\"#333\\\"}\"\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",
  "linked": true,
  "parent_id": "string",
  "production": true,
  "public": true,
  "accessible": true,
  "title": "string",
  "settings": "string",
  "created_on": "2019-08-24T14:15:22Z",
  "updated_on": "2019-08-24T14:15:22Z",
  "_embedded": {
    "templates": [
      {
        "_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"
      }
    ],
    "assets": [
      {
        "_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": "logo.png",
        "content_type": "image/png",
        "file_size": 0,
        "digest": "string",
        "url": "string",
        "updated_on": "2019-08-24T14:15:22Z"
      }
    ]
  }
}