Skip to main content
PATCH
Update the settings

Authorizations

Authorization
string
header
required

A secret key from Print.App admin → Domains → Secret keys, sent as Authorization: Bearer sk_…. Server-side only.

Body

application/json

The settings to change. Only the ones you send change. Product page changes reach the store within a few minutes.

skipPreview
boolean

The Submit button skips the preview step.

expandThumbNav
boolean

Page thumbnails instead of arrows to move between pages.

showTabTitle
boolean

Labels on the editor's tabs.

enableSaveLater
boolean

Customers can save a design and finish it later. On here, it is on for every design.

defaultLayout
enum<string>

Classic editor only: the sidebar on the left ("") or the right (default-right).

Available options:
,
default-right
layout
enum<string>

New editor only: the layout customers get. "" default, default-right sidebar on the right, product product designer, steps one step at a time, approve view and approve. Designs can override it in the editor.

Available options:
,
default-right,
product,
steps,
approve
displayMode
enum<string>

How the editor opens on the product page: modal full window, dialog a dialog, inline inside the page at inlineSelector, mini beside the product images at miniSelector.

Available options:
modal,
dialog,
inline,
mini
showGraphicsTitle
boolean

Show the titles of graphics that have one.

graphicsSearchCustomers
boolean

A search box in the Graphics panel for customers, on every design.

graphicsSearchScope
enum<string>

What the graphics search covers: store the print.app store, mine your own graphics, both.

Available options:
store,
mine,
both
enableColorProofing
boolean

A colour proof (ICC soft proof) when customers preview their designs, on every design.

bleedLineColor
string<color>

Colour of the bleed line on the canvas.

marginLineColor
string<color>

Colour of the safe margin line on the canvas.

trimLineColor
string<color>

Colour of the trim line on the canvas.

foldLineColor
string<color>

Colour of fold lines on the canvas.

borderColor
string<color>

Colour of the border around a selected item.

decimalPointTextSize
boolean

Font sizes with decimals (10.5 pt).

autoPlaceNewText
boolean

New text goes straight onto the canvas, without clicking the canvas first.

autoTextSize
boolean

Size new text to fit the screen.

newTextSize
integer

Size of new text, when it is not sized to fit.

Required range: 10 <= x <= 100
defaultTextType
enum<string>

What new text is: Textbox wrapping text box, IText a text area.

Available options:
IText,
Textbox
defaultNewTextString
string

Content of a new body text item.

Maximum string length: 500
defaultNewHeadingString
string

Content of a new heading.

Maximum string length: 200
hoverShow
boolean

Highlight the item under the mouse.

enableSnapping
boolean

Snap items while dragging them.

snapRange
integer

How close, in pixels, an item snaps.

Required range: 3 <= x <= 20
gridLinesInterval
integer

Gap between grid lines.

Required range: 5 <= x <= 100
bleedLineMessage
string

Label on the bleed line.

Maximum string length: 100
marginLineMessage
string

Label on the safe margin line.

Maximum string length: 100
trimLineMessage
string

Label on the trim line.

Maximum string length: 100
retainProductImages
boolean

Keep the product photos: the customer's design does not replace them after saving.

forceCustomization
boolean

Customers must customize before they can add the product to the cart.

disableCustomization
boolean

Hide the Customize button on every product page, so no one can customize. Only for a store that sells without the editor for a while.

customPreviewSelector
string

CSS selector for the product images the design previews replace, when the theme's differ from what Print.App looks for.

Maximum string length: 500
cartButtonSelector
string

CSS selector for the add-to-cart button, when the theme's differs from what Print.App looks for.

Maximum string length: 500
customVariantSelector
string

CSS selector for the field holding the chosen variant's id, when the theme's differs.

Maximum string length: 500
inlineSelector
string

CSS selector for where the editor sits with displayMode inline.

Maximum string length: 500
miniSelector
string

CSS selector for where the editor sits with displayMode mini.

Maximum string length: 500
moveButtonsBefore
string

CSS selector: the Customize button goes just before this element.

Maximum string length: 500
buttonsClass
string

CSS classes for the Customize button, to match the theme's buttons (default button).

Maximum string length: 200
observeFormRerenders
boolean

Remount the editor when the product form changes, for themes that redraw it.

collectionButtons
boolean

Shopify: a Customize button on every customizable product in collection and search grids.

sideBarColor
string<color>

Colour of the editor's side bar.

editorTheme
enum<string>

The editor's theme: light, dark or system.

Available options:
light,
dark,
system

Response

OK.

The account's editor and product page settings that the API manages. Settings that run code in the store (custom JS and CSS), send data elsewhere (webhooks) or are files are left out; manage them in the dashboard.

object
string
required
Allowed value: "settings"
editor
enum<string>
required
read-only

The editor the account uses. Read-only: switch editors in the dashboard.

Available options:
new,
classic
autoSaveProjects
boolean | null
required
read-only

Projects save in the background before the customer submits.

autoSaveDuration
integer | null
required
read-only

