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
An upload rule (intake rule): the contract for what a customer may upload for one product and how each file is judged at upload time, while the customer waits. A workflow points at exactly one rule through workflow.intake.ruleId, and many workflows can share a rule. For each uploaded file FileCheck detects the real type from the file's bytes, picks the matching entry in accepts (exact MIME type first, then the first entry of the same kind that is not mimeTypesStrict), optionally converts it to PDF, preflights it against the preflight profile that entry names (accepts[].preflight.profileId; profiles hold the checks and thresholds, a rule only points at them), and turns a failing result into reject / accept-with-warnings / manual-review through that entry's onFail. Accepted files then feed the workflow stream for their kind (pdf, raster or other). cardinality says how many files the product needs. A rule does no downstream processing: autofix, optimize, imposition, proofing and delivery are configured on the workflow.
accepts
any[]
required
The file types this product takes, normally one entry per kind (the dashboard allows only one), each with its own MIME list, size limit, PDF conversion, preflight profile and failure policy. For an upload, the first entry whose mimeTypes lists the file's detected MIME type wins; failing that, the first entry of the file's kind that is not mimeTypesStrict. A file no entry matches is refused by the widget when rejectUnknownTypes is true, but one sent through the API is stored unchecked, so cover every kind you expect.
Required array length: 1 - 20 elements
title
string
Name of the rule in the dashboard library and in workflow pickers, e.g. "Business Card — Front & Back". Keep it under 60 characters, the dashboard editor's limit.
Required string length: 1 - 120
description
string
default:""
Note for the print shop's dashboard: which product this rule is for and which profile it pairs with. Never shown to customers.
Maximum string length: 2000
instructions
string
default:""
Short instruction shown to the customer in the upload widget, e.g. "Upload a print-ready PDF with 3 mm bleed on all sides." Plain text only: the widget renders it as HTML in slot mode, so angle brackets are refused.
Maximum string length: 2000
Pattern: ^[^<>]*$
tags
string[]
Free labels for finding the rule in the dashboard library (e.g. "pdf", "business-card"). No effect on uploads.
Maximum array length: 50
Required string length: 1 - 64
schemaVersion
enum<integer>
default:1
Record format version. Always 1.
Available options:
1
cardinality
object
How many files one order of this product needs: either a count range (min and max) or named slots (one labelled upload per slot, e.g. Front and Back). Omit it for exactly one file. A product page can override min and max per order through the job's fileCount context.
Show child attributes
rejectUnknownTypes
boolean
default:true
When true the upload widget refuses files that match no accepts entry; when false it lets them through and they are stored unchecked. Only the widget reads this: files submitted through the API that match no entry are always taken unchecked.
maxTotalSize
integer | null
Intended cap on the combined size of one order's files, in bytes. Stored and shown in the dashboard but not enforced anywhere today; use accepts[].maxSize for a limit that works. Omit or null for none.
Required range: x >= 1
uploadOptional
boolean
default:false
When true a customer who uploads nothing may continue: the widget's checkout gate opens with zero files. Once any file is uploaded, cardinality and onFail apply as usual, and a rejected file still blocks.
channels
enum<string>[]
Reserved for limiting the rule to submission channels (client = the storefront widget, api, admin, store). Not enforced today: leave it empty, which means all channels.
Available options:
client,
api,
admin,
store
ui
object
Look-and-feel overrides for the storefront upload widget while it shows this rule. A key set here overrides the account default and is overridden by the host page; leave a key out to inherit. Never affects which files are accepted.
Show child attributes
Response
OK
rule
Rule · object
An upload rule (intake rule): the contract for what a customer may upload for one product and how each file is judged at upload time, while the customer waits. A workflow points at exactly one rule through workflow.intake.ruleId, and many workflows can share a rule. For each uploaded file FileCheck detects the real type from the file's bytes, picks the matching entry in accepts (exact MIME type first, then the first entry of the same kind that is not mimeTypesStrict), optionally converts it to PDF, preflights it against the preflight profile that entry names (accepts[].preflight.profileId; profiles hold the checks and thresholds, a rule only points at them), and turns a failing result into reject / accept-with-warnings / manual-review through that entry's onFail. Accepted files then feed the workflow stream for their kind (pdf, raster or other). cardinality says how many files the product needs. A rule does no downstream processing: autofix, optimize, imposition, proofing and delivery are configured on the workflow.
{"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":"control","enabled":true,"payload":{"type":"string","value":"control"},"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/rules/create-a-rule","slug":"/api-reference/rules/create-a-rule","pageMetadata":{"title":"Create a rule","description":"Creates a rule. Records it points at must exist and be visible to you; a published rule cannot point at a draft.","deprecated":null,"version":null,"openapi":"/openapi.json post /rules","href":"/api-reference/rules/create-a-rule","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 rule. Records it points at must exist and be visible to you; a published rule 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 rule","description":"Creates a rule. Records it points at must exist and be visible to you; a published rule cannot point at a draft.","deprecated":null,"version":null,"openapi":"/openapi.json post /rules","href":"/api-reference/rules/create-a-rule","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/docs/_mintlify/custom/filecheck/6de6adfb358c6d44/ga-consent.js"],"openApiReferenceData":{"operation":{"operationId":"createRule","tags":["Rules"],"summary":"Create a rule","description":"Creates a rule. Records it points at must exist and be visible to you; a published rule cannot point at a draft.","parameters":["5bdb0b45-cb4c-495c-bc5e-d3bdd571c36f","e650f9d9-3692-4f4c-9b61-8e609047a643"],"requestBody":"16cc66f7-f245-49f5-a8c3-0bb406daa6e2","responses":{"201":"22802d83-9e8d-4ad3-b35a-3a85d76b7e21","400":"335cbac4-cc06-47d9-ba57-f4e396733094","401":"949db5a1-7eb1-49ae-a6f1-6d8cc34b5b8d","404":"afc29e48-1cb9-4604-ae42-6ad890950bee","409":"91b42510-4ba2-485e-843d-79965377e497"},"method":"post","type":"path","servers":["6d63e939-ba61-4fea-b30e-3ef95173001e"],"security":["4689694c-9868-4609-a20e-356775e7ce2d"],"path":"/rules","baseUrlOptions":["https://api.filecheck.io"],"title":"Create a rule","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"5bdb0b45-cb4c-495c-bc5e-d3bdd571c36f":{"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."},"e650f9d9-3692-4f4c-9b61-8e609047a643":{"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":"Rule","description":"An upload rule (intake rule): the contract for what a customer may upload for one product and how each file is judged at upload time, while the customer waits. A workflow points at exactly one rule through workflow.intake.ruleId, and many workflows can share a rule. For each uploaded file FileCheck detects the real type from the file's bytes, picks the matching entry in `accepts` (exact MIME type first, then the first entry of the same kind that is not mimeTypesStrict), optionally converts it to PDF, preflights it against the preflight profile that entry names (accepts[].preflight.profileId; profiles hold the checks and thresholds, a rule only points at them), and turns a failing result into reject / accept-with-warnings / manual-review through that entry's onFail. Accepted files then feed the workflow stream for their kind (pdf, raster or other). `cardinality` says how many files the product needs. A rule does no downstream processing: autofix, optimize, imposition, proofing and delivery are configured on the workflow.","type":"object","additionalProperties":false,"required":["accepts"],"properties":{"accepts":{"type":"array","minItems":1,"maxItems":20,"items":{"type":"any","uniqueKey":"accepts.items.[INDEX]","typeLabel":"any"},"description":"The file types this product takes, normally one entry per kind (the dashboard allows only one), each with its own MIME list, size limit, PDF conversion, preflight profile and failure policy. For an upload, the first entry whose mimeTypes lists the file's detected MIME type wins; failing that, the first entry of the file's kind that is not mimeTypesStrict. A file no entry matches is refused by the widget when rejectUnknownTypes is true, but one sent through the API is stored unchecked, so cover every kind you expect.","isRequired":true,"uniqueKey":"accepts","typeLabel":"any[]"},"title":{"type":"string","minLength":1,"maxLength":120,"description":"Name of the rule in the dashboard library and in workflow pickers, e.g. \"Business Card — Front \u0026 Back\". Keep it under 60 characters, the dashboard editor's limit.","uniqueKey":"title","typeLabel":"string"},"description":{"type":"string","maxLength":2000,"default":"","description":"Note for the print shop's dashboard: which product this rule is for and which profile it pairs with. Never shown to customers.","uniqueKey":"description","typeLabel":"string"},"instructions":{"type":"string","maxLength":2000,"pattern":"^[^\u003c>]*$","default":"","description":"Short instruction shown to the customer in the upload widget, e.g. \"Upload a print-ready PDF with 3 mm bleed on all sides.\" Plain text only: the widget renders it as HTML in slot mode, so angle brackets are refused.","uniqueKey":"instructions","typeLabel":"string"},"tags":{"type":"array","items":{"type":"string","minLength":1,"maxLength":64,"uniqueKey":"tags.items.[INDEX]","typeLabel":"string"},"uniqueItems":true,"maxItems":50,"default":[],"description":"Free labels for finding the rule in the dashboard library (e.g. \"pdf\", \"business-card\"). No effect on uploads.","uniqueKey":"tags","typeLabel":"string[]"},"schemaVersion":{"type":"integer","enum":[1],"default":1,"description":"Record format version. Always 1.","uniqueKey":"schemaVersion","typeLabel":"enum\u003cinteger>"},"cardinality":{"type":"object","additionalProperties":false,"default":{"min":1,"max":1,"slots":[]},"description":"How many files one order of this product needs: either a count range (min and max) or named slots (one labelled upload per slot, e.g. Front and Back). Omit it for exactly one file. A product page can override min and max per order through the job's fileCount context.","properties":{"min":{"type":"integer","minimum":0,"description":"Fewest accepted files before the job leaves intake and the widget lets the customer continue. Required unless slots are set (then ignored). To let a customer skip uploading altogether use uploadOptional; min 0 alone does not do that.","conditionalRequirements":[{}],"uniqueKey":"cardinality.min","typeLabel":"integer"},"max":{"type":"integer","minimum":1,"description":"Most files the customer may upload; the widget stops offering uploads at this count. Must be at least min (not checked here: with max below min the widget can never be satisfied). Required unless slots are set (then ignored). There is no unlimited value, because the widget reads a missing max as 1, so set a generous number such as 50.","conditionalRequirements":[{}],"uniqueKey":"cardinality.max","typeLabel":"integer"},"slots":{"type":"array","items":{"type":"string","minLength":1,"maxLength":80,"uniqueKey":"cardinality.slots.items.[INDEX]","typeLabel":"string"},"uniqueItems":true,"maxItems":50,"default":[],"description":"Named upload slots in order, e.g. [\"Front\", \"Back\"]. When non-empty the customer gets one labelled upload area per slot, exactly that many files are required, min and max are ignored, and each file keeps its slot name (proofs are shown in slot order). Empty means count-range mode.","uniqueKey":"cardinality.slots","typeLabel":"string[]"}},"conditionallyRequiredProperties":{"min":[{}],"max":[{}]},"uniqueKey":"cardinality","typeLabel":"object"},"rejectUnknownTypes":{"type":"boolean","default":true,"description":"When true the upload widget refuses files that match no accepts entry; when false it lets them through and they are stored unchecked. Only the widget reads this: files submitted through the API that match no entry are always taken unchecked.","uniqueKey":"rejectUnknownTypes","typeLabel":"boolean"},"maxTotalSize":{"oneOf":[{"type":"integer","minimum":1,"default":null,"description":"Intended cap on the combined size of one order's files, in bytes. Stored and shown in the dashboard but not enforced anywhere today; use accepts[].maxSize for a limit that works. Omit or null for none.","uniqueKey":"maxTotalSize.oneOf.0","typeLabel":"integer"},{"type":"null","minimum":1,"default":null,"description":"Intended cap on the combined size of one order's files, in bytes. Stored and shown in the dashboard but not enforced anywhere today; use accepts[].maxSize for a limit that works. Omit or null for none.","uniqueKey":"maxTotalSize.oneOf.1","typeLabel":"null"}],"uniqueKey":"maxTotalSize","typeLabel":"integer | null"},"uploadOptional":{"type":"boolean","default":false,"description":"When true a customer who uploads nothing may continue: the widget's checkout gate opens with zero files. Once any file is uploaded, cardinality and onFail apply as usual, and a rejected file still blocks.","uniqueKey":"uploadOptional","typeLabel":"boolean"},"channels":{"type":"array","items":{"type":"string","enum":["client","api","admin","store"],"uniqueKey":"channels.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueItems":true,"default":[],"description":"Reserved for limiting the rule to submission channels (client = the storefront widget, api, admin, store). Not enforced today: leave it empty, which means all channels.","uniqueKey":"channels","typeLabel":"enum\u003cstring>[]"},"ui":{"type":"object","additionalProperties":false,"default":{},"description":"Look-and-feel overrides for the storefront upload widget while it shows this rule. A key set here overrides the account default and is overridden by the host page; leave a key out to inherit. Never affects which files are accepted.","properties":{"title":{"type":"string","maxLength":120,"description":"Heading shown at the top of the widget.","uniqueKey":"ui.title","typeLabel":"string"},"subtitle":{"type":"string","maxLength":240,"description":"Smaller line under the title.","uniqueKey":"ui.subtitle","typeLabel":"string"},"theme":{"type":"string","enum":["light","dark","system"],"description":"Colour scheme: light, dark, or system (follow the shopper's device setting).","uniqueKey":"ui.theme","typeLabel":"enum\u003cstring>"},"accent":{"oneOf":[{"type":"string","maxLength":64,"description":"Accent colour override, e.g. #0a7cff; null inherits the account's brand colour.","uniqueKey":"ui.accent.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":64,"description":"Accent colour override, e.g. #0a7cff; null inherits the account's brand colour.","uniqueKey":"ui.accent.oneOf.1","typeLabel":"null"}],"uniqueKey":"ui.accent","typeLabel":"string | null"},"locale":{"oneOf":[{"type":"string","pattern":"^[A-Za-z]{2,3}(-[A-Za-z0-9]{2,8})*$","description":"BCP-47 language tag for the widget's text, e.g. de or fr-CA; null follows the host page.","uniqueKey":"ui.locale.oneOf.0","typeLabel":"string"},{"type":"null","pattern":"^[A-Za-z]{2,3}(-[A-Za-z0-9]{2,8})*$","description":"BCP-47 language tag for the widget's text, e.g. de or fr-CA; null follows the host page.","uniqueKey":"ui.locale.oneOf.1","typeLabel":"null"}],"uniqueKey":"ui.locale","typeLabel":"string | null"},"layout":{"type":"string","enum":["inline","modal","drawer","compact"],"description":"Hint to the host page's SDK on how to present the widget.","uniqueKey":"ui.layout","typeLabel":"enum\u003cstring>"},"showHeader":{"type":"boolean","description":"Show the title and subtitle block.","uniqueKey":"ui.showHeader","typeLabel":"boolean"},"showHelp":{"type":"boolean","description":"Show the help area with helpText.","uniqueKey":"ui.showHelp","typeLabel":"boolean"},"helpText":{"type":"string","maxLength":2000,"description":"Help text shown when showHelp is true.","uniqueKey":"ui.helpText","typeLabel":"string"},"submitLabel":{"type":"string","maxLength":60,"description":"Label for the host page's continue button once the upload is ready (the host renders the button).","uniqueKey":"ui.submitLabel","typeLabel":"string"},"autoSubmit":{"type":"boolean","description":"When true the host page moves on by itself as soon as the upload is ready, without a click.","uniqueKey":"ui.autoSubmit","typeLabel":"boolean"},"branding":{"type":"string","enum":["domain","none","custom"],"description":"Which branding the widget shows: the account's (domain), none, or custom.","uniqueKey":"ui.branding","typeLabel":"enum\u003cstring>"},"resultsDisplay":{"type":"string","enum":["full","list"],"description":"full shows each file's findings inline; list shows a compact, selectable file list for pairing with a separate report element.","uniqueKey":"ui.resultsDisplay","typeLabel":"enum\u003cstring>"},"proofDetails":{"type":"string","enum":["collapsed","expanded"],"description":"How the proof dialog opens: collapsed (the print first, findings behind a summary button) or expanded (findings panel open).","uniqueKey":"ui.proofDetails","typeLabel":"enum\u003cstring>"}},"uniqueKey":"ui","typeLabel":"object"}},"definitions":{"mimeType":{"type":"string","maxLength":127,"pattern":"^[a-z0-9][a-z0-9!#$\u0026^_.+-]*/[a-z0-9][a-z0-9!#$\u0026^_.+-]*$","description":"A lowercase MIME type exactly as FileCheck's detection reports it, e.g. application/pdf, image/jpeg (never image/jpg), image/tiff (never image/tif)."},"accept":{"type":"object","additionalProperties":false,"required":["kind"],"description":"One accepted file kind: which files it matches and how each one is checked and judged on upload.","properties":{"kind":{"type":"string","enum":["pdf","raster","vector","office","archive","other"],"description":"The file family this entry handles, matched against the type FileCheck detects from the bytes. pdf: PDF (and PDF-based .ai). raster: JPEG, PNG, TIFF, WebP, HEIC, AVIF, GIF, BMP. vector: SVG, EPS/PostScript. office: Word, Excel, PowerPoint and OpenDocument files. archive: ZIP. other: fonts and anything else. Only pdf and raster can be preflighted as uploaded; vector and office need convertToPdf first; archive and other are stored as-is with no checks."},"mimeTypes":{"type":"array","items":{"$ref":"#/components/schemas/Rule/definitions/mimeType"},"uniqueItems":true,"maxItems":50,"default":[],"description":"MIME types this entry claims; each must belong to the entry's kind. Unless mimeTypesStrict is true the list does not narrow anything: every file of the kind is still accepted through the kind fallback and the widget offers the whole kind. For kind other the list is the only way the widget recognises a file, so it must not be empty."},"mimeTypesStrict":{"type":"boolean","default":false,"description":"When true the mimeTypes list is authoritative: a file of this kind whose MIME type is not listed is refused, by the widget and by the server, e.g. raster with [\"image/jpeg\", \"image/tiff\"] refuses PNG. Leave false to take every file of the kind. Needs a non-empty mimeTypes."},"extensions":{"type":"array","items":{"type":"string","pattern":"^\\.?[a-z0-9]{1,10}$"},"uniqueItems":true,"maxItems":50,"default":[],"description":"File extensions for display, lowercase with a leading dot, e.g. [\".pdf\"]. Informational only: nothing matches uploads by extension, and the widget builds its file picker from mimeTypes."},"maxSize":{"type":["integer","null"],"minimum":1,"default":null,"description":"Largest single file this entry takes, in bytes (50 MB = 52428800). Enforced by the upload widget before upload; files sent through the API are not checked against it. Omit or null for no limit."},"convertToPdf":{"type":"boolean","default":false,"description":"Vector and office entries only: convert each upload to PDF on arrival, so it can be preflighted against a PDF profile and feeds the workflow's pdf stream. Without it these files are stored as-is and feed the other stream. Must be false for pdf, raster, archive and other entries."},"preflight":{"type":"object","additionalProperties":false,"required":["enabled"],"default":{"enabled":false,"profileId":null},"description":"The check run on each file of this entry while the customer waits. Off unless enabled is sent as true, and then it needs a profileId. Possible for pdf and raster entries, and for vector and office entries with convertToPdf true; never for archive or other.","properties":{"enabled":{"type":"boolean","description":"Run the preflight check. Send it explicitly; with false the file is accepted without a check."},"profileId":{"type":["string","null"],"minLength":1,"maxLength":128,"default":null,"description":"What to check against: the id of a preflight profile record (from GET /profiles, usually profile_...), or a built-in conformance validation: 1a, 1b, 2a, 2b, 2u, 3a, 3b, 3u, 4, 4e, 4f (PDF/A) or ua1, ua2 (PDF/UA). The profile's kind must match the entry: pdf entries, and vector or office entries with convertToPdf, take a PDF profile or a validation id; raster entries take a raster profile. Required when enabled; ignored when not."}},"if":{"properties":{"enabled":{"const":true}},"required":["enabled"]},"then":{"required":["profileId"],"properties":{"profileId":{"type":"string"}}}},"onFail":{"type":"string","enum":["reject","accept_with_warnings","manual_review"],"default":"reject","description":"What a failing preflight (or a failed PDF conversion) means for the file. reject: not accepted; the widget blocks the customer until they replace it and the job waits at intake. accept_with_warnings: accepted anyway; the profile's reject-level findings show as warnings and the workflow goes ahead. manual_review: the widget lets the customer continue and marks the file as awaiting review with findings as warnings, but the server does not count the file as accepted, so the workflow waits at intake until the print shop deals with it. A file FileCheck cannot open is rejected under every policy."}},"allOf":[{"if":{"properties":{"kind":{"enum":["pdf","raster","archive","other"]}},"required":["kind"]},"then":{"properties":{"convertToPdf":{"const":false}}}},{"if":{"properties":{"kind":{"enum":["archive","other"]}},"required":["kind"]},"then":{"properties":{"preflight":{"properties":{"enabled":{"const":false}}}}}},{"if":{"properties":{"kind":{"enum":["vector","office"]},"preflight":{"properties":{"enabled":{"const":true}},"required":["enabled"]}},"required":["kind","preflight"]},"then":{"required":["convertToPdf"],"properties":{"convertToPdf":{"const":true}}}},{"if":{"properties":{"kind":{"const":"raster"}},"required":["kind"]},"then":{"properties":{"preflight":{"properties":{"profileId":{"pattern":"^(?!(1a|1b|2a|2b|2u|3a|3b|3u|4|4e|4f|ua1|ua2)$)"}}}}}},{"if":{"properties":{"mimeTypesStrict":{"const":true}},"required":["mimeTypesStrict"]},"then":{"required":["mimeTypes"],"properties":{"mimeTypes":{"minItems":1}}}},{"if":{"properties":{"kind":{"const":"pdf"}},"required":["kind"]},"then":{"properties":{"mimeTypes":{"items":{"const":"application/pdf"}}}}},{"if":{"properties":{"kind":{"const":"raster"}},"required":["kind"]},"then":{"properties":{"mimeTypes":{"items":{"pattern":"^image/(?!svg)(?!jpg$)(?!tif$)"}}}}},{"if":{"properties":{"kind":{"const":"vector"}},"required":["kind"]},"then":{"properties":{"mimeTypes":{"items":{"enum":["image/svg+xml","application/postscript","application/eps","application/illustrator"]}}}}},{"if":{"properties":{"kind":{"const":"office"}},"required":["kind"]},"then":{"properties":{"mimeTypes":{"items":{"pattern":"^application/(msword|vnd\\.ms-excel|vnd\\.ms-powerpoint|vnd\\.openxmlformats-officedocument\\.[a-z0-9.+-]+|vnd\\.oasis\\.opendocument\\.[a-z0-9.+-]+)$"}}}}},{"if":{"properties":{"kind":{"const":"archive"}},"required":["kind"]},"then":{"properties":{"mimeTypes":{"items":{"enum":["application/zip","application/x-zip-compressed","application/x-tar","application/gzip","application/x-gzip","application/x-7z-compressed","application/vnd.rar","application/x-rar-compressed"]}}}}},{"if":{"properties":{"kind":{"const":"other"}},"required":["kind"]},"then":{"required":["mimeTypes"],"properties":{"mimeTypes":{"minItems":1,"items":{"pattern":"^(?!application/pdf$)(?!image/)(?!application/postscript$)(?!application/eps$)"}}}}}]}},"uniqueKey":"","typeLabel":"Rule · object"},"examples":{"Example":{"title":"Example","value":{"accepts":["\u003cunknown>"],"title":"\u003cstring>","description":"","instructions":"","tags":[],"schemaVersion":1,"cardinality":{"min":1,"max":1,"slots":[]},"rejectUnknownTypes":true,"maxTotalSize":null,"uploadOptional":false,"channels":[],"ui":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"22802d83-9e8d-4ad3-b35a-3a85d76b7e21":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"rule":{"type":"object","title":"Rule","description":"An upload rule (intake rule): the contract for what a customer may upload for one product and how each file is judged at upload time, while the customer waits. A workflow points at exactly one rule through workflow.intake.ruleId, and many workflows can share a rule. For each uploaded file FileCheck detects the real type from the file's bytes, picks the matching entry in `accepts` (exact MIME type first, then the first entry of the same kind that is not mimeTypesStrict), optionally converts it to PDF, preflights it against the preflight profile that entry names (accepts[].preflight.profileId; profiles hold the checks and thresholds, a rule only points at them), and turns a failing result into reject / accept-with-warnings / manual-review through that entry's onFail. Accepted files then feed the workflow stream for their kind (pdf, raster or other). `cardinality` says how many files the product needs. A rule does no downstream processing: autofix, optimize, imposition, proofing and delivery are configured on the workflow.","required":["accepts"],"properties":{"accepts":{"type":"array","minItems":1,"maxItems":20,"items":{"type":"any","uniqueKey":"rule.accepts.items.[INDEX]","typeLabel":"any"},"description":"The file types this product takes, normally one entry per kind (the dashboard allows only one), each with its own MIME list, size limit, PDF conversion, preflight profile and failure policy. For an upload, the first entry whose mimeTypes lists the file's detected MIME type wins; failing that, the first entry of the file's kind that is not mimeTypesStrict. A file no entry matches is refused by the widget when rejectUnknownTypes is true, but one sent through the API is stored unchecked, so cover every kind you expect.","isRequired":true,"uniqueKey":"rule.accepts","typeLabel":"any[]"},"title":{"type":"string","minLength":1,"maxLength":120,"description":"Name of the rule in the dashboard library and in workflow pickers, e.g. \"Business Card — Front \u0026 Back\". Keep it under 60 characters, the dashboard editor's limit.","uniqueKey":"rule.title","typeLabel":"string"},"description":{"type":"string","maxLength":2000,"default":"","description":"Note for the print shop's dashboard: which product this rule is for and which profile it pairs with. Never shown to customers.","uniqueKey":"rule.description","typeLabel":"string"},"instructions":{"type":"string","maxLength":2000,"pattern":"^[^\u003c>]*$","default":"","description":"Short instruction shown to the customer in the upload widget, e.g. \"Upload a print-ready PDF with 3 mm bleed on all sides.\" Plain text only: the widget renders it as HTML in slot mode, so angle brackets are refused.","uniqueKey":"rule.instructions","typeLabel":"string"},"tags":{"type":"array","items":{"type":"string","minLength":1,"maxLength":64,"uniqueKey":"rule.tags.items.[INDEX]","typeLabel":"string"},"uniqueItems":true,"maxItems":50,"default":[],"description":"Free labels for finding the rule in the dashboard library (e.g. \"pdf\", \"business-card\"). No effect on uploads.","uniqueKey":"rule.tags","typeLabel":"string[]"},"schemaVersion":{"type":"integer","enum":[1],"default":1,"description":"Record format version. Always 1.","uniqueKey":"rule.schemaVersion","typeLabel":"enum\u003cinteger>"},"cardinality":{"type":"object","additionalProperties":false,"default":{"min":1,"max":1,"slots":[]},"description":"How many files one order of this product needs: either a count range (min and max) or named slots (one labelled upload per slot, e.g. Front and Back). Omit it for exactly one file. A product page can override min and max per order through the job's fileCount context.","properties":{"min":{"type":"integer","minimum":0,"description":"Fewest accepted files before the job leaves intake and the widget lets the customer continue. Required unless slots are set (then ignored). To let a customer skip uploading altogether use uploadOptional; min 0 alone does not do that.","conditionalRequirements":[{}],"uniqueKey":"rule.cardinality.min","typeLabel":"integer"},"max":{"type":"integer","minimum":1,"description":"Most files the customer may upload; the widget stops offering uploads at this count. Must be at least min (not checked here: with max below min the widget can never be satisfied). Required unless slots are set (then ignored). There is no unlimited value, because the widget reads a missing max as 1, so set a generous number such as 50.","conditionalRequirements":[{}],"uniqueKey":"rule.cardinality.max","typeLabel":"integer"},"slots":{"type":"array","items":{"type":"string","minLength":1,"maxLength":80,"uniqueKey":"rule.cardinality.slots.items.[INDEX]","typeLabel":"string"},"uniqueItems":true,"maxItems":50,"default":[],"description":"Named upload slots in order, e.g. [\"Front\", \"Back\"]. When non-empty the customer gets one labelled upload area per slot, exactly that many files are required, min and max are ignored, and each file keeps its slot name (proofs are shown in slot order). Empty means count-range mode.","uniqueKey":"rule.cardinality.slots","typeLabel":"string[]"}},"conditionallyRequiredProperties":{"min":[{}],"max":[{}]},"uniqueKey":"rule.cardinality","typeLabel":"object"},"rejectUnknownTypes":{"type":"boolean","default":true,"description":"When true the upload widget refuses files that match no accepts entry; when false it lets them through and they are stored unchecked. Only the widget reads this: files submitted through the API that match no entry are always taken unchecked.","uniqueKey":"rule.rejectUnknownTypes","typeLabel":"boolean"},"maxTotalSize":{"oneOf":[{"type":"integer","minimum":1,"default":null,"description":"Intended cap on the combined size of one order's files, in bytes. Stored and shown in the dashboard but not enforced anywhere today; use accepts[].maxSize for a limit that works. Omit or null for none.","uniqueKey":"rule.maxTotalSize.oneOf.0","typeLabel":"integer"},{"type":"null","minimum":1,"default":null,"description":"Intended cap on the combined size of one order's files, in bytes. Stored and shown in the dashboard but not enforced anywhere today; use accepts[].maxSize for a limit that works. Omit or null for none.","uniqueKey":"rule.maxTotalSize.oneOf.1","typeLabel":"null"}],"uniqueKey":"rule.maxTotalSize","typeLabel":"integer | null"},"uploadOptional":{"type":"boolean","default":false,"description":"When true a customer who uploads nothing may continue: the widget's checkout gate opens with zero files. Once any file is uploaded, cardinality and onFail apply as usual, and a rejected file still blocks.","uniqueKey":"rule.uploadOptional","typeLabel":"boolean"},"channels":{"type":"array","items":{"type":"string","enum":["client","api","admin","store"],"uniqueKey":"rule.channels.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueItems":true,"default":[],"description":"Reserved for limiting the rule to submission channels (client = the storefront widget, api, admin, store). Not enforced today: leave it empty, which means all channels.","uniqueKey":"rule.channels","typeLabel":"enum\u003cstring>[]"},"ui":{"type":"object","additionalProperties":false,"default":{},"description":"Look-and-feel overrides for the storefront upload widget while it shows this rule. A key set here overrides the account default and is overridden by the host page; leave a key out to inherit. Never affects which files are accepted.","properties":{"title":{"type":"string","maxLength":120,"description":"Heading shown at the top of the widget.","uniqueKey":"rule.ui.title","typeLabel":"string"},"subtitle":{"type":"string","maxLength":240,"description":"Smaller line under the title.","uniqueKey":"rule.ui.subtitle","typeLabel":"string"},"theme":{"type":"string","enum":["light","dark","system"],"description":"Colour scheme: light, dark, or system (follow the shopper's device setting).","uniqueKey":"rule.ui.theme","typeLabel":"enum\u003cstring>"},"accent":{"oneOf":[{"type":"string","maxLength":64,"description":"Accent colour override, e.g. #0a7cff; null inherits the account's brand colour.","uniqueKey":"rule.ui.accent.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":64,"description":"Accent colour override, e.g. #0a7cff; null inherits the account's brand colour.","uniqueKey":"rule.ui.accent.oneOf.1","typeLabel":"null"}],"uniqueKey":"rule.ui.accent","typeLabel":"string | null"},"locale":{"oneOf":[{"type":"string","pattern":"^[A-Za-z]{2,3}(-[A-Za-z0-9]{2,8})*$","description":"BCP-47 language tag for the widget's text, e.g. de or fr-CA; null follows the host page.","uniqueKey":"rule.ui.locale.oneOf.0","typeLabel":"string"},{"type":"null","pattern":"^[A-Za-z]{2,3}(-[A-Za-z0-9]{2,8})*$","description":"BCP-47 language tag for the widget's text, e.g. de or fr-CA; null follows the host page.","uniqueKey":"rule.ui.locale.oneOf.1","typeLabel":"null"}],"uniqueKey":"rule.ui.locale","typeLabel":"string | null"},"layout":{"type":"string","enum":["inline","modal","drawer","compact"],"description":"Hint to the host page's SDK on how to present the widget.","uniqueKey":"rule.ui.layout","typeLabel":"enum\u003cstring>"},"showHeader":{"type":"boolean","description":"Show the title and subtitle block.","uniqueKey":"rule.ui.showHeader","typeLabel":"boolean"},"showHelp":{"type":"boolean","description":"Show the help area with helpText.","uniqueKey":"rule.ui.showHelp","typeLabel":"boolean"},"helpText":{"type":"string","maxLength":2000,"description":"Help text shown when showHelp is true.","uniqueKey":"rule.ui.helpText","typeLabel":"string"},"submitLabel":{"type":"string","maxLength":60,"description":"Label for the host page's continue button once the upload is ready (the host renders the button).","uniqueKey":"rule.ui.submitLabel","typeLabel":"string"},"autoSubmit":{"type":"boolean","description":"When true the host page moves on by itself as soon as the upload is ready, without a click.","uniqueKey":"rule.ui.autoSubmit","typeLabel":"boolean"},"branding":{"type":"string","enum":["domain","none","custom"],"description":"Which branding the widget shows: the account's (domain), none, or custom.","uniqueKey":"rule.ui.branding","typeLabel":"enum\u003cstring>"},"resultsDisplay":{"type":"string","enum":["full","list"],"description":"full shows each file's findings inline; list shows a compact, selectable file list for pairing with a separate report element.","uniqueKey":"rule.ui.resultsDisplay","typeLabel":"enum\u003cstring>"},"proofDetails":{"type":"string","enum":["collapsed","expanded"],"description":"How the proof dialog opens: collapsed (the print first, findings behind a summary button) or expanded (findings panel open).","uniqueKey":"rule.ui.proofDetails","typeLabel":"enum\u003cstring>"}},"uniqueKey":"rule.ui","typeLabel":"object"},"id":{"type":"string","description":"The record id.","uniqueKey":"rule.id","typeLabel":"string"},"source":{"type":"string","enum":["domain","store"],"description":"`domain`: yours. `store`: a built-in catalog record.","uniqueKey":"rule.source","typeLabel":"enum\u003cstring>"},"customized":{"type":"boolean","description":"Your own copy of a built-in record, under the same id. Revert drops it.","uniqueKey":"rule.customized","typeLabel":"boolean"},"draft":{"type":"boolean","description":"Present and true on an unpublished draft.","uniqueKey":"rule.draft","typeLabel":"boolean"},"draftExpiresAt":{"type":"string","format":"date-time","description":"When an unpublished draft is deleted.","uniqueKey":"rule.draftExpiresAt","typeLabel":"string\u003cdate-time>"},"created":{"type":"integer","description":"Unix time (seconds).","uniqueKey":"rule.created","typeLabel":"integer"},"modified":{"type":"integer","description":"Unix time (seconds).","uniqueKey":"rule.modified","typeLabel":"integer"}},"additionalProperties":false,"uniqueKey":"rule","typeLabel":"Rule · object"},"dryRun":{"type":"boolean","description":"Present and true when nothing was saved.","uniqueKey":"dryRun","typeLabel":"boolean"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"rule":{"accepts":["\u003cunknown>"],"title":"\u003cstring>","description":"","instructions":"","tags":[],"schemaVersion":1,"cardinality":{"min":1,"max":1,"slots":[]},"rejectUnknownTypes":true,"maxTotalSize":null,"uploadOptional":false,"channels":[],"ui":{},"id":"\u003cstring>","source":"domain","customized":true,"draft":true,"draftExpiresAt":"2023-11-07T05:31:56Z","created":123,"modified":123},"dryRun":true}}},"exampleType":"generated"}},"exampleType":"generated"},"335cbac4-cc06-47d9-ba57-f4e396733094":{"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"},"949db5a1-7eb1-49ae-a6f1-6d8cc34b5b8d":{"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"},"afc29e48-1cb9-4604-ae42-6ad890950bee":{"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"},"91b42510-4ba2-485e-843d-79965377e497":{"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 rule - Filecheck","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-11T08:51:31.791Z","originalFileLocation":"api-reference/rules/create-a-rule.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 rule. Records it points at must exist and be visible to you; a published rule 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 rule - Filecheck\">\u003cmeta data-mint-head property=\"og:description\" content=\"Creates a rule. Records it points at must exist and be visible to you; a published rule 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/rules/create-a-rule\">\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=Rules\u0026amp;title=Create+a+rule\u0026amp;description=Creates+a+rule.+Records+it+points+at+must+exist+and+be+visible+to+you%3B+a+published+rule+cannot+point+at+a+draft.\u0026amp;theme=2d8b0f160f4bd456e90bb9d1\u0026amp;signature=4a363d4136c81b17cc951cb3ac46b00bf57ded03759010c0524f03645b81b540\">\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 rule - Filecheck\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Creates a rule. Records it points at must exist and be visible to you; a published rule cannot point at a draft.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://filecheck.mintlify.site/docs/_mintlify/api/og/v2?division=Rules\u0026amp;title=Create+a+rule\u0026amp;description=Creates+a+rule.+Records+it+points+at+must+exist+and+be+visible+to+you%3B+a+published+rule+cannot+point+at+a+draft.\u0026amp;theme=2d8b0f160f4bd456e90bb9d1\u0026amp;signature=4a363d4136c81b17cc951cb3ac46b00bf57ded03759010c0524f03645b81b540\">\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/rules/create-a-rule\">\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/rules/create-a-rule.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/rules/create-a-rule#webpage\",\"url\":\"https://filecheck.io/docs/api-reference/rules/create-a-rule\",\"name\":\"Create a rule\",\"description\":\"Creates a rule. Records it points at must exist and be visible to you; a published rule cannot point at a draft.\",\"dateModified\":\"2026-11-11T08:51:31.791Z\",\"isPartOf\":{\"@id\":\"https://filecheck.io/docs#website\"},\"breadcrumb\":{\"@id\":\"https://filecheck.io/docs/api-reference/rules/create-a-rule#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://filecheck.io/docs/api-reference/rules/create-a-rule#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Rules\",\"item\":\"https://filecheck.io/docs/api-reference/rules/list-rules\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create a rule\",\"item\":\"https://filecheck.io/docs/api-reference/rules/create-a-rule\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://filecheck.io/docs/api-reference/rules/create-a-rule#apireference\",\"headline\":\"Create a rule\",\"name\":\"Create a rule\",\"description\":\"Creates a rule. Records it points at must exist and be visible to you; a published rule cannot point at a draft.\",\"url\":\"https://filecheck.io/docs/api-reference/rules/create-a-rule\",\"mainEntityOfPage\":{\"@id\":\"https://filecheck.io/docs/api-reference/rules/create-a-rule#webpage\"},\"dateModified\":\"2026-11-11T08:51:31.791Z\",\"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/rules/create-a-rule.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","description":"Your rule first, then the built-in catalog. Your drafts are returned too, with `draft: true`.","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","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 rule saves your own copy under the same id (`customized: true`), which you can undo with revert.","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","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","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 rule - 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"]}