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
A preflight profile: the checks FileCheck runs on an uploaded file, each with its settings (target), how a failure is judged (severity) and whether it is repaired automatically. There are two kinds. A PDF profile (kind omitted or 'pdf') checks PDFs, and vector and office files once converted to PDF; its checks sit in the sections geometry (geom.), color (color.), text (text.), images (image.) and structure (struct.). A raster profile (kind: 'raster') checks image uploads (JPEG, PNG, TIFF and so on) with the single section raster (raster.). An upload rule points at profiles through rule.accepts[].preflight.profileId: pdf, vector and office accepts need a PDF profile, raster accepts a raster profile. A check runs only when both its section's enabled and its own enabled are true; everything omitted is off. Each check has a severity. reject: a failing file is rejected (shown as a warning instead when the upload rule's onFail is not reject). warn: it passes with a warning. ignore: the finding is recorded but never fails or warns. autofix: the customer is told FileCheck repairs it, and the finding is judged as reject when this file is beyond the repair; autofix is accepted only on checks that have a repair (their description says Autofix: …). Repairs run only in workflows with an autofix step, which repairs every failed check that has a repair whatever its severity, so to stop a repair disable the check. Units are in the field names: _mm millimetres, _pt points (1/72 in), _dpi or dpi pixels per inch, percent, _px pixels, _mb megabytes. Unknown check ids, a check in the wrong section and misspelled settings are refused.
sections
object
required
The checks, grouped in sections keyed by section id. PDF profiles: geometry (geom.* checks), color (color.), text (text.), images (image.), structure (struct.) and page_rules (reserved, keep empty). Raster profiles: raster (raster.*). Each section is { enabled, rules: { : { enabled, severity, target, autofixStrategy } } }. To change one setting, PATCH only that path, e.g. { "sections": { "geometry": { "rules": { "geom.bleed.required": { "target": { "required_mm": 3 } } } } } }; when enabling a check, also send its section's enabled: true.
title
string
Name shown in the dashboard and in the profile picker of upload rules, e.g. 'Business cards 85 x 55 mm'. Keep it under 45 characters, the dashboard editor's limit; the dashboard will not save a profile without one.
Required string length: 1 - 120
description
string
default:""
Note for the print shop: what the profile is for. Shown in the dashboard editor of PDF profiles; never shown to customers.
Maximum string length: 2000
kind
enum<string>
conditionally required
'raster' for an image profile; 'pdf' or omitted for a PDF profile. Decides which sections are valid: changing it on an existing profile means replacing its sections too, and upload rules pointing at it must match the new kind.
Available options:
pdf,
raster
metadata
object
Legacy metadata carried by built-in catalog profiles.
Show child attributes
tags
string[]
Free-form labels for your own organisation, e.g. ['business-cards', 'cmyk']. Not shown to customers.
Required string length: 1 - 64
schemaVersion
enum<number>
default:1
Record format version. Always 1.
Available options:
1
Response
OK
profile
Profile · object
A preflight profile: the checks FileCheck runs on an uploaded file, each with its settings (target), how a failure is judged (severity) and whether it is repaired automatically. There are two kinds. A PDF profile (kind omitted or 'pdf') checks PDFs, and vector and office files once converted to PDF; its checks sit in the sections geometry (geom.), color (color.), text (text.), images (image.) and structure (struct.). A raster profile (kind: 'raster') checks image uploads (JPEG, PNG, TIFF and so on) with the single section raster (raster.). An upload rule points at profiles through rule.accepts[].preflight.profileId: pdf, vector and office accepts need a PDF profile, raster accepts a raster profile. A check runs only when both its section's enabled and its own enabled are true; everything omitted is off. Each check has a severity. reject: a failing file is rejected (shown as a warning instead when the upload rule's onFail is not reject). warn: it passes with a warning. ignore: the finding is recorded but never fails or warns. autofix: the customer is told FileCheck repairs it, and the finding is judged as reject when this file is beyond the repair; autofix is accepted only on checks that have a repair (their description says Autofix: …). Repairs run only in workflows with an autofix step, which repairs every failed check that has a repair whatever its severity, so to stop a repair disable the check. Units are in the field names: _mm millimetres, _pt points (1/72 in), _dpi or dpi pixels per inch, percent, _px pixels, _mb megabytes. Unknown check ids, a check in the wrong section and misspelled settings are refused.
{"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/profiles/create-a-preflight-profile","slug":"/api-reference/profiles/create-a-preflight-profile","pageMetadata":{"title":"Create a preflight profile","description":"Creates a preflight profile. Records it points at must exist and be visible to you; a published preflight profile cannot point at a draft.","deprecated":null,"version":null,"openapi":"/openapi.json post /profiles","href":"/api-reference/profiles/create-a-preflight-profile","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 preflight profile. Records it points at must exist and be visible to you; a published preflight profile 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 preflight profile","description":"Creates a preflight profile. Records it points at must exist and be visible to you; a published preflight profile cannot point at a draft.","deprecated":null,"version":null,"openapi":"/openapi.json post /profiles","href":"/api-reference/profiles/create-a-preflight-profile","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/docs/_mintlify/custom/filecheck/6de6adfb358c6d44/ga-consent.js"],"openApiReferenceData":{"operation":{"operationId":"createProfile","tags":["Profiles"],"summary":"Create a preflight profile","description":"Creates a preflight profile. Records it points at must exist and be visible to you; a published preflight profile cannot point at a draft.","parameters":["8146e000-8598-42bb-a68d-c695cb707033","ebbd2832-a8dd-4d3c-b6d1-f5c89e008b00"],"requestBody":"3d2782f2-6477-4224-b847-727ba52f1c37","responses":{"201":"ab6ca90b-675b-45f7-810b-195394daae67","400":"d3072ea2-5e17-42d1-8103-eea56b254fe5","401":"2d9db70e-52cb-4982-a526-d0b62924be86","404":"b478fb88-293d-4489-95de-e5f9fa258ce3","409":"a49b733b-07b3-40c1-9ba5-49326eb707c3"},"method":"post","type":"path","servers":["6d63e939-ba61-4fea-b30e-3ef95173001e"],"security":["4689694c-9868-4609-a20e-356775e7ce2d"],"path":"/profiles","baseUrlOptions":["https://api.filecheck.io"],"title":"Create a preflight profile","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"8146e000-8598-42bb-a68d-c695cb707033":{"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."},"ebbd2832-a8dd-4d3c-b6d1-f5c89e008b00":{"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":{"type":"object","title":"Profile","description":"A preflight profile: the checks FileCheck runs on an uploaded file, each with its settings (target), how a failure is judged (severity) and whether it is repaired automatically. There are two kinds. A PDF profile (kind omitted or 'pdf') checks PDFs, and vector and office files once converted to PDF; its checks sit in the sections geometry (geom.*), color (color.*), text (text.*), images (image.*) and structure (struct.*). A raster profile (kind: 'raster') checks image uploads (JPEG, PNG, TIFF and so on) with the single section raster (raster.*). An upload rule points at profiles through rule.accepts[].preflight.profileId: pdf, vector and office accepts need a PDF profile, raster accepts a raster profile. A check runs only when both its section's enabled and its own enabled are true; everything omitted is off. Each check has a severity. reject: a failing file is rejected (shown as a warning instead when the upload rule's onFail is not reject). warn: it passes with a warning. ignore: the finding is recorded but never fails or warns. autofix: the customer is told FileCheck repairs it, and the finding is judged as reject when this file is beyond the repair; autofix is accepted only on checks that have a repair (their description says Autofix: …). Repairs run only in workflows with an autofix step, which repairs every failed check that has a repair whatever its severity, so to stop a repair disable the check. Units are in the field names: _mm millimetres, _pt points (1/72 in), _dpi or dpi pixels per inch, percent, _px pixels, _mb megabytes. Unknown check ids, a check in the wrong section and misspelled settings are refused.","required":["sections"],"conditionallyRequiredProperties":{"kind":[{},{}]},"properties":{"sections":{"type":"object","description":"The checks, grouped in sections keyed by section id. PDF profiles: geometry (geom.* checks), color (color.*), text (text.*), images (image.*), structure (struct.*) and page_rules (reserved, keep empty). Raster profiles: raster (raster.*). Each section is { enabled, rules: { \u003ccheck id>: { enabled, severity, target, autofixStrategy } } }. To change one setting, PATCH only that path, e.g. { \"sections\": { \"geometry\": { \"rules\": { \"geom.bleed.required\": { \"target\": { \"required_mm\": 3 } } } } } }; when enabling a check, also send its section's enabled: true.","isRequired":true,"uniqueKey":"sections","typeLabel":"object"},"title":{"type":"string","minLength":1,"maxLength":120,"description":"Name shown in the dashboard and in the profile picker of upload rules, e.g. 'Business cards 85 x 55 mm'. Keep it under 45 characters, the dashboard editor's limit; the dashboard will not save a profile without one.","uniqueKey":"title","typeLabel":"string"},"description":{"type":"string","maxLength":2000,"default":"","description":"Note for the print shop: what the profile is for. Shown in the dashboard editor of PDF profiles; never shown to customers.","uniqueKey":"description","typeLabel":"string"},"kind":{"enum":["pdf","raster"],"description":"'raster' for an image profile; 'pdf' or omitted for a PDF profile. Decides which sections are valid: changing it on an existing profile means replacing its sections too, and upload rules pointing at it must match the new kind.","type":"string","conditionalRequirements":[{},{}],"uniqueKey":"kind","typeLabel":"enum\u003cstring>"},"metadata":{"type":"object","additionalProperties":false,"description":"Legacy metadata carried by built-in catalog profiles.","properties":{"kind":{"enum":["pdf","raster"],"description":"Legacy copy of kind. Must agree with kind; 'raster' here without kind: 'raster' is refused because the dashboard would open the profile as a PDF profile and drop its raster checks.","type":"string","uniqueKey":"metadata.kind","typeLabel":"enum\u003cstring>"},"description":{"type":"string","maxLength":2000,"description":"Catalog blurb of built-in profiles; not shown anywhere. Use description instead.","uniqueKey":"metadata.description","typeLabel":"string"}},"uniqueKey":"metadata","typeLabel":"object"},"tags":{"type":"array","items":{"type":"string","minLength":1,"maxLength":64,"uniqueKey":"tags.items.[INDEX]","typeLabel":"string"},"uniqueItems":true,"description":"Free-form labels for your own organisation, e.g. ['business-cards', 'cmyk']. Not shown to customers.","uniqueKey":"tags","typeLabel":"string[]"},"schemaVersion":{"enum":[1],"default":1,"description":"Record format version. Always 1.","type":"number","uniqueKey":"schemaVersion","typeLabel":"enum\u003cnumber>"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"Profile · object"},"examples":{"Example":{"title":"Example","value":{"sections":{},"title":"\u003cstring>","description":"","metadata":{"description":"\u003cstring>"},"tags":["\u003cstring>"],"schemaVersion":1}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"ab6ca90b-675b-45f7-810b-195394daae67":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"profile":{"type":"object","title":"Profile","description":"A preflight profile: the checks FileCheck runs on an uploaded file, each with its settings (target), how a failure is judged (severity) and whether it is repaired automatically. There are two kinds. A PDF profile (kind omitted or 'pdf') checks PDFs, and vector and office files once converted to PDF; its checks sit in the sections geometry (geom.*), color (color.*), text (text.*), images (image.*) and structure (struct.*). A raster profile (kind: 'raster') checks image uploads (JPEG, PNG, TIFF and so on) with the single section raster (raster.*). An upload rule points at profiles through rule.accepts[].preflight.profileId: pdf, vector and office accepts need a PDF profile, raster accepts a raster profile. A check runs only when both its section's enabled and its own enabled are true; everything omitted is off. Each check has a severity. reject: a failing file is rejected (shown as a warning instead when the upload rule's onFail is not reject). warn: it passes with a warning. ignore: the finding is recorded but never fails or warns. autofix: the customer is told FileCheck repairs it, and the finding is judged as reject when this file is beyond the repair; autofix is accepted only on checks that have a repair (their description says Autofix: …). Repairs run only in workflows with an autofix step, which repairs every failed check that has a repair whatever its severity, so to stop a repair disable the check. Units are in the field names: _mm millimetres, _pt points (1/72 in), _dpi or dpi pixels per inch, percent, _px pixels, _mb megabytes. Unknown check ids, a check in the wrong section and misspelled settings are refused.","required":["sections"],"conditionallyRequiredProperties":{"kind":[{},{}]},"properties":{"sections":{"type":"object","description":"The checks, grouped in sections keyed by section id. PDF profiles: geometry (geom.* checks), color (color.*), text (text.*), images (image.*), structure (struct.*) and page_rules (reserved, keep empty). Raster profiles: raster (raster.*). Each section is { enabled, rules: { \u003ccheck id>: { enabled, severity, target, autofixStrategy } } }. To change one setting, PATCH only that path, e.g. { \"sections\": { \"geometry\": { \"rules\": { \"geom.bleed.required\": { \"target\": { \"required_mm\": 3 } } } } } }; when enabling a check, also send its section's enabled: true.","isRequired":true,"uniqueKey":"profile.sections","typeLabel":"object"},"title":{"type":"string","minLength":1,"maxLength":120,"description":"Name shown in the dashboard and in the profile picker of upload rules, e.g. 'Business cards 85 x 55 mm'. Keep it under 45 characters, the dashboard editor's limit; the dashboard will not save a profile without one.","uniqueKey":"profile.title","typeLabel":"string"},"description":{"type":"string","maxLength":2000,"default":"","description":"Note for the print shop: what the profile is for. Shown in the dashboard editor of PDF profiles; never shown to customers.","uniqueKey":"profile.description","typeLabel":"string"},"kind":{"enum":["pdf","raster"],"description":"'raster' for an image profile; 'pdf' or omitted for a PDF profile. Decides which sections are valid: changing it on an existing profile means replacing its sections too, and upload rules pointing at it must match the new kind.","type":"string","conditionalRequirements":[{},{}],"uniqueKey":"profile.kind","typeLabel":"enum\u003cstring>"},"metadata":{"type":"object","additionalProperties":false,"description":"Legacy metadata carried by built-in catalog profiles.","properties":{"kind":{"enum":["pdf","raster"],"description":"Legacy copy of kind. Must agree with kind; 'raster' here without kind: 'raster' is refused because the dashboard would open the profile as a PDF profile and drop its raster checks.","type":"string","uniqueKey":"profile.metadata.kind","typeLabel":"enum\u003cstring>"},"description":{"type":"string","maxLength":2000,"description":"Catalog blurb of built-in profiles; not shown anywhere. Use description instead.","uniqueKey":"profile.metadata.description","typeLabel":"string"}},"uniqueKey":"profile.metadata","typeLabel":"object"},"tags":{"type":"array","items":{"type":"string","minLength":1,"maxLength":64,"uniqueKey":"profile.tags.items.[INDEX]","typeLabel":"string"},"uniqueItems":true,"description":"Free-form labels for your own organisation, e.g. ['business-cards', 'cmyk']. Not shown to customers.","uniqueKey":"profile.tags","typeLabel":"string[]"},"schemaVersion":{"enum":[1],"default":1,"description":"Record format version. Always 1.","type":"number","uniqueKey":"profile.schemaVersion","typeLabel":"enum\u003cnumber>"},"id":{"type":"string","description":"The record id.","uniqueKey":"profile.id","typeLabel":"string"},"source":{"type":"string","enum":["domain","store"],"description":"`domain`: yours. `store`: a built-in catalog record.","uniqueKey":"profile.source","typeLabel":"enum\u003cstring>"},"customized":{"type":"boolean","description":"Your own copy of a built-in record, under the same id. Revert drops it.","uniqueKey":"profile.customized","typeLabel":"boolean"},"draft":{"type":"boolean","description":"Present and true on an unpublished draft.","uniqueKey":"profile.draft","typeLabel":"boolean"},"draftExpiresAt":{"type":"string","format":"date-time","description":"When an unpublished draft is deleted.","uniqueKey":"profile.draftExpiresAt","typeLabel":"string\u003cdate-time>"},"created":{"type":"integer","description":"Unix time (seconds).","uniqueKey":"profile.created","typeLabel":"integer"},"modified":{"type":"integer","description":"Unix time (seconds).","uniqueKey":"profile.modified","typeLabel":"integer"}},"additionalProperties":false,"uniqueKey":"profile","typeLabel":"Profile · object"},"dryRun":{"type":"boolean","description":"Present and true when nothing was saved.","uniqueKey":"dryRun","typeLabel":"boolean"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"profile":{"sections":{},"title":"\u003cstring>","description":"","kind":"pdf","metadata":{"kind":"pdf","description":"\u003cstring>"},"tags":["\u003cstring>"],"schemaVersion":1,"id":"\u003cstring>","source":"domain","customized":true,"draft":true,"draftExpiresAt":"2023-11-07T05:31:56Z","created":123,"modified":123},"dryRun":true}}},"exampleType":"generated"}},"exampleType":"generated"},"d3072ea2-5e17-42d1-8103-eea56b254fe5":{"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"},"2d9db70e-52cb-4982-a526-d0b62924be86":{"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"},"b478fb88-293d-4489-95de-e5f9fa258ce3":{"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"},"a49b733b-07b3-40c1-9ba5-49326eb707c3":{"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 preflight profile - Filecheck","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-11T08:51:31.940Z","originalFileLocation":"api-reference/profiles/create-a-preflight-profile.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 preflight profile. Records it points at must exist and be visible to you; a published preflight profile 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 preflight profile - Filecheck\">\u003cmeta data-mint-head property=\"og:description\" content=\"Creates a preflight profile. Records it points at must exist and be visible to you; a published preflight profile 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/profiles/create-a-preflight-profile\">\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=Profiles\u0026amp;title=Create+a+preflight+profile\u0026amp;description=Creates+a+preflight+profile.+Records+it+points+at+must+exist+and+be+visible+to+you%3B+a+published+preflight+profile+cannot+point+at+a+draft.\u0026amp;theme=2d8b0f160f4bd456e90bb9d1\u0026amp;signature=34cc6617b509ead47293abd94ce4d48814f6857b7a2654ae69f54b8a0ef9ef7e\">\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 preflight profile - Filecheck\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Creates a preflight profile. Records it points at must exist and be visible to you; a published preflight profile cannot point at a draft.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://filecheck.mintlify.site/docs/_mintlify/api/og/v2?division=Profiles\u0026amp;title=Create+a+preflight+profile\u0026amp;description=Creates+a+preflight+profile.+Records+it+points+at+must+exist+and+be+visible+to+you%3B+a+published+preflight+profile+cannot+point+at+a+draft.\u0026amp;theme=2d8b0f160f4bd456e90bb9d1\u0026amp;signature=34cc6617b509ead47293abd94ce4d48814f6857b7a2654ae69f54b8a0ef9ef7e\">\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/profiles/create-a-preflight-profile\">\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/profiles/create-a-preflight-profile.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/profiles/create-a-preflight-profile#webpage\",\"url\":\"https://filecheck.io/docs/api-reference/profiles/create-a-preflight-profile\",\"name\":\"Create a preflight profile\",\"description\":\"Creates a preflight profile. Records it points at must exist and be visible to you; a published preflight profile cannot point at a draft.\",\"dateModified\":\"2026-11-11T08:51:31.940Z\",\"isPartOf\":{\"@id\":\"https://filecheck.io/docs#website\"},\"breadcrumb\":{\"@id\":\"https://filecheck.io/docs/api-reference/profiles/create-a-preflight-profile#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://filecheck.io/docs/api-reference/profiles/create-a-preflight-profile#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Profiles\",\"item\":\"https://filecheck.io/docs/api-reference/profiles/list-preflight-profiles\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create a preflight profile\",\"item\":\"https://filecheck.io/docs/api-reference/profiles/create-a-preflight-profile\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://filecheck.io/docs/api-reference/profiles/create-a-preflight-profile#apireference\",\"headline\":\"Create a preflight profile\",\"name\":\"Create a preflight profile\",\"description\":\"Creates a preflight profile. Records it points at must exist and be visible to you; a published preflight profile cannot point at a draft.\",\"url\":\"https://filecheck.io/docs/api-reference/profiles/create-a-preflight-profile\",\"mainEntityOfPage\":{\"@id\":\"https://filecheck.io/docs/api-reference/profiles/create-a-preflight-profile#webpage\"},\"dateModified\":\"2026-11-11T08:51:31.940Z\",\"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/profiles/create-a-preflight-profile.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","description":"Your preflight profile first, then the built-in catalog. Your drafts are returned too, with `draft: true`.","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","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 preflight profile saves your own copy under the same id (`customized: true`), which you can undo with revert.","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 preflight profile - 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"]}