Skip to main content
POST
Try a template with this site’s content without saving a design
Pass a preset from the site’s theme gallery. The response contains the template files, an empty version history and template_preview: true. Use the returned design and revision IDs to get a private preview link. A teammate with Help Center read access can review it for 24 hours. The first successful update saves a draft. An empty files map keeps the template as it appears. Saving or publishing requires Help Center write access. Update draft files

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Body

application/json
preset
enum<string>
required
Available options:
default,
search-first,
documentation,
multi-product,
atlas,
original

Response

Default Response

id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
name
string
required
preset
enum<string>
required
Available options:
default,
search-first,
documentation,
multi-product,
atlas,
original
revision_id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
help_center_id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
languages
string[]
required

Languages this site serves, primary first.

Minimum array length: 1
files
object
required
history
object[]
required
template_preview
boolean

True while this is an unsaved template preview.

history_page
object
selected_revision
object