Days after which an auto-saved project that was never submitted is deleted.

Required range: 2 <= x <= 366
autoExpireProjects
boolean | null
required
read-only

Every project is deleted after projectLifetime days.

projectLifetime
integer | null
required
read-only

Days a project is kept, when autoExpireProjects is on.

Required range: 1 <= x <= 120
skipPreview
boolean | null
required

The Submit button skips the preview step.

expandThumbNav
boolean | null
required

Page thumbnails instead of arrows to move between pages.

showTabTitle
boolean | null
required

Labels on the editor's tabs.

enableSaveLater
boolean | null
required

Customers can save a design and finish it later. On here, it is on for every design.

defaultLayout
enum<string> | null
required

Classic editor only: the sidebar on the left ("") or the right (default-right).

Available options:
,
default-right,
null
layout
enum<string> | null
required

New editor only: the layout customers get. "" default, default-right sidebar on the right, product product designer, steps one step at a time, approve view and approve. Designs can override it in the editor.

Available options:
,
default-right,
product,
steps,
approve,
null
displayMode
enum<string> | null
required

How the editor opens on the product page: modal full window, dialog a dialog, inline inside the page at inlineSelector, mini beside the product images at miniSelector.

Available options:
modal,
dialog,
inline,
mini,
null
showGraphicsTitle
boolean | null
required

Show the titles of graphics that have one.

graphicsSearchCustomers
boolean | null
required

A search box in the Graphics panel for customers, on every design.

graphicsSearchScope
enum<string> | null
required

What the graphics search covers: store the print.app store, mine your own graphics, both.

Available options:
store,
mine,
both,
null
enableColorProofing
boolean | null
required

A colour proof (ICC soft proof) when customers preview their designs, on every design.

bleedLineColor
string<color> | null
required

Colour of the bleed line on the canvas.

marginLineColor
string<color> | null
required

Colour of the safe margin line on the canvas.

trimLineColor
string<color> | null
required

Colour of the trim line on the canvas.

foldLineColor
string<color> | null
required

Colour of fold lines on the canvas.

borderColor
string<color> | null
required

Colour of the border around a selected item.

decimalPointTextSize
boolean | null
required

Font sizes with decimals (10.5 pt).

autoPlaceNewText
boolean | null
required

New text goes straight onto the canvas, without clicking the canvas first.

autoTextSize
boolean | null
required

Size new text to fit the screen.

newTextSize
integer | null
required

Size of new text, when it is not sized to fit.

Required range: 10 <= x <= 100
defaultTextType
enum<string> | null
required

What new text is: Textbox wrapping text box, IText a text area.

Available options:
IText,
Textbox,
null
defaultNewTextString
string | null
required

Content of a new body text item.

Maximum string length: 500
defaultNewHeadingString
string | null
required

Content of a new heading.

Maximum string length: 200
hoverShow
boolean | null
required

Highlight the item under the mouse.

enableSnapping
boolean | null
required

Snap items while dragging them.

snapRange
integer | null
required

How close, in pixels, an item snaps.

Required range: 3 <= x <= 20
gridLinesInterval
integer | null
required

Gap between grid lines.

Required range: 5 <= x <= 100
bleedLineMessage
string | null
required

Label on the bleed line.

Maximum string length: 100
marginLineMessage
string | null
required

Label on the safe margin line.

Maximum string length: 100
trimLineMessage
string | null
required

Label on the trim line.

Maximum string length: 100
retainProductImages
boolean | null
required

Keep the product photos: the customer's design does not replace them after saving.

forceCustomization
boolean | null
required

Customers must customize before they can add the product to the cart.

disableCustomization
boolean | null
required

Hide the Customize button on every product page, so no one can customize. Only for a store that sells without the editor for a while.

customPreviewSelector
string | null
required

CSS selector for the product images the design previews replace, when the theme's differ from what Print.App looks for.

Maximum string length: 500
cartButtonSelector
string | null
required

CSS selector for the add-to-cart button, when the theme's differs from what Print.App looks for.

Maximum string length: 500
customVariantSelector
string | null
required

CSS selector for the field holding the chosen variant's id, when the theme's differs.

Maximum string length: 500
inlineSelector
string | null
required

CSS selector for where the editor sits with displayMode inline.

Maximum string length: 500
miniSelector
string | null
required

CSS selector for where the editor sits with displayMode mini.

Maximum string length: 500
moveButtonsBefore
string | null
required

CSS selector: the Customize button goes just before this element.

Maximum string length: 500
buttonsClass
string | null
required

CSS classes for the Customize button, to match the theme's buttons (default button).

Maximum string length: 200
observeFormRerenders
boolean | null
required

Remount the editor when the product form changes, for themes that redraw it.

collectionButtons
boolean | null
required

Shopify: a Customize button on every customizable product in collection and search grids.

sideBarColor
string<color> | null
required

Colour of the editor's side bar.

editorTheme
enum<string> | null
required

The editor's theme: light, dark or system.

Available options:
light,
dark,
system,
null