Your secret key as a bearer token, e.g. Authorization: Bearer sk_live_…. Secret keys are server-side only.
Query Parameters
draft
boolean
default:false
Save as a draft: hidden from the storefront, the dashboard lists and other records until published (POST …/{id}/publish), and deleted after 30 days if never published. Jobs can still run against it by id, so it can be tested with real files first.
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.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Filecheck","colors":{"primary":"#1F5BFF","light":"#6088FF","dark":"#1747CC"},"logo":{"light":"https://mintcdn.com/filecheck/rNybgOKFlLbMhWeh/logo/light.svg?fit=max\u0026auto=format\u0026n=rNybgOKFlLbMhWeh\u0026q=85\u0026s=7bc29281132ca05b5217412db9e93fb8","dark":"https://mintcdn.com/filecheck/rNybgOKFlLbMhWeh/logo/dark.svg?fit=max\u0026auto=format\u0026n=rNybgOKFlLbMhWeh\u0026q=85\u0026s=e5a15a223efa144fa97287b4b96c0236"},"favicon":"https://mintcdn.com/filecheck/rNybgOKFlLbMhWeh/favicon.svg?fit=max\u0026auto=format\u0026n=rNybgOKFlLbMhWeh\u0026q=85\u0026s=1ca0b6f62da3e8005a37cf842f98f9c3","background":{"color":{"light":"#FFFFFF","dark":"#090B1A"}},"navbar":{"links":[{"href":"https://filecheck.io","label":"Website"}],"primary":{"type":"button","label":"Dashboard","href":"https://admin.filecheck.io"}},"footer":{"socials":{"x":"https://x.com/filecheckio","linkedin":"https://linkedin.com/company/filecheckio"},"links":[{"header":"Trust","items":[{"label":"Security and GDPR","href":"https://filecheck.io/security"},{"label":"Data Processing Agreement","href":"https://filecheck.io/company/dpa"},{"label":"Privacy policy","href":"https://filecheck.io/company/privacy"}]}]},"contextual":{"options":["copy","view","download-spec","chatgpt","claude"],"display":"header"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Demos","icon":"play","href":"https://filecheck.io/demos"},{"anchor":"Support","icon":"envelope","href":"mailto:support@filecheck.io"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"filecheck","hasAudioNarration":false,"actualSubdomain":"filecheck","customDomains":["filecheck.io"],"gitSource":{"type":"github","owner":"sterlyai","repo":"mintlify-docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"feedback":{"issues":true,"edits":true},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6afb44fbe515a9eaa9c00b6e","clientVersion":"0.0.4177","searchFilterCounts":[{"language":"default","tag":"API reference","count":68},{"language":"default","tag":"Documentation","count":34},{"language":"default","tag":"Developers","count":22},{"language":"default","tag":"Admin guide","count":15},{"language":"default","tag":"Jobs","count":9},{"language":"default","tag":"Preflight Profiles","count":8},{"language":"default","tag":"The Element","count":7},{"language":"default","tag":"Connectors","count":7},{"language":"default","tag":"Optimize presets","count":7},{"language":"default","tag":"Profiles","count":7}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"/docs","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"privacy":{"consentBanner":{"enabled":false}},"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/connectors/create-a-connector","slug":"/api-reference/connectors/create-a-connector","pageMetadata":{"title":"Create a connector","description":"Creates a connector. Records it points at must exist and be visible to you; a published connector cannot point at a draft.","deprecated":null,"version":null,"openapi":"/openapi.json post /connectors","href":"/api-reference/connectors/create-a-connector","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Creates a connector. Records it points at must exist and be visible to you; a published connector cannot point at a draft.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create a connector","description":"Creates a connector. Records it points at must exist and be visible to you; a published connector cannot point at a draft.","deprecated":null,"version":null,"openapi":"/openapi.json post /connectors","href":"/api-reference/connectors/create-a-connector","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/docs/_mintlify/custom/filecheck/6de6adfb358c6d44/ga-consent.js"],"openApiReferenceData":{"operation":{"operationId":"createConnector","tags":["Connectors"],"summary":"Create a connector","description":"Creates a connector. Records it points at must exist and be visible to you; a published connector cannot point at a draft.","parameters":["5ce5ac13-f174-4769-83b5-3bc42330ab68","6ef0542e-431f-400c-a4d3-6cd8af98ed3d"],"requestBody":"0066dd7a-19ed-43e9-a1c9-12f5e0a117fb","responses":{"201":"4e8db5d9-70e6-4dc2-8d1b-26e50f02dfcf","400":"a45a9b3c-7123-4c01-abf5-18f2909a9303","401":"9ac5fa1f-0e62-424d-b9e8-a66f56ff1f40","404":"bf464f8c-e779-42fb-bd8d-f545e564e516","409":"572cbc48-1d9c-49da-b925-1787806bfbf8"},"method":"post","type":"path","servers":["6d63e939-ba61-4fea-b30e-3ef95173001e"],"security":["4689694c-9868-4609-a20e-356775e7ce2d"],"path":"/connectors","baseUrlOptions":["https://api.filecheck.io"],"title":"Create a connector","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"5ce5ac13-f174-4769-83b5-3bc42330ab68":{"name":"draft","in":"query","schema":{"type":"boolean","default":false,"description":"Save as a draft: hidden from the storefront, the dashboard lists and other records until published (`POST …/{id}/publish`), and deleted after 30 days if never published. Jobs can still run against it by id, so it can be tested with real files first.","uniqueKey":"","typeLabel":"boolean"},"description":"Save as a draft: hidden from the storefront, the dashboard lists and other records until published (`POST …/{id}/publish`), and deleted after 30 days if never published. Jobs can still run against it by id, so it can be tested with real files first."},"6ef0542e-431f-400c-a4d3-6cd8af98ed3d":{"name":"dryRun","in":"query","schema":{"type":"boolean","default":false,"description":"Validate and check references without saving: the response shows the record as it would be saved.","uniqueKey":"","typeLabel":"boolean"},"description":"Validate and check references without saving: the response shows the record as it would be saved."}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"title":"Connector","description":"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.","type":"object","additionalProperties":false,"properties":{"title":{"type":"string","maxLength":200,"description":"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.","uniqueKey":"title","typeLabel":"string"},"description":{"type":"string","maxLength":1000,"description":"A note for the print shop: which products and which theme this connector was built for.","uniqueKey":"description","typeLabel":"string"},"entries":{"type":"array","maxItems":50,"items":{"type":"any","uniqueKey":"entries.items.[INDEX]","typeLabel":"any"},"description":"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.","uniqueKey":"entries","typeLabel":"any[]"},"bindings":{"type":"array","maxItems":50,"items":{"type":"any","uniqueKey":"bindings.items.[INDEX]","typeLabel":"any"},"description":"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).","uniqueKey":"bindings","typeLabel":"any[]"},"schemaVersion":{"type":"integer","minimum":1,"description":"Record format version written by the dashboard editor (currently 1). Omit it.","uniqueKey":"schemaVersion","typeLabel":"integer"},"tags":{"type":"array","maxItems":50,"items":{"type":"string","minLength":1,"maxLength":64,"uniqueKey":"tags.items.[INDEX]","typeLabel":"string"},"description":"Free-form labels for organising the Library. Not used at runtime.","uniqueKey":"tags","typeLabel":"string[]"}},"definitions":{"entry":{"description":"One read or write rule. `type: \"read\"` selects the read shape; anything else (including no `type`) is a write entry.","if":{"properties":{"type":{"const":"read"}},"required":["type"]},"then":{"$ref":"#/components/schemas/Connector/definitions/readEntry"},"else":{"$ref":"#/components/schemas/Connector/definitions/writeEntry"}},"entryId":{"type":"string","minLength":1,"maxLength":64,"description":"Stable id for this entry, unique within the connector; it shows up in the Element's debug report (?fcdebug=1). Optional: one is generated when the dashboard opens the connector."},"entryEnabled":{"type":"boolean","default":true,"description":"Set false to keep the entry but skip it at runtime."},"customSelector":{"type":"string","maxLength":512,"description":"CSS selector for the control on the product page, tried before the built-in selectors, e.g. #banner-width or select[name=\"attribute_pa_size\"]. Leave empty to rely on the built-in selectors alone. Only used with querySelector, so the first matching element wins; an invalid selector is skipped."},"rounding":{"type":"string","enum":["round","floor","ceil"],"default":"round","description":"How the converted value is rounded to `decimals`: round to nearest, floor (down) or ceil (up). With decimals null, floor and ceil round to whole numbers and round leaves the value as is."},"decimals":{"type":["integer","null"],"minimum":0,"maximum":6,"description":"Decimal places to round the converted value to (0 to 6). null means no rounding. Counts are always whole numbers."},"domEvents":{"type":"array","maxItems":10,"uniqueItems":true,"items":{"type":"string","minLength":1,"maxLength":64,"pattern":"^\\S+$"}},"unitName":{"type":"string","enum":["mm","cm","m","in","ft","pt"],"description":"Named unit: mm (millimetres), cm, m (metres), in (inches), ft (feet), pt (points, 1/72 inch)."},"unit":{"description":"A unit: one of the names mm, cm, m, in, ft, pt, or a positive number giving millimetres per one unit of the page's value (25.4 for inches, 100 for decimetres).","anyOf":[{"$ref":"#/components/schemas/Connector/definitions/unitName"},{"type":"number","exclusiveMinimum":0}]},"pickedUnit":{"type":"object","additionalProperties":false,"required":["fromSelector"],"description":"Read the unit from a second control on the page, for pages that pair a size box with a unit dropdown.","properties":{"fromSelector":{"type":"string","minLength":1,"maxLength":512,"description":"CSS selector of the unit control, e.g. select[name=\"unit\"]."},"map":{"type":"object","propertyNames":{"minLength":1,"maxLength":128},"additionalProperties":{"$ref":"#/components/schemas/Connector/definitions/unit"},"description":"The unit control's option values mapped to units, e.g. { \"CM\": \"cm\", \"feet\": \"ft\", \"mm\": \"mm\" }. Matched as-is, then lower- and upper-cased. Without a map the control's value itself must be a unit name. An unrecognised value falls back to millimetres."}}},"countRange":{"type":"object","additionalProperties":false,"minProperties":1,"properties":{"min":{"type":"integer","minimum":0,"description":"Lowest accepted count."},"max":{"type":"integer","minimum":0,"description":"Highest accepted count. Use min = max for an exact count."}}},"contextFragment":{"type":"object","additionalProperties":false,"minProperties":1,"description":"What one choice means for the check, in millimetres and plain counts. Each key overrides one part of the product's rule or profile for this upload (and only parts that are switched on there).","properties":{"artworkSize":{"type":"object","additionalProperties":false,"minProperties":1,"description":"Required finished (trim) size; replaces the profile's allowed page sizes and the raster print size used for effective DPI.","properties":{"width_mm":{"type":"number","exclusiveMinimum":0,"description":"Width in mm."},"height_mm":{"type":"number","exclusiveMinimum":0,"description":"Height in mm."}}},"pageCount":{"$ref":"#/components/schemas/Connector/definitions/countRange","description":"Required number of pages, e.g. { \"min\": 2, \"max\": 2 } for double sided; replaces the profile's page-count check."},"fileCount":{"$ref":"#/components/schemas/Connector/definitions/countRange","description":"How many files the shopper must upload; replaces the rule's file cardinality."},"bleed":{"type":"object","additionalProperties":false,"required":["required_mm"],"description":"Required bleed; replaces the profile's bleed and bleed-coverage checks.","properties":{"required_mm":{"type":"number","minimum":0,"description":"Bleed in mm on each edge, e.g. 25 for a hemmed banner."}}},"safety":{"type":"object","additionalProperties":false,"required":["min_mm"],"description":"Safe margin that text must stay inside; replaces the profile's safety-margin check (the file is analyzed again when this changes).","properties":{"min_mm":{"type":"number","minimum":0,"description":"Margin in mm from the trim edge, e.g. 20 for eyelets."}}}}},"readEntry":{"type":"object","additionalProperties":false,"required":["type","field"],"description":"Product page to FileCheck: read one control the shopper sets and turn it into a requirement for the upload check. The value is re-read whenever the shopper changes the control.","allOf":[{"if":{"properties":{"read":{"const":"attr"}},"required":["read"]},"then":{"required":["attr"],"properties":{"attr":{"type":"string","minLength":1}}}},{"if":{"properties":{"field":{"const":"size"}},"required":["field"]},"then":{"required":["pattern"],"properties":{"pattern":{"minLength":1}}}},{"if":{"properties":{"field":{"enum":["sides","finishing"]}},"required":["field"]},"then":{"required":["map"],"properties":{"map":{"type":"object","minProperties":1}}}},{"if":{"properties":{"field":{"enum":["width","height"]}},"required":["field"]},"then":{"properties":{"target":{"enum":["artworkSize","bleed","safety",null]}}}},{"if":{"properties":{"field":{"const":"size"}},"required":["field"]},"then":{"properties":{"target":{"enum":["artworkSize",null]}}}},{"if":{"properties":{"field":{"enum":["pages","files"]}},"required":["field"]},"then":{"properties":{"target":{"enum":["pageCount","fileCount",null]}}}}],"properties":{"id":{"$ref":"#/components/schemas/Connector/definitions/entryId"},"enabled":{"$ref":"#/components/schemas/Connector/definitions/entryEnabled","default":true},"type":{"type":"string","const":"read","description":"Marks a read entry."},"field":{"type":"string","enum":["width","height","size","pages","sides","files","finishing"],"description":"What the control means. width / height: one measurement, converted to mm (drives artworkSize by default). size: one control holding both, e.g. \"3000 x 1000 mm\"; needs `pattern` with width and height groups (drives artworkSize). pages: number of pages (drives pageCount). files: number of separate files (drives fileCount). sides and finishing: a choice looked up in `map` (sides typically sets pageCount, finishing sets bleed and safety). Built-in selectors tried after customSelector: width: input[name=\"width\"], #width, input[data-dimension=\"width\"], input[name=\"dimension_width\"], input[name=\"banner_width\"], .product-width input (height likewise); size: select[name=\"size\"], #size, input[name=\"size\"], [data-option=\"size\"]; pages: input[name=\"pages\"], #pages, select[name=\"pages\"], [data-option=\"pages\"]; sides: select[name=\"sides\"], input[name=\"sides\"]:checked, #sides, [data-option=\"sides\"]; files: input[name=\"files\"], select[name=\"files\"], [data-option=\"files\"]; finishing: select[name=\"finishing\"], input[name=\"finishing\"]:checked, #finishing, [data-option=\"finishing\"]."},"customSelector":{"$ref":"#/components/schemas/Connector/definitions/customSelector"},"read":{"type":"string","enum":["value","text","attr"],"default":"value","description":"How to get the raw string from the control: value (the input's or select's value, falling back to its text), text (the element's text content) or attr (the attribute named in `attr`)."},"attr":{"type":["string","null"],"maxLength":128,"description":"Attribute to read when read is attr, e.g. data-value."},"pattern":{"type":"string","maxLength":500,"description":"Optional JavaScript regular expression run on the raw string (first 512 characters). Named groups pick the numbers: width and height for a size field, e.g. (?\u003cwidth>[\\d.]+)\\s*[x×]\\s*(?\u003cheight>[\\d.]+); value for counts and choices. Without named groups the first two groups are taken as width and height. When a pattern is set and does not match, the entry yields nothing (the product's own settings apply) rather than guessing."},"patternFlags":{"type":"string","pattern":"^[dgimsuyv]*$","maxLength":8,"description":"Flags for `pattern`, e.g. i for case-insensitive."},"convertFrom":{"description":"Unit of the measurement on the page, converted to mm (width, height and size fields only; ignored for counts and choices). A unit name (mm, cm, m, in, ft, pt), a number of millimetres per page unit (e.g. 25.4), or { fromSelector, map } to read the unit from another control. Default mm.","anyOf":[{"$ref":"#/components/schemas/Connector/definitions/unit"},{"$ref":"#/components/schemas/Connector/definitions/pickedUnit"}]},"decimals":{"$ref":"#/components/schemas/Connector/definitions/decimals"},"round":{"$ref":"#/components/schemas/Connector/definitions/rounding","default":"round"},"target":{"type":["string","null"],"enum":["artworkSize","pageCount","fileCount","bleed","safety",null],"description":"What the value drives. Default (null) follows the field: width, height and size drive artworkSize; pages drives pageCount; files drives fileCount. A width or height entry can instead drive bleed or safety (the measurement becomes the bleed or safe margin in mm); a pages or files entry can drive pageCount or fileCount. Choice fields ignore this and use `map`."},"map":{"type":["object","null"],"propertyNames":{"minLength":1,"maxLength":256},"additionalProperties":{"$ref":"#/components/schemas/Connector/definitions/contextFragment"},"description":"For sides and finishing: each option value on the page (as read, also tried lower-cased) mapped to what it requires, e.g. { \"single\": { \"pageCount\": { \"min\": 1, \"max\": 1 } }, \"double\": { \"pageCount\": { \"min\": 2, \"max\": 2 } } } or { \"hem_eyelets\": { \"bleed\": { \"required_mm\": 25 }, \"safety\": { \"min_mm\": 20 } } }. An option missing from the map yields nothing. Ignored for other fields."},"watch":{"$ref":"#/components/schemas/Connector/definitions/domEvents","default":["input","change"],"description":"DOM events on the control that mean the shopper changed it. Default [\"input\", \"change\"]."}}},"writeEntry":{"type":"object","additionalProperties":false,"required":["source"],"description":"FileCheck to product page: write one measured fact (or the rule's default) into a control on the page. Runs after every upload status change.","allOf":[{"if":{"properties":{"set":{"const":"attr"}},"required":["set"]},"then":{"required":["attr"],"properties":{"attr":{"type":"string","minLength":1}}}},{"anyOf":[{"required":["control"],"properties":{"control":{"type":"string"}}},{"required":["customSelector"],"properties":{"customSelector":{"minLength":1}}}]}],"properties":{"id":{"$ref":"#/components/schemas/Connector/definitions/entryId"},"enabled":{"$ref":"#/components/schemas/Connector/definitions/entryEnabled","default":true},"type":{"type":"string","const":"write","description":"Marks a write entry. Optional: entries without a type are write entries."},"source":{"type":"string","enum":["pageCount","fileCount","colorPageCount","monoPageCount","width","height","area","ruleWidth","ruleHeight","rulePages"],"description":"The value to write. pageCount: total pages across the upload. fileCount: number of accepted files. colorPageCount / monoPageCount: pages with any color or spot ink / black-only pages (nothing is written when ink was not measured). width / height: the first file's page width / height in mm. area: the first file's page area in mm². ruleWidth / ruleHeight / rulePages: the product rule's default artwork width, height (mm) and page count, written before anything is uploaded, to seed the page with the product's default size."},"control":{"type":["string","null"],"enum":["quantity","width","height","area",null],"description":"Which kind of control to write into; picks built-in selectors tried after customSelector. quantity: input[name=\"quantity\"], input.quantity, #quantity, #qty, .qty, input[name=\"qty\"], input[data-quantity], .quantity input[type=\"number\"]. width: input[name=\"width\"], #width, .product-width, input[data-dimension=\"width\"], input[name=\"dimension_width\"] (height likewise). area: input[name=\"area\"], #area, .product-area, select[name=\"area\"], input[data-dimension=\"area\"]. null: use customSelector only. Either control or customSelector is required."},"customSelector":{"$ref":"#/components/schemas/Connector/definitions/customSelector"},"set":{"type":"string","enum":["value","text","attr"],"default":"value","description":"How to write: value (sets the input's or select's value), text (replaces the element's text) or attr (sets the attribute named in `attr`)."},"attr":{"type":["string","null"],"maxLength":128,"description":"Attribute to set when set is attr, e.g. data-qty."},"emit":{"$ref":"#/components/schemas/Connector/definitions/domEvents","default":["input","change"],"description":"DOM events fired on the control after writing, so the store's own scripts (price calculators, variant pickers) notice the change. Default [\"input\", \"change\"]."},"convertFrom":{"$ref":"#/components/schemas/Connector/definitions/unit","default":"mm","description":"Unit of the source value. Measured facts are always millimetres, so leave this at mm (the default). Ignored for counts."},"convertTo":{"$ref":"#/components/schemas/Connector/definitions/unit","default":"mm","description":"Unit the page's control expects for width, height and area: a unit name (mm, cm, m, in, ft, pt) or millimetres per page unit. Area is converted with the square of the factor. Ignored for counts."},"decimals":{"$ref":"#/components/schemas/Connector/definitions/decimals"},"round":{"$ref":"#/components/schemas/Connector/definitions/rounding","default":"round"}}}},"uniqueKey":"","typeLabel":"Connector · object"},"examples":{"Example":{"title":"Example","value":{"title":"\u003cstring>","description":"\u003cstring>","entries":["\u003cunknown>"],"bindings":["\u003cunknown>"],"schemaVersion":2,"tags":["\u003cstring>"]}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"4e8db5d9-70e6-4dc2-8d1b-26e50f02dfcf":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"connector":{"type":"object","title":"Connector","description":"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.","properties":{"title":{"type":"string","maxLength":200,"description":"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.","uniqueKey":"connector.title","typeLabel":"string"},"description":{"type":"string","maxLength":1000,"description":"A note for the print shop: which products and which theme this connector was built for.","uniqueKey":"connector.description","typeLabel":"string"},"entries":{"type":"array","maxItems":50,"items":{"type":"any","uniqueKey":"connector.entries.items.[INDEX]","typeLabel":"any"},"description":"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.","uniqueKey":"connector.entries","typeLabel":"any[]"},"bindings":{"type":"array","maxItems":50,"items":{"type":"any","uniqueKey":"connector.bindings.items.[INDEX]","typeLabel":"any"},"description":"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).","uniqueKey":"connector.bindings","typeLabel":"any[]"},"schemaVersion":{"type":"integer","minimum":1,"description":"Record format version written by the dashboard editor (currently 1). Omit it.","uniqueKey":"connector.schemaVersion","typeLabel":"integer"},"tags":{"type":"array","maxItems":50,"items":{"type":"string","minLength":1,"maxLength":64,"uniqueKey":"connector.tags.items.[INDEX]","typeLabel":"string"},"description":"Free-form labels for organising the Library. Not used at runtime.","uniqueKey":"connector.tags","typeLabel":"string[]"},"id":{"type":"string","description":"The record id.","uniqueKey":"connector.id","typeLabel":"string"},"source":{"type":"string","enum":["domain","store"],"description":"`domain`: yours. `store`: a built-in catalog record.","uniqueKey":"connector.source","typeLabel":"enum\u003cstring>"},"customized":{"type":"boolean","description":"Your own copy of a built-in record, under the same id. Revert drops it.","uniqueKey":"connector.customized","typeLabel":"boolean"},"draft":{"type":"boolean","description":"Present and true on an unpublished draft.","uniqueKey":"connector.draft","typeLabel":"boolean"},"draftExpiresAt":{"type":"string","format":"date-time","description":"When an unpublished draft is deleted.","uniqueKey":"connector.draftExpiresAt","typeLabel":"string\u003cdate-time>"},"created":{"type":"integer","description":"Unix time (seconds).","uniqueKey":"connector.created","typeLabel":"integer"},"modified":{"type":"integer","description":"Unix time (seconds).","uniqueKey":"connector.modified","typeLabel":"integer"}},"additionalProperties":false,"uniqueKey":"connector","typeLabel":"Connector · object"},"dryRun":{"type":"boolean","description":"Present and true when nothing was saved.","uniqueKey":"dryRun","typeLabel":"boolean"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"connector":{"title":"\u003cstring>","description":"\u003cstring>","entries":["\u003cunknown>"],"bindings":["\u003cunknown>"],"schemaVersion":2,"tags":["\u003cstring>"],"id":"\u003cstring>","source":"domain","customized":true,"draft":true,"draftExpiresAt":"2023-11-07T05:31:56Z","created":123,"modified":123},"dryRun":true}}},"exampleType":"generated"}},"exampleType":"generated"},"a45a9b3c-7123-4c01-abf5-18f2909a9303":{"description":"Invalid request: `code` says why, `param` names the field, `details` lists every problem","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean","const":true,"uniqueKey":"error","typeLabel":"boolean"},"code":{"type":"string","description":"Machine-readable reason, such as validation_failed, invalid_reference, not_found, in_use, draft_reference.","uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"},"param":{"type":"string","description":"The field at fault, as a dotted path (intake.ruleId, accepts.0.preflight.profileId).","uniqueKey":"param","typeLabel":"string"},"details":{"type":"array","description":"Every problem found, or the records that block a delete.","items":{"type":"object","additionalProperties":true,"uniqueKey":"details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"details","typeLabel":"object[]"},"requestId":{"type":"string","description":"Quote it to support.","uniqueKey":"requestId","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":true,"code":"\u003cstring>","message":"\u003cstring>","param":"\u003cstring>","details":[{}],"requestId":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"9ac5fa1f-0e62-424d-b9e8-a66f56ff1f40":{"description":"Missing or invalid key","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean","const":true,"uniqueKey":"error","typeLabel":"boolean"},"code":{"type":"string","description":"Machine-readable reason, such as validation_failed, invalid_reference, not_found, in_use, draft_reference.","uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"},"param":{"type":"string","description":"The field at fault, as a dotted path (intake.ruleId, accepts.0.preflight.profileId).","uniqueKey":"param","typeLabel":"string"},"details":{"type":"array","description":"Every problem found, or the records that block a delete.","items":{"type":"object","additionalProperties":true,"uniqueKey":"details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"details","typeLabel":"object[]"},"requestId":{"type":"string","description":"Quote it to support.","uniqueKey":"requestId","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":true,"code":"\u003cstring>","message":"\u003cstring>","param":"\u003cstring>","details":[{}],"requestId":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"bf464f8c-e779-42fb-bd8d-f545e564e516":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean","const":true,"uniqueKey":"error","typeLabel":"boolean"},"code":{"type":"string","description":"Machine-readable reason, such as validation_failed, invalid_reference, not_found, in_use, draft_reference.","uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"},"param":{"type":"string","description":"The field at fault, as a dotted path (intake.ruleId, accepts.0.preflight.profileId).","uniqueKey":"param","typeLabel":"string"},"details":{"type":"array","description":"Every problem found, or the records that block a delete.","items":{"type":"object","additionalProperties":true,"uniqueKey":"details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"details","typeLabel":"object[]"},"requestId":{"type":"string","description":"Quote it to support.","uniqueKey":"requestId","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":true,"code":"\u003cstring>","message":"\u003cstring>","param":"\u003cstring>","details":[{}],"requestId":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"572cbc48-1d9c-49da-b925-1787806bfbf8":{"description":"Conflict: `code` says why (in_use, draft_reference, not_a_draft, not_a_catalog_record, cart_not_supported)","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean","const":true,"uniqueKey":"error","typeLabel":"boolean"},"code":{"type":"string","description":"Machine-readable reason, such as validation_failed, invalid_reference, not_found, in_use, draft_reference.","uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"},"param":{"type":"string","description":"The field at fault, as a dotted path (intake.ruleId, accepts.0.preflight.profileId).","uniqueKey":"param","typeLabel":"string"},"details":{"type":"array","description":"Every problem found, or the records that block a delete.","items":{"type":"object","additionalProperties":true,"uniqueKey":"details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"details","typeLabel":"object[]"},"requestId":{"type":"string","description":"Quote it to support.","uniqueKey":"requestId","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":true,"code":"\u003cstring>","message":"\u003cstring>","param":"\u003cstring>","details":[{}],"requestId":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"4689694c-9868-4609-a20e-356775e7ce2d":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Your secret key as a bearer token, e.g. `Authorization: Bearer sk_live_…`. Secret keys are server-side only.","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"6d63e939-ba61-4fea-b30e-3ef95173001e":{"url":"https://api.filecheck.io","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Your secret key as a bearer token, e.g. `Authorization: Bearer sk_live_…`. Secret keys are server-side only.","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Your secret key as a bearer token, e.g. `Authorization: Bearer sk_live_…`. Secret keys are server-side only.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"openapi.json"},"subdomain":"filecheck","siteName":"Filecheck","title":"Create a connector - Filecheck","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-11T08:51:32.085Z","originalFileLocation":"api-reference/connectors/create-a-connector.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Creates a connector. Records it points at must exist and be visible to you; a published connector cannot point at a draft.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Filecheck\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/filecheck/NelkTiDjeD6s_0IH/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/docs/mintlify-assets/_mintlify/favicons/filecheck/NelkTiDjeD6s_0IH/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/filecheck/NelkTiDjeD6s_0IH/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/filecheck/NelkTiDjeD6s_0IH/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/filecheck/NelkTiDjeD6s_0IH/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/filecheck/NelkTiDjeD6s_0IH/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/filecheck/NelkTiDjeD6s_0IH/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/filecheck/NelkTiDjeD6s_0IH/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/filecheck/NelkTiDjeD6s_0IH/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create a connector - Filecheck\">\u003cmeta data-mint-head property=\"og:description\" content=\"Creates a connector. Records it points at must exist and be visible to you; a published connector cannot point at a draft.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Filecheck\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://filecheck.io/docs/api-reference/connectors/create-a-connector\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://filecheck.mintlify.site/docs/_mintlify/api/og/v2?division=Connectors\u0026amp;title=Create+a+connector\u0026amp;description=Creates+a+connector.+Records+it+points+at+must+exist+and+be+visible+to+you%3B+a+published+connector+cannot+point+at+a+draft.\u0026amp;theme=2d8b0f160f4bd456e90bb9d1\u0026amp;signature=3ea1a507facf8ac816ec481b02f7d49e5e09f523b9535482c0479713217de69b\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Create a connector - Filecheck\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Creates a connector. Records it points at must exist and be visible to you; a published connector cannot point at a draft.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://filecheck.mintlify.site/docs/_mintlify/api/og/v2?division=Connectors\u0026amp;title=Create+a+connector\u0026amp;description=Creates+a+connector.+Records+it+points+at+must+exist+and+be+visible+to+you%3B+a+published+connector+cannot+point+at+a+draft.\u0026amp;theme=2d8b0f160f4bd456e90bb9d1\u0026amp;signature=3ea1a507facf8ac816ec481b02f7d49e5e09f523b9535482c0479713217de69b\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/docs/mintlify-assets/_mintlify/favicons/filecheck/NelkTiDjeD6s_0IH/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Filecheck\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#1F5BFF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://filecheck.io/docs/api-reference/connectors/create-a-connector\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/api-reference/connectors/create-a-connector.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://filecheck.io/#organization\",\"name\":\"Filecheck\",\"url\":\"https://filecheck.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/filecheck/rNybgOKFlLbMhWeh/logo/light.svg?fit=max\u0026auto=format\u0026n=rNybgOKFlLbMhWeh\u0026q=85\u0026s=7bc29281132ca05b5217412db9e93fb8\"}},{\"@type\":\"WebSite\",\"@id\":\"https://filecheck.io/docs#website\",\"name\":\"Filecheck\",\"url\":\"https://filecheck.io/docs\",\"publisher\":{\"@id\":\"https://filecheck.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://filecheck.io/docs/api-reference/connectors/create-a-connector#webpage\",\"url\":\"https://filecheck.io/docs/api-reference/connectors/create-a-connector\",\"name\":\"Create a connector\",\"description\":\"Creates a connector. Records it points at must exist and be visible to you; a published connector cannot point at a draft.\",\"dateModified\":\"2026-11-11T08:51:32.085Z\",\"isPartOf\":{\"@id\":\"https://filecheck.io/docs#website\"},\"breadcrumb\":{\"@id\":\"https://filecheck.io/docs/api-reference/connectors/create-a-connector#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://filecheck.io/docs/api-reference/connectors/create-a-connector#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Connectors\",\"item\":\"https://filecheck.io/docs/api-reference/connectors/list-connectors\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create a connector\",\"item\":\"https://filecheck.io/docs/api-reference/connectors/create-a-connector\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://filecheck.io/docs/api-reference/connectors/create-a-connector#apireference\",\"headline\":\"Create a connector\",\"name\":\"Create a connector\",\"description\":\"Creates a connector. Records it points at must exist and be visible to you; a published connector cannot point at a draft.\",\"url\":\"https://filecheck.io/docs/api-reference/connectors/create-a-connector\",\"mainEntityOfPage\":{\"@id\":\"https://filecheck.io/docs/api-reference/connectors/create-a-connector#webpage\"},\"dateModified\":\"2026-11-11T08:51:32.085Z\",\"publisher\":{\"@id\":\"https://filecheck.io/#organization\"},\"isPartOf\":{\"@id\":\"https://filecheck.io/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Filecheck\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Filecheck\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/docs/api-reference/connectors/create-a-connector.md","siteName":"Filecheck","nav":{"global":{"anchors":[{"anchor":"Demos","icon":"play","href":"https://filecheck.io/demos"},{"anchor":"Support","icon":"envelope","href":"mailto:support@filecheck.io"}]},"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":""}]},{"tab":"Developers","pages":[{"title":"Developers","href":"/element/overview"}]},{"tab":"API reference","groups":[{"group":"Overview","pages":[{"title":"API overview","href":"/api-reference/introduction"},{"title":"Authentication","href":"/api-reference/authentication"}]},{"group":"Libraries","pages":[{"title":"Official libraries","sidebarTitle":"Overview","href":"/integrations/libraries"}]},{"group":"Jobs","pages":[{"title":"Submit a job","deprecated":null,"version":null,"openapi":"/openapi.json post /jobs","href":"/api-reference/jobs/submit-a-job"},{"title":"List jobs","deprecated":null,"version":null,"openapi":"/openapi.json get /jobs","href":"/api-reference/jobs/list-jobs"},{"title":"Get a job","deprecated":null,"version":null,"openapi":"/openapi.json get /jobs/{id}","href":"/api-reference/jobs/get-a-job"},{"title":"Delete a job","deprecated":null,"version":null,"openapi":"/openapi.json delete /jobs/{id}","href":"/api-reference/jobs/delete-a-job"},{"title":"Preflight a file","deprecated":null,"version":null,"openapi":"/openapi.json post /jobs/preflight","href":"/api-reference/jobs/preflight-a-file"},{"title":"Fix a file","deprecated":null,"version":null,"openapi":"/openapi.json post /jobs/fix","href":"/api-reference/jobs/fix-a-file"},{"title":"Optimize a file","deprecated":null,"version":null,"openapi":"/openapi.json post /jobs/optimize","href":"/api-reference/jobs/optimize-a-file"},{"title":"Validate a file","deprecated":null,"version":null,"openapi":"/openapi.json post /jobs/validate","href":"/api-reference/jobs/validate-a-file"},{"title":"Generate previews","deprecated":null,"version":null,"openapi":"/openapi.json post /jobs/previews","href":"/api-reference/jobs/generate-previews"}]},{"group":"Uploads \u0026 orders","pages":[{"title":"Create an upload","deprecated":null,"version":null,"openapi":"/openapi.json post /uploads","href":"/api-reference/uploads/create-an-upload"},{"title":"Capture an order","deprecated":null,"version":null,"openapi":"/openapi.json post /orders/{id}","href":"/api-reference/orders/capture-an-order"}]},{"group":"Workflows","pages":[{"title":"List workflows","deprecated":null,"version":null,"openapi":"/openapi.json get /workflows","href":"/api-reference/workflows/list-workflows"},{"title":"Get a workflow","deprecated":null,"version":null,"openapi":"/openapi.json get /workflows/{id}","href":"/api-reference/workflows/get-a-workflow"},{"title":"Create a workflow","deprecated":null,"version":null,"openapi":"/openapi.json post /workflows","href":"/api-reference/workflows/create-a-workflow"},{"title":"Update a workflow","deprecated":null,"version":null,"openapi":"/openapi.json patch /workflows/{id}","href":"/api-reference/workflows/update-a-workflow"},{"title":"Delete a workflow","deprecated":null,"version":null,"openapi":"/openapi.json delete /workflows/{id}","href":"/api-reference/workflows/delete-a-workflow"},{"title":"Publish a draft workflow","deprecated":null,"version":null,"openapi":"/openapi.json post /workflows/{id}/publish","href":"/api-reference/workflows/publish-a-draft-workflow"},{"title":"Revert to the catalog workflow","deprecated":null,"version":null,"openapi":"/openapi.json post /workflows/{id}/revert","href":"/api-reference/workflows/revert-to-the-catalog-workflow"}]},{"group":"Rules","pages":[{"title":"List rules","deprecated":null,"version":null,"openapi":"/openapi.json get /rules","href":"/api-reference/rules/list-rules"},{"title":"Get a rule","deprecated":null,"version":null,"openapi":"/openapi.json get /rules/{id}","href":"/api-reference/rules/get-a-rule"},{"title":"Create a rule","deprecated":null,"version":null,"openapi":"/openapi.json post /rules","href":"/api-reference/rules/create-a-rule"},{"title":"Update a rule","deprecated":null,"version":null,"openapi":"/openapi.json patch /rules/{id}","href":"/api-reference/rules/update-a-rule"},{"title":"Delete a rule","deprecated":null,"version":null,"openapi":"/openapi.json delete /rules/{id}","href":"/api-reference/rules/delete-a-rule"},{"title":"Publish a draft rule","deprecated":null,"version":null,"openapi":"/openapi.json post /rules/{id}/publish","href":"/api-reference/rules/publish-a-draft-rule"},{"title":"Revert to the catalog rule","deprecated":null,"version":null,"openapi":"/openapi.json post /rules/{id}/revert","href":"/api-reference/rules/revert-to-the-catalog-rule"}]},{"group":"Profiles","pages":[{"title":"List preflight profiles","deprecated":null,"version":null,"openapi":"/openapi.json get /profiles","href":"/api-reference/profiles/list-preflight-profiles"},{"title":"Get a preflight profile","deprecated":null,"version":null,"openapi":"/openapi.json get /profiles/{id}","href":"/api-reference/profiles/get-a-preflight-profile"},{"title":"Create a preflight profile","deprecated":null,"version":null,"openapi":"/openapi.json post /profiles","href":"/api-reference/profiles/create-a-preflight-profile"},{"title":"Update a preflight profile","deprecated":null,"version":null,"openapi":"/openapi.json patch /profiles/{id}","href":"/api-reference/profiles/update-a-preflight-profile"},{"title":"Delete a preflight profile","deprecated":null,"version":null,"openapi":"/openapi.json delete /profiles/{id}","href":"/api-reference/profiles/delete-a-preflight-profile"},{"title":"Publish a draft preflight profile","deprecated":null,"version":null,"openapi":"/openapi.json post /profiles/{id}/publish","href":"/api-reference/profiles/publish-a-draft-preflight-profile"},{"title":"Revert to the catalog preflight profile","deprecated":null,"version":null,"openapi":"/openapi.json post /profiles/{id}/revert","href":"/api-reference/profiles/revert-to-the-catalog-preflight-profile"}]},{"group":"Connectors","pages":[{"title":"List connectors","deprecated":null,"version":null,"openapi":"/openapi.json get /connectors","href":"/api-reference/connectors/list-connectors"},{"title":"Get a connector","description":"Your connector first, then the built-in catalog. Your drafts are returned too, with `draft: true`.","deprecated":null,"version":null,"openapi":"/openapi.json get /connectors/{id}","href":"/api-reference/connectors/get-a-connector"},{"title":"Create a connector","deprecated":null,"version":null,"openapi":"/openapi.json post /connectors","href":"/api-reference/connectors/create-a-connector"},{"title":"Update a connector","description":"A JSON Merge Patch (RFC 7396): send only what changes. Objects merge key by key, `null` removes a key, arrays replace the whole list. Patching a catalog connector saves your own copy under the same id (`customized: true`), which you can undo with revert.","deprecated":null,"version":null,"openapi":"/openapi.json patch /connectors/{id}","href":"/api-reference/connectors/update-a-connector"},{"title":"Delete a connector","deprecated":null,"version":null,"openapi":"/openapi.json delete /connectors/{id}","href":"/api-reference/connectors/delete-a-connector"},{"title":"Publish a draft connector","deprecated":null,"version":null,"openapi":"/openapi.json post /connectors/{id}/publish","href":"/api-reference/connectors/publish-a-draft-connector"},{"title":"Revert to the catalog connector","deprecated":null,"version":null,"openapi":"/openapi.json post /connectors/{id}/revert","href":"/api-reference/connectors/revert-to-the-catalog-connector"}]},{"group":"Optimize presets","pages":[{"title":"List optimize presets","deprecated":null,"version":null,"openapi":"/openapi.json get /optimize-presets","href":"/api-reference/optimize-presets/list-optimize-presets"},{"title":"Get a optimize preset","deprecated":null,"version":null,"openapi":"/openapi.json get /optimize-presets/{id}","href":"/api-reference/optimize-presets/get-a-optimize-preset"},{"title":"Create a optimize preset","deprecated":null,"version":null,"openapi":"/openapi.json post /optimize-presets","href":"/api-reference/optimize-presets/create-a-optimize-preset"},{"title":"Update a optimize preset","deprecated":null,"version":null,"openapi":"/openapi.json patch /optimize-presets/{id}","href":"/api-reference/optimize-presets/update-a-optimize-preset"},{"title":"Delete a optimize preset","deprecated":null,"version":null,"openapi":"/openapi.json delete /optimize-presets/{id}","href":"/api-reference/optimize-presets/delete-a-optimize-preset"},{"title":"Publish a draft optimize preset","deprecated":null,"version":null,"openapi":"/openapi.json post /optimize-presets/{id}/publish","href":"/api-reference/optimize-presets/publish-a-draft-optimize-preset"},{"title":"Revert to the catalog optimize preset","deprecated":null,"version":null,"openapi":"/openapi.json post /optimize-presets/{id}/revert","href":"/api-reference/optimize-presets/revert-to-the-catalog-optimize-preset"}]},{"group":"Destinations","pages":[{"title":"List destinations","deprecated":null,"version":null,"openapi":"/openapi.json get /destinations","href":"/api-reference/destinations/list-destinations"},{"title":"Get a destination","deprecated":null,"version":null,"openapi":"/openapi.json get /destinations/{id}","href":"/api-reference/destinations/get-a-destination"},{"title":"Create a destination","deprecated":null,"version":null,"openapi":"/openapi.json post /destinations","href":"/api-reference/destinations/create-a-destination"},{"title":"Update a destination","deprecated":null,"version":null,"openapi":"/openapi.json patch /destinations/{id}","href":"/api-reference/destinations/update-a-destination"},{"title":"Delete a destination","deprecated":null,"version":null,"openapi":"/openapi.json delete /destinations/{id}","href":"/api-reference/destinations/delete-a-destination"},{"title":"Test a destination","deprecated":null,"version":null,"openapi":"/openapi.json post /destinations/{id}/test","href":"/api-reference/destinations/test-a-destination"}]},{"group":"Products","pages":[{"title":"List product mappings","deprecated":null,"version":null,"openapi":"/openapi.json get /product-maps","href":"/api-reference/products/list-product-mappings"},{"title":"Map a product to a workflow","deprecated":null,"version":null,"openapi":"/openapi.json put /product-maps/{id}","href":"/api-reference/products/map-a-product-to-a-workflow"},{"title":"Unmap a product","deprecated":null,"version":null,"openapi":"/openapi.json delete /product-maps/{id}","href":"/api-reference/products/unmap-a-product"},{"title":"Find products in your store","deprecated":null,"version":null,"openapi":"/openapi.json get /products","href":"/api-reference/products/find-products-in-your-store"}]},{"group":"Settings","pages":[{"title":"Get the storefront settings","deprecated":null,"version":null,"openapi":"/openapi.json get /settings","href":"/api-reference/settings/get-the-storefront-settings"},{"title":"Update the storefront settings","deprecated":null,"version":null,"openapi":"/openapi.json patch /settings","href":"/api-reference/settings/update-the-storefront-settings"}]},{"group":"Webhooks","pages":[{"title":"List webhook events","deprecated":null,"version":null,"openapi":"/openapi.json get /webhook-events","href":"/api-reference/webhooks/list-webhook-events"},{"title":"List webhooks","deprecated":null,"version":null,"openapi":"/openapi.json get /webhooks","href":"/api-reference/webhooks/list-webhooks"},{"title":"Get a webhook","deprecated":null,"version":null,"openapi":"/openapi.json get /webhooks/{id}","href":"/api-reference/webhooks/get-a-webhook"},{"title":"Create a webhook","deprecated":null,"version":null,"openapi":"/openapi.json post /webhooks","href":"/api-reference/webhooks/create-a-webhook"},{"title":"Update a webhook","deprecated":null,"version":null,"openapi":"/openapi.json patch /webhooks/{id}","href":"/api-reference/webhooks/update-a-webhook"},{"title":"Delete a webhook","deprecated":null,"version":null,"openapi":"/openapi.json delete /webhooks/{id}","href":"/api-reference/webhooks/delete-a-webhook"},{"title":"Send a test event","deprecated":null,"version":null,"openapi":"/openapi.json post /webhooks/{id}/test","href":"/api-reference/webhooks/send-a-test-event"}]}]}]},"basePath":"","title":"Create a connector - Filecheck","deploymentId":"dpl_81ettUQ5G7NASN425B6JKU3FX1Rg","buildId":"dpl_81ettUQ5G7NASN425B6JKU3FX1Rg","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-GKHRyhW5.js","utils-CXMoydtj.js","cloneDeep-Cl7CR73B.js","_Uint8Array-7sQhd3aE.js","isObject-FP1Yky1u.js","utils-ABJ_F6Yn.js","addUniqueKeysToSchema-B7v39GOQ.js","snippetPresets-CgibLHmh.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-C2n3VqMC.js","isEqual-BKe3Q7nP.js","usePlaygroundInputsStore-Iji6acs6.js","shallow-Db9K5ulX.js","getApiPlaygroundDisplay-BGnJQBSj.js","CodeSnippet-DlQqWRja.js","CodeSnippets-JF3Bj6-U.js","Page-Ctn-BHcp.js","getPastedJson-B0pIrOza.js","icon-UPBYC1Wr.js","MethodPill-CoVRW5MG.js","DuplicateIcon-BuNnsqwg.js","createIcon-Cj9cJegl.js","DynamicMarkdown-C_R66tyH.js","SectionHeading-C6RB-y9f.js","axios-vUo_bRtp.js","Markdown-g2PbGssl.js","dist-DbZ3bm7k.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","katex-YMM-FMeD.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js","AssistantPageLink-BGnit25E.js"]}