Skip to main content
PATCH
Update a connector

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

The connector id.

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

Wires a store's own product page to the FileCheck upload element (the Element embedded on WooCommerce, Shopify, PrestaShop, OpenCart or custom product pages), in both directions, with no custom code. Read entries take what the shopper chose on the page (banner width and height, a size dropdown, number of pages, single or double sided, finishing such as hem and eyelets) and use it to override the size-dependent checks of the product's rule and preflight profile for that upload: required artwork size, page count, file count, bleed and safe margin. Write entries push what FileCheck measured in the upload (page count, page width, height or area, color or mono page counts) or the rule's default size into the page's own inputs (quantity, width, height, area), so the store recalculates the price from the actual file. A connector never accepts, rejects or prices anything itself; the rule decides acceptance and the store stays in charge of price. It runs in the shopper's browser: the Element applies a connector passed to it as its connector option (this record's JSON, as returned by GET /connectors/{id}); handing the Element only a connectorId is reserved and not resolved yet. No other FileCheck record points at a connector; the cart plugins store the chosen connector id per product.

title
string

Name shown in the dashboard and in the cart plugins' per-product connector picker, e.g. "Banner size sync". The dashboard will not save a connector without one.

Maximum string length: 200
description
string

A note for the print shop: which products and which theme this connector was built for.

Maximum string length: 1000
entries
any[]

The connector's rules, both directions in one list, told apart by type: "read" (product page to FileCheck) or "write" (FileCheck to product page; an entry without type is a write entry). Entries run in order; when several read entries set the same value, the later one wins.

Maximum array length: 50
bindings
any[]

Legacy copy of the write entries, kept for Element versions released before entries existed; readers use it only when entries is empty. Omit it in new connectors, or keep it identical to the write entries in entries (the dashboard writes it that way on every save).

Maximum array length: 50
schemaVersion
integer

Record format version written by the dashboard editor (currently 1). Omit it.

Required range: x >= 1
tags
string[]

Free-form labels for organising the Library. Not used at runtime.

Maximum array length: 50
Required string length: 1 - 64

Response

OK

connector
Connector · object

Wires a store's own product page to the FileCheck upload element (the Element embedded on WooCommerce, Shopify, PrestaShop, OpenCart or custom product pages), in both directions, with no custom code. Read entries take what the shopper chose on the page (banner width and height, a size dropdown, number of pages, single or double sided, finishing such as hem and eyelets) and use it to override the size-dependent checks of the product's rule and preflight profile for that upload: required artwork size, page count, file count, bleed and safe margin. Write entries push what FileCheck measured in the upload (page count, page width, height or area, color or mono page counts) or the rule's default size into the page's own inputs (quantity, width, height, area), so the store recalculates the price from the actual file. A connector never accepts, rejects or prices anything itself; the rule decides acceptance and the store stays in charge of price. It runs in the shopper's browser: the Element applies a connector passed to it as its connector option (this record's JSON, as returned by GET /connectors/{id}); handing the Element only a connectorId is reserved and not resolved yet. No other FileCheck record points at a connector; the cart plugins store the chosen connector id per product.

dryRun
boolean

Present and true when nothing was saved.