Skip to main content
PATCH
Update the storefront settings

Authorizations

Authorization
string
header
required

Your secret key as a bearer token, e.g. Authorization: Bearer sk_live_…. Secret keys are server-side only.

Query Parameters

dryRun
boolean
default:false

Validate and check references without saving: the response shows the record as it would be saved.

Body

application/json

How the FileCheck Element (the upload form on your product pages) appears and behaves in your store. Every setting has a default; in a PATCH, null puts a setting back to it. Custom JS and CSS, which run code in your store, can only be changed in the dashboard.

presentation
enum<string> | null
default:inline

inline: the upload form sits on the product page. dialog: an "Upload Files" button opens the form in a popup.

Available options:
inline,
dialog,
null
mountSelector
string | null
default:""

CSS selector of the element the upload form (or, in dialog mode, its button) is placed into, used when the page has no element with id fc-inline. Empty: rely on #fc-inline (the Shopify app block and the cart plugins add it).

Maximum string length: 500
moveMountBefore
string | null
default:""

Dialog mode only: CSS selector of an element the "Upload Files" button is inserted before (for example the quantity field). Empty: the button goes into #fc-inline, then mountSelector, then next to the add-to-cart button.

Maximum string length: 500
cartButtonSelector
string | null
default:""

CSS selector(s) for the add-to-cart button, added to the built-in list. The Element keeps that button disabled until the customer's files are accepted, so set this when a theme's button isn't found.

Maximum string length: 500
elementTheme
enum<string> | null
default:light

The upload form's colour theme. system follows the shopper's device setting.

Available options:
light,
dark,
system,
null
proofDetails
enum<string> | null
default:collapsed

How the proof opens for the customer. collapsed: the print first, with the issues behind a summary button. expanded: the list of issues open beside it.

Available options:
collapsed,
expanded,
null

Show the product proof (3D model, folded leaflet, sheet, booklet) in place of the product page's own image gallery once every uploaded file has its proof. Off keeps the proof in the popup only.

CSS selector of the product gallery's container, for themes whose gallery the built-in selectors miss. Only used with galleryProof.

Maximum string length: 500

Response

OK

settings
Storefront settings · object

How the FileCheck Element (the upload form on your product pages) appears and behaves in your store. Every setting has a default; in a PATCH, null puts a setting back to it. Custom JS and CSS, which run code in your store, can only be changed in the dashboard.

dryRun
boolean

Present and true when nothing was saved.