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 workflow saves your own copy under the same id (customized: true), which you can undo with revert.
Your secret key as a bearer token, e.g. Authorization: Bearer sk_live_…. Secret keys are server-side only.
Path Parameters
id
string
required
The workflow id.
Query Parameters
dryRun
boolean
default:false
Validate and check references without saving: the response shows the record as it would be saved.
Body
application/json
A workflow is the fulfilment pipeline for a product: what happens to a customer's upload from the moment it is dropped on the product page until the print-ready file reaches the shop. Intake runs first, while the customer waits: it points at an upload rule (which file kinds, how many files or slots, and per kind the preflight profile that checks them and whether a failing file is rejected). When the trigger fires (order placed, upload accepted, proof approved or a manual run), each accepted file runs the stream for its kind (autofix, convert an image to PDF, optimize with a preset, split pages); then merge can combine the files, and delivery sends the result to the account's destinations. Proofing optionally shows the customer a soft proof at the end of intake, and can hold the job until they approve it. Rules, preflight profiles, optimize presets, destinations and scenes are separate records referenced by id; product mappings and the embedded upload widget point at a workflow by its id. A job copies the workflow when it is created; jobs that already hold files keep the version they started with. A minimal create body is { "title", "intake": { "ruleId" } } plus one stream per file kind the rule accepts; without streams files are delivered as they left intake.
intake
object
required
The upload stage. Runs for every uploaded file as soon as it arrives, whatever the trigger: checks the file against the upload rule and its preflight profile, and makes the soft proof when proofing is enabled.
Show child attributes
schemaVersion
enum<integer>
default:1
Version of this record format. Always 1; can be left out.
Available options:
1
title
string
Name shown in the dashboard, usually the product it serves (for example "Business cards 85 × 55 mm"). The dashboard's title editor takes up to 40 characters and will not save a workflow without one.
Minimum string length: 1
description
string
default:""
Internal note shown under the title in the dashboard. Customers never see it.
tags
string[]
Free-form labels for organising workflows (the spec importer adds "imported" and the product type). No effect on processing.
trigger
enum<string>
default:order_placed
When processing after intake (streams, then merge and delivery) starts for a job whose files have passed intake. Until it fires, nothing after intake runs. "order_placed" (default): when the customer checks out in a connected cart and the order is linked to the job; the customer can still replace files until then, so use it on product pages. "on_accept": immediately, once the job holds enough accepted files for the rule's minimum file count; files are locked from then on. "proof_approval": when the customer approves the soft proof in the upload widget; needs proofing.enabled true. "manual": only when someone runs the job from the dashboard. Any job can also be run manually from the dashboard whatever its trigger.
Available options:
order_placed,
on_accept,
proof_approval,
manual
streams
object[]
Per-file processing that runs after the trigger fires, one stream per file kind. After intake every accepted file is routed by kind: PDFs, and vector or office files the rule converts to PDF, go to the "pdf" stream; images go to the "raster" stream; anything else goes to "other". Add a stream for each kind the upload rule accepts, at most one per kind. A file whose kind has no stream is not processed and is delivered as it left intake. Named slots (Front, Back, …) do not get streams of their own: every file of a kind runs the same steps. Default [] (no processing).
Maximum array length: 3
Show child attributes
merge
object
What happens to the job's files once every file has finished its stream. Runs once per job; a merged file replaces the individual files in delivery and in the job's deliverables (downloads, GET /jobs/{id}).
Show child attributes
finalize
array
Reserved for steps after merge (imposition, export). None are implemented, so it must be empty.
proofing
object
requirediftrigger=proof_approval
Soft proof: a colour-managed preview of each uploaded file, drawn on the print sheet with bleed and cut marks and showing the fixes autofix will make, shown to the customer in the upload widget at the end of intake. With trigger "proof_approval" the job waits until the customer approves it; with any other trigger it is for information only.
Show child attributes
optionSet
object
Customer-facing option fields (paper, sides, quantity and so on) meant to be shown next to the upload. Reserved: nothing reads it yet; the upload widget does not show it and jobs ignore it. Leave it disabled; product options belong in the store.
Show child attributes
delivery
object
Where the finished print files go when a job completes successfully (after streams and merge). Every destination receives the job's final files: the merged PDF or ZIP when merge made one, otherwise each file as its stream left it (the original upload when no step changed it). Jobs that end in error are not delivered.
Show child attributes
ui
object
Display settings for the dashboard and the upload widget. Free-form: unknown keys are kept as they are.
Show child attributes
Response
OK
workflow
Workflow · object
A workflow is the fulfilment pipeline for a product: what happens to a customer's upload from the moment it is dropped on the product page until the print-ready file reaches the shop. Intake runs first, while the customer waits: it points at an upload rule (which file kinds, how many files or slots, and per kind the preflight profile that checks them and whether a failing file is rejected). When the trigger fires (order placed, upload accepted, proof approved or a manual run), each accepted file runs the stream for its kind (autofix, convert an image to PDF, optimize with a preset, split pages); then merge can combine the files, and delivery sends the result to the account's destinations. Proofing optionally shows the customer a soft proof at the end of intake, and can hold the job until they approve it. Rules, preflight profiles, optimize presets, destinations and scenes are separate records referenced by id; product mappings and the embedded upload widget point at a workflow by its id. A job copies the workflow when it is created; jobs that already hold files keep the version they started with. A minimal create body is { "title", "intake": { "ruleId" } } plus one stream per file kind the rule accepts; without streams files are delivered as they left intake.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Filecheck","colors":{"primary":"#1F5BFF","light":"#6088FF","dark":"#1747CC"},"logo":{"light":"https://mintcdn.com/filecheck/rNybgOKFlLbMhWeh/logo/light.svg?fit=max\u0026auto=format\u0026n=rNybgOKFlLbMhWeh\u0026q=85\u0026s=7bc29281132ca05b5217412db9e93fb8","dark":"https://mintcdn.com/filecheck/rNybgOKFlLbMhWeh/logo/dark.svg?fit=max\u0026auto=format\u0026n=rNybgOKFlLbMhWeh\u0026q=85\u0026s=e5a15a223efa144fa97287b4b96c0236"},"favicon":"https://mintcdn.com/filecheck/rNybgOKFlLbMhWeh/favicon.svg?fit=max\u0026auto=format\u0026n=rNybgOKFlLbMhWeh\u0026q=85\u0026s=1ca0b6f62da3e8005a37cf842f98f9c3","background":{"color":{"light":"#FFFFFF","dark":"#090B1A"}},"navbar":{"links":[{"href":"https://filecheck.io","label":"Website"}],"primary":{"type":"button","label":"Dashboard","href":"https://admin.filecheck.io"}},"footer":{"socials":{"x":"https://x.com/filecheckio","linkedin":"https://linkedin.com/company/filecheckio"},"links":[{"header":"Trust","items":[{"label":"Security and GDPR","href":"https://filecheck.io/security"},{"label":"Data Processing Agreement","href":"https://filecheck.io/company/dpa"},{"label":"Privacy policy","href":"https://filecheck.io/company/privacy"}]}]},"contextual":{"options":["copy","view","download-spec","chatgpt","claude"],"display":"header"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Demos","icon":"play","href":"https://filecheck.io/demos"},{"anchor":"Support","icon":"envelope","href":"mailto:support@filecheck.io"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"filecheck","hasAudioNarration":false,"actualSubdomain":"filecheck","customDomains":["filecheck.io"],"gitSource":{"type":"github","owner":"sterlyai","repo":"mintlify-docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"feedback":{"issues":true,"edits":true},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6afb44fbe515a9eaa9c00b6e","clientVersion":"0.0.4177","searchFilterCounts":[{"language":"default","tag":"API reference","count":68},{"language":"default","tag":"Documentation","count":34},{"language":"default","tag":"Developers","count":22},{"language":"default","tag":"Admin guide","count":15},{"language":"default","tag":"Jobs","count":9},{"language":"default","tag":"Preflight Profiles","count":8},{"language":"default","tag":"The Element","count":7},{"language":"default","tag":"Connectors","count":7},{"language":"default","tag":"Optimize presets","count":7},{"language":"default","tag":"Profiles","count":7}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"/docs","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"privacy":{"consentBanner":{"enabled":false}},"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/workflows/update-a-workflow","slug":"/api-reference/workflows/update-a-workflow","pageMetadata":{"title":"Update a workflow","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 workflow saves your own copy under the same id (`customized: true`), which you can undo with revert.","deprecated":null,"version":null,"openapi":"/openapi.json patch /workflows/{id}","href":"/api-reference/workflows/update-a-workflow","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"A JSON Merge Patch (RFC 7396): send only what changes. Objects merge key by key, \", _jsx(_components.code, {\n children: \"null\"\n }), \" removes a key, arrays replace the whole list. Patching a catalog workflow saves your own copy under the same id (\", _jsx(_components.code, {\n children: \"customized: true\"\n }), \"), which you can undo with revert.\"]\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":"Update a workflow","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 workflow saves your own copy under the same id (`customized: true`), which you can undo with revert.","deprecated":null,"version":null,"openapi":"/openapi.json patch /workflows/{id}","href":"/api-reference/workflows/update-a-workflow","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/docs/_mintlify/custom/filecheck/6de6adfb358c6d44/ga-consent.js"],"openApiReferenceData":{"operation":{"operationId":"updateWorkflow","tags":["Workflows"],"summary":"Update a workflow","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 workflow saves your own copy under the same id (`customized: true`), which you can undo with revert.","parameters":["ba13453b-df96-4e17-a216-c0aab135e1e5","532ade53-547d-411d-971c-d42f3ac96f9e"],"requestBody":"052ed76f-be5f-456a-9311-8392aaa58d81","responses":{"200":"103ec5f0-8b3f-4d67-9887-1a891f5fd60b","400":"9517f825-22d3-4b9b-bfdf-b32e7e7577cd","401":"6578cf4e-5015-4110-ba40-377584e84ff6","404":"31d19006-7e84-48cd-a5f1-c4a9149c558d","409":"8a2c27fe-a743-46d4-94f2-cc4847ed1d9e"},"method":"patch","type":"path","servers":["6d63e939-ba61-4fea-b30e-3ef95173001e"],"security":["4689694c-9868-4609-a20e-356775e7ce2d"],"path":"/workflows/{id}","baseUrlOptions":["https://api.filecheck.io"],"title":"Update a workflow","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"ba13453b-df96-4e17-a216-c0aab135e1e5":{"name":"id","in":"path","required":true,"schema":{"type":"string","isRequired":true,"description":"The workflow id.","uniqueKey":"","typeLabel":"string"},"description":"The workflow id."},"532ade53-547d-411d-971c-d42f3ac96f9e":{"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":"Workflow","description":"A workflow is the fulfilment pipeline for a product: what happens to a customer's upload from the moment it is dropped on the product page until the print-ready file reaches the shop. Intake runs first, while the customer waits: it points at an upload rule (which file kinds, how many files or slots, and per kind the preflight profile that checks them and whether a failing file is rejected). When the trigger fires (order placed, upload accepted, proof approved or a manual run), each accepted file runs the stream for its kind (autofix, convert an image to PDF, optimize with a preset, split pages); then merge can combine the files, and delivery sends the result to the account's destinations. Proofing optionally shows the customer a soft proof at the end of intake, and can hold the job until they approve it. Rules, preflight profiles, optimize presets, destinations and scenes are separate records referenced by id; product mappings and the embedded upload widget point at a workflow by its id. A job copies the workflow when it is created; jobs that already hold files keep the version they started with. A minimal create body is { \"title\", \"intake\": { \"ruleId\" } } plus one stream per file kind the rule accepts; without streams files are delivered as they left intake.","required":["intake"],"conditionallyRequiredProperties":{"proofing":[{"when":[[{"property":"trigger","values":["proof_approval"]}]]}]},"properties":{"intake":{"type":"object","additionalProperties":false,"required":["ruleId"],"description":"The upload stage. Runs for every uploaded file as soon as it arrives, whatever the trigger: checks the file against the upload rule and its preflight profile, and makes the soft proof when proofing is enabled.","properties":{"ruleId":{"type":"string","minLength":1,"description":"Id of the upload rule (GET /rules): the accepted file kinds and MIME types, the number of files or named slots, and per kind the preflight profile and onFail policy that decides whether a failing file is rejected. The upload widget will not load a workflow without a rule. The rule's accepted kinds decide which streams this workflow needs.","isRequired":true,"uniqueKey":"intake.ruleId","typeLabel":"string"},"onError":{"type":"string","enum":["halt"],"default":"halt","description":"Stored for the dashboard and not read by the pipeline: whether a failing file blocks the job is set per kind by the rule's onFail. Only \"halt\" is accepted.","uniqueKey":"intake.onError","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","enum":[true],"default":true,"description":"Intake always runs and cannot be switched off. Always true.","uniqueKey":"intake.enabled","typeLabel":"enum\u003cboolean>"}},"isRequired":true,"uniqueKey":"intake","typeLabel":"object"},"schemaVersion":{"type":"integer","enum":[1],"default":1,"description":"Version of this record format. Always 1; can be left out.","uniqueKey":"schemaVersion","typeLabel":"enum\u003cinteger>"},"title":{"type":"string","minLength":1,"description":"Name shown in the dashboard, usually the product it serves (for example \"Business cards 85 × 55 mm\"). The dashboard's title editor takes up to 40 characters and will not save a workflow without one.","uniqueKey":"title","typeLabel":"string"},"description":{"type":"string","default":"","description":"Internal note shown under the title in the dashboard. Customers never see it.","uniqueKey":"description","typeLabel":"string"},"tags":{"type":"array","items":{"type":"string","uniqueKey":"tags.items.[INDEX]","typeLabel":"string"},"default":[],"description":"Free-form labels for organising workflows (the spec importer adds \"imported\" and the product type). No effect on processing.","uniqueKey":"tags","typeLabel":"string[]"},"trigger":{"type":"string","enum":["order_placed","on_accept","proof_approval","manual"],"default":"order_placed","description":"When processing after intake (streams, then merge and delivery) starts for a job whose files have passed intake. Until it fires, nothing after intake runs. \"order_placed\" (default): when the customer checks out in a connected cart and the order is linked to the job; the customer can still replace files until then, so use it on product pages. \"on_accept\": immediately, once the job holds enough accepted files for the rule's minimum file count; files are locked from then on. \"proof_approval\": when the customer approves the soft proof in the upload widget; needs proofing.enabled true. \"manual\": only when someone runs the job from the dashboard. Any job can also be run manually from the dashboard whatever its trigger.","uniqueKey":"trigger","typeLabel":"enum\u003cstring>"},"streams":{"type":"array","items":{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["pdf","raster","other"],"description":"The file kind this stream processes, after intake: \"pdf\" for PDF uploads and for vector or office files the rule converts to PDF at intake (accept entry convertToPdf true); \"raster\" for JPEG, PNG, TIFF and other images; \"other\" for everything else (archives, fonts, vector or office files kept as they are), which no step can process.","isRequired":true,"uniqueKey":"streams.items.[INDEX].kind","typeLabel":"enum\u003cstring>"},"steps":{"type":"array","default":[],"items":{"type":"object","required":["type"],"conditionallyRequiredProperties":{"config":[{}]},"properties":{"type":{"type":"string","enum":["autofix","convert","optimize","split_pages"],"description":"What the step does. \"autofix\": applies the fixes the intake preflight planned for this file (the profile checks with severity \"autofix\": add bleed, convert to CMYK, upscale low-resolution images and so on); it is skipped when intake ran no preflight or found nothing to fix. If the upload rule already autofixes at intake (accept entry autofix on, without repreflight), keep this step disabled or the same fixes are applied a second time. \"convert\" (raster stream only): places the image on a new PDF page sized by config.dimension. \"optimize\": runs an optimize preset (config.presetId) over the PDF; on the raster stream it needs an enabled convert step before it, since it works on the converted PDF. \"split_pages\" (pdf stream only): writes one single-page PDF per page as extra outputs; the file that is delivered and downloaded stays the unsplit PDF.","isRequired":true,"uniqueKey":"streams.items.[INDEX].steps.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","default":true,"description":"false keeps the step and its settings in the workflow without running it. The dashboard lists every allowed step for a stream and switches them on and off this way.","uniqueKey":"streams.items.[INDEX].steps.items.[INDEX].enabled","typeLabel":"boolean"},"onError":{"type":"string","enum":["halt","continue"],"default":"halt","description":"What a crash in this step does. \"halt\" (default): the file ends in error, which puts the whole job in error, so nothing is merged or delivered. \"continue\": the failure is recorded as a warning on the file and the job carries on with the file as it was before this step.","uniqueKey":"streams.items.[INDEX].steps.items.[INDEX].onError","typeLabel":"enum\u003cstring>"},"config":{"type":"object","default":{},"description":"Settings for this step type: autofix {}, convert { format, dimension, outputIntent, dpi }, optimize { presetId }, split_pages {}.","conditionalRequirements":[{}],"uniqueKey":"streams.items.[INDEX].steps.items.[INDEX].config","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"streams.items.[INDEX].steps.items.[INDEX]","typeLabel":"object"},"description":"Steps run on each file of this kind, in this order, each on the previous step's output. Allowed types, in the order they must appear: pdf: autofix, optimize, split_pages. raster: autofix, convert, optimize. other: none. Each type at most once; leaving types out is fine. An empty list, or one with no enabled step, means files of this kind are delivered as they left intake.","uniqueKey":"streams.items.[INDEX].steps","typeLabel":"object[]"}},"additionalProperties":false,"uniqueKey":"streams.items.[INDEX]","typeLabel":"object"},"description":"Per-file processing that runs after the trigger fires, one stream per file kind. After intake every accepted file is routed by kind: PDFs, and vector or office files the rule converts to PDF, go to the \"pdf\" stream; images go to the \"raster\" stream; anything else goes to \"other\". Add a stream for each kind the upload rule accepts, at most one per kind. A file whose kind has no stream is not processed and is delivered as it left intake. Named slots (Front, Back, …) do not get streams of their own: every file of a kind runs the same steps. Default [] (no processing).","default":[],"maxItems":3,"uniqueKey":"streams","typeLabel":"object[]"},"merge":{"type":"object","description":"What happens to the job's files once every file has finished its stream. Runs once per job; a merged file replaces the individual files in delivery and in the job's deliverables (downloads, GET /jobs/{id}).","default":{"mode":"none","config":{},"onError":"halt","enabled":true},"properties":{"mode":{"type":"string","enum":["none","merge_pdf","zip"],"default":"none","description":"\"none\" (default): files stay separate and are delivered one by one. \"merge_pdf\": all of the job's files are concatenated into one PDF in the order they were added to the job (slot names such as Front/Back do not affect the order); needs at least two files, and every file must be a PDF by the end of its stream, so the raster stream needs an enabled convert step and there must be no \"other\" stream. A merge that fails stops the job before its webhook and delivery. \"zip\": all files are bundled into one ZIP archive.","uniqueKey":"merge.mode","typeLabel":"enum\u003cstring>"},"config":{"type":"object","default":{},"description":"Mode settings: none {}, merge_pdf { order }, zip { names, order, zipName }.","uniqueKey":"merge.config","typeLabel":"object"},"onError":{"type":"string","enum":["halt"],"default":"halt","description":"Stored for the dashboard; a failed merge always stops the job before delivery. Only \"halt\" is accepted.","uniqueKey":"merge.onError","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","default":true,"description":"false skips the merge whatever the mode. Default true.","uniqueKey":"merge.enabled","typeLabel":"boolean"}},"additionalProperties":false,"uniqueKey":"merge","typeLabel":"object"},"finalize":{"type":"array","maxItems":0,"default":[],"description":"Reserved for steps after merge (imposition, export). None are implemented, so it must be empty.","uniqueKey":"finalize","typeLabel":"array"},"proofing":{"type":"object","additionalProperties":false,"default":{"enabled":false,"type":"basic","timing":"after_intake","requireApproval":true,"config":{},"previewer":{"kind":"pages"}},"description":"Soft proof: a colour-managed preview of each uploaded file, drawn on the print sheet with bleed and cut marks and showing the fixes autofix will make, shown to the customer in the upload widget at the end of intake. With trigger \"proof_approval\" the job waits until the customer approves it; with any other trigger it is for information only.","properties":{"id":{"type":"string","description":"Opaque id the dashboard stamps on this block. Optional; no effect.","uniqueKey":"proofing.id","typeLabel":"string"},"enabled":{"type":"boolean","default":false,"description":"Make a proof of every file at the end of intake. Default false. Must be true when trigger is \"proof_approval\".","uniqueKey":"proofing.enabled","typeLabel":"boolean"},"type":{"type":"string","enum":["basic"],"default":"basic","description":"Proof style. Only \"basic\" (rendered page previews) exists.","uniqueKey":"proofing.type","typeLabel":"enum\u003cstring>"},"timing":{"type":"string","enum":["after_intake"],"default":"after_intake","description":"When the proof is made. Only \"after_intake\" is implemented: after the file passes intake, before the trigger fires. Later points (after streams, after merge) are reserved and would produce no proof.","uniqueKey":"proofing.timing","typeLabel":"enum\u003cstring>"},"requireApproval":{"type":"boolean","default":true,"description":"Informational only: whether the job waits for the customer's approval is decided by trigger \"proof_approval\", not by this flag.","uniqueKey":"proofing.requireApproval","typeLabel":"boolean"},"previewer":{"type":"object","description":"What the customer approves on: the flat pages, or the proofed pages shown on a product scene.","default":{"kind":"pages"},"required":["kind"],"conditionallyRequiredProperties":{"sceneId":[{"when":[[{"property":"kind","values":["scene"]}]]}]},"properties":{"kind":{"type":"string","enum":["pages","scene"],"default":"pages","description":"\"pages\" (default): flat page previews. \"scene\": the proofed pages shown on the 3D model, folded leaflet or booklet named by sceneId.","isRequired":true,"uniqueKey":"proofing.previewer.kind","typeLabel":"enum\u003cstring>"},"sceneId":{"type":"string","minLength":1,"description":"Id of a scene from the scene library (the account's own or the built-in catalog): a 3D model, fold or flipbook the proofed pages are wrapped onto. Required when kind is \"scene\"; not allowed with \"pages\".","conditionalRequirements":[{"when":[[{"property":"kind","values":["scene"]}]]}],"uniqueKey":"proofing.previewer.sceneId","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"proofing.previewer","typeLabel":"object"},"config":{"type":"object","additionalProperties":false,"default":{},"description":"Advanced overrides for the proof render. Normally empty: the sheet, bleed and colour profile are inferred from the stream's optimize preset (pdf) or convert dimension (raster), falling back to the intake preflight profile.","properties":{"iccProfile":{"type":"string","enum":["fogra51","fogra52","gracol2013","swop2013","fogra39","iso-coated-v2","iso-coated-v2-300","gracol2006","swop","fogra29","japan-coated","japan-uncoated","psr-lwc","psr-snp","srgb","adobe-rgb","display-p3","greyscale","cmyk-fogra29.icc","cmyk-fogra39.icc","cmyk-fogra51.icc","cmyk-fogra52.icc","cmyk-gracol2006.icc","cmyk-gracol2013.icc","cmyk-iso-coated-v2-300.icc","cmyk-iso-coated-v2.icc","cmyk-japan-coated.icc","cmyk-japan-uncoated.icc","cmyk-psr-lwc.icc","cmyk-psr-snp.icc","cmyk-swop-v2.icc","cmyk-swop2013.icc","gray-sgray.icc","rgb-adobe-1998.icc","rgb-display-p3.icc","rgb-srgb.icc","cmyk-fogra29","cmyk-fogra39","cmyk-fogra51","cmyk-fogra52","cmyk-gracol2006","cmyk-gracol2013","cmyk-iso-coated-v2-300","cmyk-iso-coated-v2","cmyk-japan-coated","cmyk-japan-uncoated","cmyk-psr-lwc","cmyk-psr-snp","cmyk-swop-v2","cmyk-swop2013","gray-sgray","rgb-adobe-1998","rgb-display-p3","rgb-srgb"],"description":"Printing condition the proof simulates, replacing the inferred one: an alias such as \"fogra39\", \"fogra51\", \"gracol2013\", \"swop2013\", \"srgb\" or \"greyscale\", or a bundled ICC file name.","uniqueKey":"proofing.config.iccProfile","typeLabel":"enum\u003cstring>"},"format":{"type":"string","enum":["webp","jpeg","png"],"description":"Image format of the proof pages. Default \"webp\".","uniqueKey":"proofing.config.format","typeLabel":"enum\u003cstring>"},"quality":{"type":"integer","minimum":1,"maximum":100,"description":"Compression quality of the proof images, 1 to 100. Default 91.","uniqueKey":"proofing.config.quality","typeLabel":"integer"},"maxEdge":{"type":"integer","minimum":1,"description":"Longest side of a proof image in pixels. Default 1200.","uniqueKey":"proofing.config.maxEdge","typeLabel":"integer"},"sheet":{"type":"object","additionalProperties":false,"required":["size"],"description":"Advanced: the print sheet each proof page is drawn on, replacing the inferred one (from the optimize preset's page size and bleed on the pdf stream, the convert dimension on the raster stream, else the preflight profile's page size and bleed). Omit unless the inference is wrong.","properties":{"size":{"type":"object","additionalProperties":false,"required":["width","height"],"description":"Finished (trim) size of the sheet.","properties":{"width":{"type":"number","exclusiveMinimum":0,"description":"Trim width in millimetres.","isRequired":true,"uniqueKey":"proofing.config.sheet.size.width","typeLabel":"number"},"height":{"type":"number","exclusiveMinimum":0,"description":"Trim height in millimetres.","isRequired":true,"uniqueKey":"proofing.config.sheet.size.height","typeLabel":"number"},"unit":{"type":"string","enum":["mm"],"default":"mm","description":"Always millimetres.","uniqueKey":"proofing.config.sheet.size.unit","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"proofing.config.sheet.size","typeLabel":"object"},"sizes":{"type":"array","minItems":1,"items":{"type":"object","additionalProperties":false,"required":["width_mm","height_mm"],"properties":{"width_mm":{"type":"number","exclusiveMinimum":0,"description":"Trim width in millimetres.","isRequired":true,"uniqueKey":"proofing.config.sheet.sizes.items.[INDEX].width_mm","typeLabel":"number"},"height_mm":{"type":"number","exclusiveMinimum":0,"description":"Trim height in millimetres.","isRequired":true,"uniqueKey":"proofing.config.sheet.sizes.items.[INDEX].height_mm","typeLabel":"number"}},"uniqueKey":"proofing.config.sheet.sizes.items.[INDEX]","typeLabel":"object"},"description":"For products sold in several sizes: each page is proofed on the listed size nearest to it instead of on size.","uniqueKey":"proofing.config.sheet.sizes","typeLabel":"object[]"},"bleed":{"type":"number","minimum":0,"description":"Bleed shown around the trim, in millimetres. Default 0.","uniqueKey":"proofing.config.sheet.bleed","typeLabel":"number"},"safeZone":{"type":"number","minimum":0,"description":"Safety margin drawn inside the trim, in millimetres. Default 0.","uniqueKey":"proofing.config.sheet.safeZone","typeLabel":"number"},"fitTo":{"type":"string","enum":["trim","media"],"description":"Fit the artwork to the trim (default) or to the full sheet including bleed.","uniqueKey":"proofing.config.sheet.fitTo","typeLabel":"enum\u003cstring>"},"fit":{"type":"string","enum":["contain","cover"],"description":"\"contain\" (default) shows the whole artwork inside the trim; \"cover\" fills the trim and crops the overflow.","uniqueKey":"proofing.config.sheet.fit","typeLabel":"enum\u003cstring>"},"dpi":{"type":"integer","minimum":1,"description":"Render resolution of the sheet in pixels per inch. Default 150; targetEdge wins when both are set.","uniqueKey":"proofing.config.sheet.dpi","typeLabel":"integer"},"targetEdge":{"type":"integer","minimum":1,"description":"Longest side of the rendered sheet in pixels, bleed included. Inferred sheets use 1200.","uniqueKey":"proofing.config.sheet.targetEdge","typeLabel":"integer"},"cutMarks":{"type":"boolean","description":"Draw corner cut marks and the dashed trim line. Default true.","uniqueKey":"proofing.config.sheet.cutMarks","typeLabel":"boolean"},"watermark":{"type":"boolean","description":"Overlay a \"proof\" watermark band. Default false for a sheet given here (inferred sheets ask for one); it can also be switched off platform-wide.","uniqueKey":"proofing.config.sheet.watermark","typeLabel":"boolean"},"background":{"type":"string","pattern":"^#[0-9A-Fa-f]{6}$","description":"Sheet background colour as #rrggbb. Default #ffffff.","uniqueKey":"proofing.config.sheet.background","typeLabel":"string"},"matchOrientation":{"type":"boolean","description":"Turn the sheet to the artwork's orientation. Default true.","uniqueKey":"proofing.config.sheet.matchOrientation","typeLabel":"boolean"}},"uniqueKey":"proofing.config.sheet","typeLabel":"object"}},"uniqueKey":"proofing.config","typeLabel":"object"},"tags":{"type":"array","items":{"type":"string","uniqueKey":"proofing.tags.items.[INDEX]","typeLabel":"string"},"default":[],"description":"Free-form labels. No effect.","uniqueKey":"proofing.tags","typeLabel":"string[]"}},"conditionalRequirements":[{"when":[[{"property":"trigger","values":["proof_approval"]}]]}],"uniqueKey":"proofing","typeLabel":"object"},"optionSet":{"type":"object","additionalProperties":false,"default":{"enabled":false,"title":"","description":"","fields":[],"config":{}},"description":"Customer-facing option fields (paper, sides, quantity and so on) meant to be shown next to the upload. Reserved: nothing reads it yet; the upload widget does not show it and jobs ignore it. Leave it disabled; product options belong in the store.","properties":{"id":{"type":"string","description":"Opaque id the dashboard stamps on this block. Optional; no effect.","uniqueKey":"optionSet.id","typeLabel":"string"},"enabled":{"type":"boolean","default":false,"description":"Has no effect yet. Default false.","uniqueKey":"optionSet.enabled","typeLabel":"boolean"},"title":{"type":"string","default":"","description":"Heading above the fields.","uniqueKey":"optionSet.title","typeLabel":"string"},"description":{"type":"string","default":"","description":"Text under the heading.","uniqueKey":"optionSet.description","typeLabel":"string"},"fields":{"type":"array","default":[],"items":{"type":"object","additionalProperties":false,"required":["key","type"],"properties":{"key":{"type":"string","minLength":1,"description":"Stable identifier, unique within the option set; dependsOn refers to it.","isRequired":true,"uniqueKey":"optionSet.fields.items.[INDEX].key","typeLabel":"string"},"type":{"type":"string","enum":["select","radio","swatch","sides","binding","grommet","toggle","number","text","note"],"description":"Widget: select (dropdown), radio, swatch, sides, binding, grommet, toggle, number, text, or note (read-only text).","isRequired":true,"uniqueKey":"optionSet.fields.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"label":{"type":"string","description":"Label shown to the customer.","uniqueKey":"optionSet.fields.items.[INDEX].label","typeLabel":"string"},"help":{"type":"string","description":"Helper text under the field.","uniqueKey":"optionSet.fields.items.[INDEX].help","typeLabel":"string"},"required":{"type":"boolean","description":"The customer must answer it.","uniqueKey":"optionSet.fields.items.[INDEX].required","typeLabel":"boolean"},"default":{"description":"Pre-selected value.","uniqueKey":"optionSet.fields.items.[INDEX].default","typeLabel":"any"},"choices":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["value"],"properties":{"value":{"oneOf":[{"type":"string","description":"Value recorded when the customer picks this choice.","isRequired":true,"uniqueKey":"optionSet.fields.items.[INDEX].choices.items.[INDEX].value.oneOf.0","typeLabel":"string"},{"type":"number","description":"Value recorded when the customer picks this choice.","isRequired":true,"uniqueKey":"optionSet.fields.items.[INDEX].choices.items.[INDEX].value.oneOf.1","typeLabel":"number"},{"type":"boolean","description":"Value recorded when the customer picks this choice.","isRequired":true,"uniqueKey":"optionSet.fields.items.[INDEX].choices.items.[INDEX].value.oneOf.2","typeLabel":"boolean"}],"isRequired":true,"uniqueKey":"optionSet.fields.items.[INDEX].choices.items.[INDEX].value","typeLabel":"string | number | boolean"},"label":{"type":"string","description":"Text shown for the choice. Defaults to the value.","uniqueKey":"optionSet.fields.items.[INDEX].choices.items.[INDEX].label","typeLabel":"string"},"swatch":{"oneOf":[{"type":"string","description":"Colour or material swatch for swatch fields.","uniqueKey":"optionSet.fields.items.[INDEX].choices.items.[INDEX].swatch.oneOf.0","typeLabel":"string"},{"type":"null","description":"Colour or material swatch for swatch fields.","uniqueKey":"optionSet.fields.items.[INDEX].choices.items.[INDEX].swatch.oneOf.1","typeLabel":"null"}],"uniqueKey":"optionSet.fields.items.[INDEX].choices.items.[INDEX].swatch","typeLabel":"string | null"},"thumb":{"oneOf":[{"type":"string","description":"Thumbnail image URL.","uniqueKey":"optionSet.fields.items.[INDEX].choices.items.[INDEX].thumb.oneOf.0","typeLabel":"string"},{"type":"null","description":"Thumbnail image URL.","uniqueKey":"optionSet.fields.items.[INDEX].choices.items.[INDEX].thumb.oneOf.1","typeLabel":"null"}],"uniqueKey":"optionSet.fields.items.[INDEX].choices.items.[INDEX].thumb","typeLabel":"string | null"},"priceHint":{"oneOf":[{"type":"string","description":"Cosmetic price note such as \"+€2.00\"; never used to price anything.","uniqueKey":"optionSet.fields.items.[INDEX].choices.items.[INDEX].priceHint.oneOf.0","typeLabel":"string"},{"type":"null","description":"Cosmetic price note such as \"+€2.00\"; never used to price anything.","uniqueKey":"optionSet.fields.items.[INDEX].choices.items.[INDEX].priceHint.oneOf.1","typeLabel":"null"}],"uniqueKey":"optionSet.fields.items.[INDEX].choices.items.[INDEX].priceHint","typeLabel":"string | null"},"config":{"type":"object","description":"Free-form widget settings for this choice; any keys.","uniqueKey":"optionSet.fields.items.[INDEX].choices.items.[INDEX].config","typeLabel":"object"}},"uniqueKey":"optionSet.fields.items.[INDEX].choices.items.[INDEX]","typeLabel":"object"},"description":"Choices for select, radio, swatch, sides, binding and grommet fields.","uniqueKey":"optionSet.fields.items.[INDEX].choices","typeLabel":"object[]"},"min":{"oneOf":[{"type":"number","description":"Smallest value for number fields.","uniqueKey":"optionSet.fields.items.[INDEX].min.oneOf.0","typeLabel":"number"},{"type":"null","description":"Smallest value for number fields.","uniqueKey":"optionSet.fields.items.[INDEX].min.oneOf.1","typeLabel":"null"}],"uniqueKey":"optionSet.fields.items.[INDEX].min","typeLabel":"number | null"},"max":{"oneOf":[{"type":"number","description":"Largest value for number fields.","uniqueKey":"optionSet.fields.items.[INDEX].max.oneOf.0","typeLabel":"number"},{"type":"null","description":"Largest value for number fields.","uniqueKey":"optionSet.fields.items.[INDEX].max.oneOf.1","typeLabel":"null"}],"uniqueKey":"optionSet.fields.items.[INDEX].max","typeLabel":"number | null"},"step":{"oneOf":[{"type":"number","description":"Increment for number fields.","uniqueKey":"optionSet.fields.items.[INDEX].step.oneOf.0","typeLabel":"number"},{"type":"null","description":"Increment for number fields.","uniqueKey":"optionSet.fields.items.[INDEX].step.oneOf.1","typeLabel":"null"}],"uniqueKey":"optionSet.fields.items.[INDEX].step","typeLabel":"number | null"},"unit":{"type":"string","description":"Unit label shown next to the value, such as \"copies\" or \"mm\".","uniqueKey":"optionSet.fields.items.[INDEX].unit","typeLabel":"string"},"dependsOn":{"oneOf":[{"type":"object","additionalProperties":false,"required":["key"],"properties":{"key":{"type":"string","minLength":1,"description":"Key of the field this one depends on.","isRequired":true,"uniqueKey":"optionSet.fields.items.[INDEX].dependsOn.oneOf.0.key","typeLabel":"string"},"in":{"type":"array","description":"Values of that field for which this one is shown.","uniqueKey":"optionSet.fields.items.[INDEX].dependsOn.oneOf.0.in","typeLabel":"array"}},"description":"Show this field only when another field has one of the listed values.","uniqueKey":"optionSet.fields.items.[INDEX].dependsOn.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":false,"required":["key"],"properties":{"key":{"type":"string","minLength":1,"description":"Key of the field this one depends on."},"in":{"type":"array","description":"Values of that field for which this one is shown."}},"description":"Show this field only when another field has one of the listed values.","uniqueKey":"optionSet.fields.items.[INDEX].dependsOn.oneOf.1","typeLabel":"null"}],"uniqueKey":"optionSet.fields.items.[INDEX].dependsOn","typeLabel":"object | null"},"source":{"oneOf":[{"type":"string","enum":["page_count","color_count","width","height","color_space",null],"description":"Fill the value from the uploaded file instead of asking: page_count, color_count, width, height or color_space.","uniqueKey":"optionSet.fields.items.[INDEX].source.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["page_count","color_count","width","height","color_space",null],"description":"Fill the value from the uploaded file instead of asking: page_count, color_count, width, height or color_space.","uniqueKey":"optionSet.fields.items.[INDEX].source.oneOf.1","typeLabel":"null"}],"uniqueKey":"optionSet.fields.items.[INDEX].source","typeLabel":"enum\u003cstring> | null"},"preflightLink":{"oneOf":[{"type":"string","description":"Preflight concern this option relates to, such as \"bleed\" or \"even_pages\".","uniqueKey":"optionSet.fields.items.[INDEX].preflightLink.oneOf.0","typeLabel":"string"},{"type":"null","description":"Preflight concern this option relates to, such as \"bleed\" or \"even_pages\".","uniqueKey":"optionSet.fields.items.[INDEX].preflightLink.oneOf.1","typeLabel":"null"}],"uniqueKey":"optionSet.fields.items.[INDEX].preflightLink","typeLabel":"string | null"},"config":{"type":"object","description":"Free-form widget settings for this field; any keys.","uniqueKey":"optionSet.fields.items.[INDEX].config","typeLabel":"object"}},"uniqueKey":"optionSet.fields.items.[INDEX]","typeLabel":"object"},"description":"The option fields, in display order.","uniqueKey":"optionSet.fields","typeLabel":"object[]"},"config":{"type":"object","default":{},"description":"Free-form layout settings; any keys.","uniqueKey":"optionSet.config","typeLabel":"object"},"tags":{"type":"array","items":{"type":"string","uniqueKey":"optionSet.tags.items.[INDEX]","typeLabel":"string"},"default":[],"description":"Free-form labels. No effect.","uniqueKey":"optionSet.tags","typeLabel":"string[]"}},"uniqueKey":"optionSet","typeLabel":"object"},"delivery":{"type":"object","additionalProperties":false,"default":{"enabled":false,"destinationIds":[]},"description":"Where the finished print files go when a job completes successfully (after streams and merge). Every destination receives the job's final files: the merged PDF or ZIP when merge made one, otherwise each file as its stream left it (the original upload when no step changed it). Jobs that end in error are not delivered.","properties":{"enabled":{"type":"boolean","default":true,"description":"true (default when delivery is sent): deliver to every listed destination. false: keep the list but deliver nothing.","uniqueKey":"delivery.enabled","typeLabel":"boolean"},"destinationIds":{"type":"array","default":[],"uniqueItems":true,"items":{"type":"string","minLength":1,"uniqueKey":"delivery.destinationIds.items.[INDEX]","typeLabel":"string"},"description":"Ids of delivery destinations (GET /destinations): email, S3, webhook, SFTP or FTP targets that hold their own credentials, paths and sidecar settings. Destinations that are disabled or deleted when a job finishes are skipped. Empty means nothing is delivered.","uniqueKey":"delivery.destinationIds","typeLabel":"string[]"}},"uniqueKey":"delivery","typeLabel":"object"},"ui":{"type":"object","default":{},"additionalProperties":true,"description":"Display settings for the dashboard and the upload widget. Free-form: unknown keys are kept as they are.","properties":{"units":{"type":"string","enum":["mm","cm","in","pt","m","px"],"description":"Unit for sizes shown to customers and in reports for jobs of this workflow; overrides the account default (millimetres when neither is set).","uniqueKey":"ui.units","typeLabel":"enum\u003cstring>"},"tags":{"type":"array","items":{"type":"string","uniqueKey":"ui.tags.items.[INDEX]","typeLabel":"string"},"description":"Short labels shown on the workflow's card in the dashboard, for example [\"2 × PDF\", \"85 × 55 mm\"]; the description is shown when there are none.","uniqueKey":"ui.tags","typeLabel":"string[]"}},"uniqueKey":"ui","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"Workflow · object"},"examples":{"Example":{"title":"Example","value":{"intake":{"ruleId":"\u003cstring>","onError":"halt","enabled":true},"schemaVersion":1,"title":"\u003cstring>","description":"","tags":[],"trigger":"order_placed","streams":[],"merge":{"mode":"none","config":{},"onError":"halt","enabled":true},"finalize":[],"proofing":{"enabled":false,"type":"basic","timing":"after_intake","requireApproval":true,"config":{},"previewer":{"kind":"pages"}},"optionSet":{"enabled":false,"title":"","description":"","fields":[],"config":{}},"delivery":{"enabled":false,"destinationIds":[]},"ui":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"103ec5f0-8b3f-4d67-9887-1a891f5fd60b":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"workflow":{"type":"object","title":"Workflow","description":"A workflow is the fulfilment pipeline for a product: what happens to a customer's upload from the moment it is dropped on the product page until the print-ready file reaches the shop. Intake runs first, while the customer waits: it points at an upload rule (which file kinds, how many files or slots, and per kind the preflight profile that checks them and whether a failing file is rejected). When the trigger fires (order placed, upload accepted, proof approved or a manual run), each accepted file runs the stream for its kind (autofix, convert an image to PDF, optimize with a preset, split pages); then merge can combine the files, and delivery sends the result to the account's destinations. Proofing optionally shows the customer a soft proof at the end of intake, and can hold the job until they approve it. Rules, preflight profiles, optimize presets, destinations and scenes are separate records referenced by id; product mappings and the embedded upload widget point at a workflow by its id. A job copies the workflow when it is created; jobs that already hold files keep the version they started with. A minimal create body is { \"title\", \"intake\": { \"ruleId\" } } plus one stream per file kind the rule accepts; without streams files are delivered as they left intake.","required":["intake"],"conditionallyRequiredProperties":{"proofing":[{"when":[[{"property":"trigger","values":["proof_approval"]}]]}]},"properties":{"intake":{"type":"object","additionalProperties":false,"required":["ruleId"],"description":"The upload stage. Runs for every uploaded file as soon as it arrives, whatever the trigger: checks the file against the upload rule and its preflight profile, and makes the soft proof when proofing is enabled.","properties":{"ruleId":{"type":"string","minLength":1,"description":"Id of the upload rule (GET /rules): the accepted file kinds and MIME types, the number of files or named slots, and per kind the preflight profile and onFail policy that decides whether a failing file is rejected. The upload widget will not load a workflow without a rule. The rule's accepted kinds decide which streams this workflow needs.","isRequired":true,"uniqueKey":"workflow.intake.ruleId","typeLabel":"string"},"onError":{"type":"string","enum":["halt"],"default":"halt","description":"Stored for the dashboard and not read by the pipeline: whether a failing file blocks the job is set per kind by the rule's onFail. Only \"halt\" is accepted.","uniqueKey":"workflow.intake.onError","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","enum":[true],"default":true,"description":"Intake always runs and cannot be switched off. Always true.","uniqueKey":"workflow.intake.enabled","typeLabel":"enum\u003cboolean>"}},"isRequired":true,"uniqueKey":"workflow.intake","typeLabel":"object"},"schemaVersion":{"type":"integer","enum":[1],"default":1,"description":"Version of this record format. Always 1; can be left out.","uniqueKey":"workflow.schemaVersion","typeLabel":"enum\u003cinteger>"},"title":{"type":"string","minLength":1,"description":"Name shown in the dashboard, usually the product it serves (for example \"Business cards 85 × 55 mm\"). The dashboard's title editor takes up to 40 characters and will not save a workflow without one.","uniqueKey":"workflow.title","typeLabel":"string"},"description":{"type":"string","default":"","description":"Internal note shown under the title in the dashboard. Customers never see it.","uniqueKey":"workflow.description","typeLabel":"string"},"tags":{"type":"array","items":{"type":"string","uniqueKey":"workflow.tags.items.[INDEX]","typeLabel":"string"},"default":[],"description":"Free-form labels for organising workflows (the spec importer adds \"imported\" and the product type). No effect on processing.","uniqueKey":"workflow.tags","typeLabel":"string[]"},"trigger":{"type":"string","enum":["order_placed","on_accept","proof_approval","manual"],"default":"order_placed","description":"When processing after intake (streams, then merge and delivery) starts for a job whose files have passed intake. Until it fires, nothing after intake runs. \"order_placed\" (default): when the customer checks out in a connected cart and the order is linked to the job; the customer can still replace files until then, so use it on product pages. \"on_accept\": immediately, once the job holds enough accepted files for the rule's minimum file count; files are locked from then on. \"proof_approval\": when the customer approves the soft proof in the upload widget; needs proofing.enabled true. \"manual\": only when someone runs the job from the dashboard. Any job can also be run manually from the dashboard whatever its trigger.","uniqueKey":"workflow.trigger","typeLabel":"enum\u003cstring>"},"streams":{"type":"array","items":{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["pdf","raster","other"],"description":"The file kind this stream processes, after intake: \"pdf\" for PDF uploads and for vector or office files the rule converts to PDF at intake (accept entry convertToPdf true); \"raster\" for JPEG, PNG, TIFF and other images; \"other\" for everything else (archives, fonts, vector or office files kept as they are), which no step can process.","isRequired":true,"uniqueKey":"workflow.streams.items.[INDEX].kind","typeLabel":"enum\u003cstring>"},"steps":{"type":"array","default":[],"items":{"type":"object","required":["type"],"conditionallyRequiredProperties":{"config":[{}]},"properties":{"type":{"type":"string","enum":["autofix","convert","optimize","split_pages"],"description":"What the step does. \"autofix\": applies the fixes the intake preflight planned for this file (the profile checks with severity \"autofix\": add bleed, convert to CMYK, upscale low-resolution images and so on); it is skipped when intake ran no preflight or found nothing to fix. If the upload rule already autofixes at intake (accept entry autofix on, without repreflight), keep this step disabled or the same fixes are applied a second time. \"convert\" (raster stream only): places the image on a new PDF page sized by config.dimension. \"optimize\": runs an optimize preset (config.presetId) over the PDF; on the raster stream it needs an enabled convert step before it, since it works on the converted PDF. \"split_pages\" (pdf stream only): writes one single-page PDF per page as extra outputs; the file that is delivered and downloaded stays the unsplit PDF.","isRequired":true,"uniqueKey":"workflow.streams.items.[INDEX].steps.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","default":true,"description":"false keeps the step and its settings in the workflow without running it. The dashboard lists every allowed step for a stream and switches them on and off this way.","uniqueKey":"workflow.streams.items.[INDEX].steps.items.[INDEX].enabled","typeLabel":"boolean"},"onError":{"type":"string","enum":["halt","continue"],"default":"halt","description":"What a crash in this step does. \"halt\" (default): the file ends in error, which puts the whole job in error, so nothing is merged or delivered. \"continue\": the failure is recorded as a warning on the file and the job carries on with the file as it was before this step.","uniqueKey":"workflow.streams.items.[INDEX].steps.items.[INDEX].onError","typeLabel":"enum\u003cstring>"},"config":{"type":"object","default":{},"description":"Settings for this step type: autofix {}, convert { format, dimension, outputIntent, dpi }, optimize { presetId }, split_pages {}.","conditionalRequirements":[{}],"uniqueKey":"workflow.streams.items.[INDEX].steps.items.[INDEX].config","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"workflow.streams.items.[INDEX].steps.items.[INDEX]","typeLabel":"object"},"description":"Steps run on each file of this kind, in this order, each on the previous step's output. Allowed types, in the order they must appear: pdf: autofix, optimize, split_pages. raster: autofix, convert, optimize. other: none. Each type at most once; leaving types out is fine. An empty list, or one with no enabled step, means files of this kind are delivered as they left intake.","uniqueKey":"workflow.streams.items.[INDEX].steps","typeLabel":"object[]"}},"additionalProperties":false,"uniqueKey":"workflow.streams.items.[INDEX]","typeLabel":"object"},"description":"Per-file processing that runs after the trigger fires, one stream per file kind. After intake every accepted file is routed by kind: PDFs, and vector or office files the rule converts to PDF, go to the \"pdf\" stream; images go to the \"raster\" stream; anything else goes to \"other\". Add a stream for each kind the upload rule accepts, at most one per kind. A file whose kind has no stream is not processed and is delivered as it left intake. Named slots (Front, Back, …) do not get streams of their own: every file of a kind runs the same steps. Default [] (no processing).","default":[],"maxItems":3,"uniqueKey":"workflow.streams","typeLabel":"object[]"},"merge":{"type":"object","description":"What happens to the job's files once every file has finished its stream. Runs once per job; a merged file replaces the individual files in delivery and in the job's deliverables (downloads, GET /jobs/{id}).","default":{"mode":"none","config":{},"onError":"halt","enabled":true},"properties":{"mode":{"type":"string","enum":["none","merge_pdf","zip"],"default":"none","description":"\"none\" (default): files stay separate and are delivered one by one. \"merge_pdf\": all of the job's files are concatenated into one PDF in the order they were added to the job (slot names such as Front/Back do not affect the order); needs at least two files, and every file must be a PDF by the end of its stream, so the raster stream needs an enabled convert step and there must be no \"other\" stream. A merge that fails stops the job before its webhook and delivery. \"zip\": all files are bundled into one ZIP archive.","uniqueKey":"workflow.merge.mode","typeLabel":"enum\u003cstring>"},"config":{"type":"object","default":{},"description":"Mode settings: none {}, merge_pdf { order }, zip { names, order, zipName }.","uniqueKey":"workflow.merge.config","typeLabel":"object"},"onError":{"type":"string","enum":["halt"],"default":"halt","description":"Stored for the dashboard; a failed merge always stops the job before delivery. Only \"halt\" is accepted.","uniqueKey":"workflow.merge.onError","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","default":true,"description":"false skips the merge whatever the mode. Default true.","uniqueKey":"workflow.merge.enabled","typeLabel":"boolean"}},"additionalProperties":false,"uniqueKey":"workflow.merge","typeLabel":"object"},"finalize":{"type":"array","maxItems":0,"default":[],"description":"Reserved for steps after merge (imposition, export). None are implemented, so it must be empty.","uniqueKey":"workflow.finalize","typeLabel":"array"},"proofing":{"type":"object","additionalProperties":false,"default":{"enabled":false,"type":"basic","timing":"after_intake","requireApproval":true,"config":{},"previewer":{"kind":"pages"}},"description":"Soft proof: a colour-managed preview of each uploaded file, drawn on the print sheet with bleed and cut marks and showing the fixes autofix will make, shown to the customer in the upload widget at the end of intake. With trigger \"proof_approval\" the job waits until the customer approves it; with any other trigger it is for information only.","properties":{"id":{"type":"string","description":"Opaque id the dashboard stamps on this block. Optional; no effect.","uniqueKey":"workflow.proofing.id","typeLabel":"string"},"enabled":{"type":"boolean","default":false,"description":"Make a proof of every file at the end of intake. Default false. Must be true when trigger is \"proof_approval\".","uniqueKey":"workflow.proofing.enabled","typeLabel":"boolean"},"type":{"type":"string","enum":["basic"],"default":"basic","description":"Proof style. Only \"basic\" (rendered page previews) exists.","uniqueKey":"workflow.proofing.type","typeLabel":"enum\u003cstring>"},"timing":{"type":"string","enum":["after_intake"],"default":"after_intake","description":"When the proof is made. Only \"after_intake\" is implemented: after the file passes intake, before the trigger fires. Later points (after streams, after merge) are reserved and would produce no proof.","uniqueKey":"workflow.proofing.timing","typeLabel":"enum\u003cstring>"},"requireApproval":{"type":"boolean","default":true,"description":"Informational only: whether the job waits for the customer's approval is decided by trigger \"proof_approval\", not by this flag.","uniqueKey":"workflow.proofing.requireApproval","typeLabel":"boolean"},"previewer":{"type":"object","description":"What the customer approves on: the flat pages, or the proofed pages shown on a product scene.","default":{"kind":"pages"},"required":["kind"],"conditionallyRequiredProperties":{"sceneId":[{"when":[[{"property":"kind","values":["scene"]}]]}]},"properties":{"kind":{"type":"string","enum":["pages","scene"],"default":"pages","description":"\"pages\" (default): flat page previews. \"scene\": the proofed pages shown on the 3D model, folded leaflet or booklet named by sceneId.","isRequired":true,"uniqueKey":"workflow.proofing.previewer.kind","typeLabel":"enum\u003cstring>"},"sceneId":{"type":"string","minLength":1,"description":"Id of a scene from the scene library (the account's own or the built-in catalog): a 3D model, fold or flipbook the proofed pages are wrapped onto. Required when kind is \"scene\"; not allowed with \"pages\".","conditionalRequirements":[{"when":[[{"property":"kind","values":["scene"]}]]}],"uniqueKey":"workflow.proofing.previewer.sceneId","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"workflow.proofing.previewer","typeLabel":"object"},"config":{"type":"object","additionalProperties":false,"default":{},"description":"Advanced overrides for the proof render. Normally empty: the sheet, bleed and colour profile are inferred from the stream's optimize preset (pdf) or convert dimension (raster), falling back to the intake preflight profile.","properties":{"iccProfile":{"type":"string","enum":["fogra51","fogra52","gracol2013","swop2013","fogra39","iso-coated-v2","iso-coated-v2-300","gracol2006","swop","fogra29","japan-coated","japan-uncoated","psr-lwc","psr-snp","srgb","adobe-rgb","display-p3","greyscale","cmyk-fogra29.icc","cmyk-fogra39.icc","cmyk-fogra51.icc","cmyk-fogra52.icc","cmyk-gracol2006.icc","cmyk-gracol2013.icc","cmyk-iso-coated-v2-300.icc","cmyk-iso-coated-v2.icc","cmyk-japan-coated.icc","cmyk-japan-uncoated.icc","cmyk-psr-lwc.icc","cmyk-psr-snp.icc","cmyk-swop-v2.icc","cmyk-swop2013.icc","gray-sgray.icc","rgb-adobe-1998.icc","rgb-display-p3.icc","rgb-srgb.icc","cmyk-fogra29","cmyk-fogra39","cmyk-fogra51","cmyk-fogra52","cmyk-gracol2006","cmyk-gracol2013","cmyk-iso-coated-v2-300","cmyk-iso-coated-v2","cmyk-japan-coated","cmyk-japan-uncoated","cmyk-psr-lwc","cmyk-psr-snp","cmyk-swop-v2","cmyk-swop2013","gray-sgray","rgb-adobe-1998","rgb-display-p3","rgb-srgb"],"description":"Printing condition the proof simulates, replacing the inferred one: an alias such as \"fogra39\", \"fogra51\", \"gracol2013\", \"swop2013\", \"srgb\" or \"greyscale\", or a bundled ICC file name.","uniqueKey":"workflow.proofing.config.iccProfile","typeLabel":"enum\u003cstring>"},"format":{"type":"string","enum":["webp","jpeg","png"],"description":"Image format of the proof pages. Default \"webp\".","uniqueKey":"workflow.proofing.config.format","typeLabel":"enum\u003cstring>"},"quality":{"type":"integer","minimum":1,"maximum":100,"description":"Compression quality of the proof images, 1 to 100. Default 91.","uniqueKey":"workflow.proofing.config.quality","typeLabel":"integer"},"maxEdge":{"type":"integer","minimum":1,"description":"Longest side of a proof image in pixels. Default 1200.","uniqueKey":"workflow.proofing.config.maxEdge","typeLabel":"integer"},"sheet":{"type":"object","additionalProperties":false,"required":["size"],"description":"Advanced: the print sheet each proof page is drawn on, replacing the inferred one (from the optimize preset's page size and bleed on the pdf stream, the convert dimension on the raster stream, else the preflight profile's page size and bleed). Omit unless the inference is wrong.","properties":{"size":{"type":"object","additionalProperties":false,"required":["width","height"],"description":"Finished (trim) size of the sheet.","properties":{"width":{"type":"number","exclusiveMinimum":0,"description":"Trim width in millimetres.","isRequired":true,"uniqueKey":"workflow.proofing.config.sheet.size.width","typeLabel":"number"},"height":{"type":"number","exclusiveMinimum":0,"description":"Trim height in millimetres.","isRequired":true,"uniqueKey":"workflow.proofing.config.sheet.size.height","typeLabel":"number"},"unit":{"type":"string","enum":["mm"],"default":"mm","description":"Always millimetres.","uniqueKey":"workflow.proofing.config.sheet.size.unit","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"workflow.proofing.config.sheet.size","typeLabel":"object"},"sizes":{"type":"array","minItems":1,"items":{"type":"object","additionalProperties":false,"required":["width_mm","height_mm"],"properties":{"width_mm":{"type":"number","exclusiveMinimum":0,"description":"Trim width in millimetres.","isRequired":true,"uniqueKey":"workflow.proofing.config.sheet.sizes.items.[INDEX].width_mm","typeLabel":"number"},"height_mm":{"type":"number","exclusiveMinimum":0,"description":"Trim height in millimetres.","isRequired":true,"uniqueKey":"workflow.proofing.config.sheet.sizes.items.[INDEX].height_mm","typeLabel":"number"}},"uniqueKey":"workflow.proofing.config.sheet.sizes.items.[INDEX]","typeLabel":"object"},"description":"For products sold in several sizes: each page is proofed on the listed size nearest to it instead of on size.","uniqueKey":"workflow.proofing.config.sheet.sizes","typeLabel":"object[]"},"bleed":{"type":"number","minimum":0,"description":"Bleed shown around the trim, in millimetres. Default 0.","uniqueKey":"workflow.proofing.config.sheet.bleed","typeLabel":"number"},"safeZone":{"type":"number","minimum":0,"description":"Safety margin drawn inside the trim, in millimetres. Default 0.","uniqueKey":"workflow.proofing.config.sheet.safeZone","typeLabel":"number"},"fitTo":{"type":"string","enum":["trim","media"],"description":"Fit the artwork to the trim (default) or to the full sheet including bleed.","uniqueKey":"workflow.proofing.config.sheet.fitTo","typeLabel":"enum\u003cstring>"},"fit":{"type":"string","enum":["contain","cover"],"description":"\"contain\" (default) shows the whole artwork inside the trim; \"cover\" fills the trim and crops the overflow.","uniqueKey":"workflow.proofing.config.sheet.fit","typeLabel":"enum\u003cstring>"},"dpi":{"type":"integer","minimum":1,"description":"Render resolution of the sheet in pixels per inch. Default 150; targetEdge wins when both are set.","uniqueKey":"workflow.proofing.config.sheet.dpi","typeLabel":"integer"},"targetEdge":{"type":"integer","minimum":1,"description":"Longest side of the rendered sheet in pixels, bleed included. Inferred sheets use 1200.","uniqueKey":"workflow.proofing.config.sheet.targetEdge","typeLabel":"integer"},"cutMarks":{"type":"boolean","description":"Draw corner cut marks and the dashed trim line. Default true.","uniqueKey":"workflow.proofing.config.sheet.cutMarks","typeLabel":"boolean"},"watermark":{"type":"boolean","description":"Overlay a \"proof\" watermark band. Default false for a sheet given here (inferred sheets ask for one); it can also be switched off platform-wide.","uniqueKey":"workflow.proofing.config.sheet.watermark","typeLabel":"boolean"},"background":{"type":"string","pattern":"^#[0-9A-Fa-f]{6}$","description":"Sheet background colour as #rrggbb. Default #ffffff.","uniqueKey":"workflow.proofing.config.sheet.background","typeLabel":"string"},"matchOrientation":{"type":"boolean","description":"Turn the sheet to the artwork's orientation. Default true.","uniqueKey":"workflow.proofing.config.sheet.matchOrientation","typeLabel":"boolean"}},"uniqueKey":"workflow.proofing.config.sheet","typeLabel":"object"}},"uniqueKey":"workflow.proofing.config","typeLabel":"object"},"tags":{"type":"array","items":{"type":"string","uniqueKey":"workflow.proofing.tags.items.[INDEX]","typeLabel":"string"},"default":[],"description":"Free-form labels. No effect.","uniqueKey":"workflow.proofing.tags","typeLabel":"string[]"}},"conditionalRequirements":[{"when":[[{"property":"trigger","values":["proof_approval"]}]]}],"uniqueKey":"workflow.proofing","typeLabel":"object"},"optionSet":{"type":"object","additionalProperties":false,"default":{"enabled":false,"title":"","description":"","fields":[],"config":{}},"description":"Customer-facing option fields (paper, sides, quantity and so on) meant to be shown next to the upload. Reserved: nothing reads it yet; the upload widget does not show it and jobs ignore it. Leave it disabled; product options belong in the store.","properties":{"id":{"type":"string","description":"Opaque id the dashboard stamps on this block. Optional; no effect.","uniqueKey":"workflow.optionSet.id","typeLabel":"string"},"enabled":{"type":"boolean","default":false,"description":"Has no effect yet. Default false.","uniqueKey":"workflow.optionSet.enabled","typeLabel":"boolean"},"title":{"type":"string","default":"","description":"Heading above the fields.","uniqueKey":"workflow.optionSet.title","typeLabel":"string"},"description":{"type":"string","default":"","description":"Text under the heading.","uniqueKey":"workflow.optionSet.description","typeLabel":"string"},"fields":{"type":"array","default":[],"items":{"type":"object","additionalProperties":false,"required":["key","type"],"properties":{"key":{"type":"string","minLength":1,"description":"Stable identifier, unique within the option set; dependsOn refers to it.","isRequired":true,"uniqueKey":"workflow.optionSet.fields.items.[INDEX].key","typeLabel":"string"},"type":{"type":"string","enum":["select","radio","swatch","sides","binding","grommet","toggle","number","text","note"],"description":"Widget: select (dropdown), radio, swatch, sides, binding, grommet, toggle, number, text, or note (read-only text).","isRequired":true,"uniqueKey":"workflow.optionSet.fields.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"label":{"type":"string","description":"Label shown to the customer.","uniqueKey":"workflow.optionSet.fields.items.[INDEX].label","typeLabel":"string"},"help":{"type":"string","description":"Helper text under the field.","uniqueKey":"workflow.optionSet.fields.items.[INDEX].help","typeLabel":"string"},"required":{"type":"boolean","description":"The customer must answer it.","uniqueKey":"workflow.optionSet.fields.items.[INDEX].required","typeLabel":"boolean"},"default":{"description":"Pre-selected value.","uniqueKey":"workflow.optionSet.fields.items.[INDEX].default","typeLabel":"any"},"choices":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["value"],"properties":{"value":{"oneOf":[{"type":"string","description":"Value recorded when the customer picks this choice.","isRequired":true,"uniqueKey":"workflow.optionSet.fields.items.[INDEX].choices.items.[INDEX].value.oneOf.0","typeLabel":"string"},{"type":"number","description":"Value recorded when the customer picks this choice.","isRequired":true,"uniqueKey":"workflow.optionSet.fields.items.[INDEX].choices.items.[INDEX].value.oneOf.1","typeLabel":"number"},{"type":"boolean","description":"Value recorded when the customer picks this choice.","isRequired":true,"uniqueKey":"workflow.optionSet.fields.items.[INDEX].choices.items.[INDEX].value.oneOf.2","typeLabel":"boolean"}],"isRequired":true,"uniqueKey":"workflow.optionSet.fields.items.[INDEX].choices.items.[INDEX].value","typeLabel":"string | number | boolean"},"label":{"type":"string","description":"Text shown for the choice. Defaults to the value.","uniqueKey":"workflow.optionSet.fields.items.[INDEX].choices.items.[INDEX].label","typeLabel":"string"},"swatch":{"oneOf":[{"type":"string","description":"Colour or material swatch for swatch fields.","uniqueKey":"workflow.optionSet.fields.items.[INDEX].choices.items.[INDEX].swatch.oneOf.0","typeLabel":"string"},{"type":"null","description":"Colour or material swatch for swatch fields.","uniqueKey":"workflow.optionSet.fields.items.[INDEX].choices.items.[INDEX].swatch.oneOf.1","typeLabel":"null"}],"uniqueKey":"workflow.optionSet.fields.items.[INDEX].choices.items.[INDEX].swatch","typeLabel":"string | null"},"thumb":{"oneOf":[{"type":"string","description":"Thumbnail image URL.","uniqueKey":"workflow.optionSet.fields.items.[INDEX].choices.items.[INDEX].thumb.oneOf.0","typeLabel":"string"},{"type":"null","description":"Thumbnail image URL.","uniqueKey":"workflow.optionSet.fields.items.[INDEX].choices.items.[INDEX].thumb.oneOf.1","typeLabel":"null"}],"uniqueKey":"workflow.optionSet.fields.items.[INDEX].choices.items.[INDEX].thumb","typeLabel":"string | null"},"priceHint":{"oneOf":[{"type":"string","description":"Cosmetic price note such as \"+€2.00\"; never used to price anything.","uniqueKey":"workflow.optionSet.fields.items.[INDEX].choices.items.[INDEX].priceHint.oneOf.0","typeLabel":"string"},{"type":"null","description":"Cosmetic price note such as \"+€2.00\"; never used to price anything.","uniqueKey":"workflow.optionSet.fields.items.[INDEX].choices.items.[INDEX].priceHint.oneOf.1","typeLabel":"null"}],"uniqueKey":"workflow.optionSet.fields.items.[INDEX].choices.items.[INDEX].priceHint","typeLabel":"string | null"},"config":{"type":"object","description":"Free-form widget settings for this choice; any keys.","uniqueKey":"workflow.optionSet.fields.items.[INDEX].choices.items.[INDEX].config","typeLabel":"object"}},"uniqueKey":"workflow.optionSet.fields.items.[INDEX].choices.items.[INDEX]","typeLabel":"object"},"description":"Choices for select, radio, swatch, sides, binding and grommet fields.","uniqueKey":"workflow.optionSet.fields.items.[INDEX].choices","typeLabel":"object[]"},"min":{"oneOf":[{"type":"number","description":"Smallest value for number fields.","uniqueKey":"workflow.optionSet.fields.items.[INDEX].min.oneOf.0","typeLabel":"number"},{"type":"null","description":"Smallest value for number fields.","uniqueKey":"workflow.optionSet.fields.items.[INDEX].min.oneOf.1","typeLabel":"null"}],"uniqueKey":"workflow.optionSet.fields.items.[INDEX].min","typeLabel":"number | null"},"max":{"oneOf":[{"type":"number","description":"Largest value for number fields.","uniqueKey":"workflow.optionSet.fields.items.[INDEX].max.oneOf.0","typeLabel":"number"},{"type":"null","description":"Largest value for number fields.","uniqueKey":"workflow.optionSet.fields.items.[INDEX].max.oneOf.1","typeLabel":"null"}],"uniqueKey":"workflow.optionSet.fields.items.[INDEX].max","typeLabel":"number | null"},"step":{"oneOf":[{"type":"number","description":"Increment for number fields.","uniqueKey":"workflow.optionSet.fields.items.[INDEX].step.oneOf.0","typeLabel":"number"},{"type":"null","description":"Increment for number fields.","uniqueKey":"workflow.optionSet.fields.items.[INDEX].step.oneOf.1","typeLabel":"null"}],"uniqueKey":"workflow.optionSet.fields.items.[INDEX].step","typeLabel":"number | null"},"unit":{"type":"string","description":"Unit label shown next to the value, such as \"copies\" or \"mm\".","uniqueKey":"workflow.optionSet.fields.items.[INDEX].unit","typeLabel":"string"},"dependsOn":{"oneOf":[{"type":"object","additionalProperties":false,"required":["key"],"properties":{"key":{"type":"string","minLength":1,"description":"Key of the field this one depends on.","isRequired":true,"uniqueKey":"workflow.optionSet.fields.items.[INDEX].dependsOn.oneOf.0.key","typeLabel":"string"},"in":{"type":"array","description":"Values of that field for which this one is shown.","uniqueKey":"workflow.optionSet.fields.items.[INDEX].dependsOn.oneOf.0.in","typeLabel":"array"}},"description":"Show this field only when another field has one of the listed values.","uniqueKey":"workflow.optionSet.fields.items.[INDEX].dependsOn.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":false,"required":["key"],"properties":{"key":{"type":"string","minLength":1,"description":"Key of the field this one depends on."},"in":{"type":"array","description":"Values of that field for which this one is shown."}},"description":"Show this field only when another field has one of the listed values.","uniqueKey":"workflow.optionSet.fields.items.[INDEX].dependsOn.oneOf.1","typeLabel":"null"}],"uniqueKey":"workflow.optionSet.fields.items.[INDEX].dependsOn","typeLabel":"object | null"},"source":{"oneOf":[{"type":"string","enum":["page_count","color_count","width","height","color_space",null],"description":"Fill the value from the uploaded file instead of asking: page_count, color_count, width, height or color_space.","uniqueKey":"workflow.optionSet.fields.items.[INDEX].source.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["page_count","color_count","width","height","color_space",null],"description":"Fill the value from the uploaded file instead of asking: page_count, color_count, width, height or color_space.","uniqueKey":"workflow.optionSet.fields.items.[INDEX].source.oneOf.1","typeLabel":"null"}],"uniqueKey":"workflow.optionSet.fields.items.[INDEX].source","typeLabel":"enum\u003cstring> | null"},"preflightLink":{"oneOf":[{"type":"string","description":"Preflight concern this option relates to, such as \"bleed\" or \"even_pages\".","uniqueKey":"workflow.optionSet.fields.items.[INDEX].preflightLink.oneOf.0","typeLabel":"string"},{"type":"null","description":"Preflight concern this option relates to, such as \"bleed\" or \"even_pages\".","uniqueKey":"workflow.optionSet.fields.items.[INDEX].preflightLink.oneOf.1","typeLabel":"null"}],"uniqueKey":"workflow.optionSet.fields.items.[INDEX].preflightLink","typeLabel":"string | null"},"config":{"type":"object","description":"Free-form widget settings for this field; any keys.","uniqueKey":"workflow.optionSet.fields.items.[INDEX].config","typeLabel":"object"}},"uniqueKey":"workflow.optionSet.fields.items.[INDEX]","typeLabel":"object"},"description":"The option fields, in display order.","uniqueKey":"workflow.optionSet.fields","typeLabel":"object[]"},"config":{"type":"object","default":{},"description":"Free-form layout settings; any keys.","uniqueKey":"workflow.optionSet.config","typeLabel":"object"},"tags":{"type":"array","items":{"type":"string","uniqueKey":"workflow.optionSet.tags.items.[INDEX]","typeLabel":"string"},"default":[],"description":"Free-form labels. No effect.","uniqueKey":"workflow.optionSet.tags","typeLabel":"string[]"}},"uniqueKey":"workflow.optionSet","typeLabel":"object"},"delivery":{"type":"object","additionalProperties":false,"default":{"enabled":false,"destinationIds":[]},"description":"Where the finished print files go when a job completes successfully (after streams and merge). Every destination receives the job's final files: the merged PDF or ZIP when merge made one, otherwise each file as its stream left it (the original upload when no step changed it). Jobs that end in error are not delivered.","properties":{"enabled":{"type":"boolean","default":true,"description":"true (default when delivery is sent): deliver to every listed destination. false: keep the list but deliver nothing.","uniqueKey":"workflow.delivery.enabled","typeLabel":"boolean"},"destinationIds":{"type":"array","default":[],"uniqueItems":true,"items":{"type":"string","minLength":1,"uniqueKey":"workflow.delivery.destinationIds.items.[INDEX]","typeLabel":"string"},"description":"Ids of delivery destinations (GET /destinations): email, S3, webhook, SFTP or FTP targets that hold their own credentials, paths and sidecar settings. Destinations that are disabled or deleted when a job finishes are skipped. Empty means nothing is delivered.","uniqueKey":"workflow.delivery.destinationIds","typeLabel":"string[]"}},"uniqueKey":"workflow.delivery","typeLabel":"object"},"ui":{"type":"object","default":{},"additionalProperties":true,"description":"Display settings for the dashboard and the upload widget. Free-form: unknown keys are kept as they are.","properties":{"units":{"type":"string","enum":["mm","cm","in","pt","m","px"],"description":"Unit for sizes shown to customers and in reports for jobs of this workflow; overrides the account default (millimetres when neither is set).","uniqueKey":"workflow.ui.units","typeLabel":"enum\u003cstring>"},"tags":{"type":"array","items":{"type":"string","uniqueKey":"workflow.ui.tags.items.[INDEX]","typeLabel":"string"},"description":"Short labels shown on the workflow's card in the dashboard, for example [\"2 × PDF\", \"85 × 55 mm\"]; the description is shown when there are none.","uniqueKey":"workflow.ui.tags","typeLabel":"string[]"}},"uniqueKey":"workflow.ui","typeLabel":"object"},"id":{"type":"string","description":"The record id.","uniqueKey":"workflow.id","typeLabel":"string"},"source":{"type":"string","enum":["domain","store"],"description":"`domain`: yours. `store`: a built-in catalog record.","uniqueKey":"workflow.source","typeLabel":"enum\u003cstring>"},"customized":{"type":"boolean","description":"Your own copy of a built-in record, under the same id. Revert drops it.","uniqueKey":"workflow.customized","typeLabel":"boolean"},"draft":{"type":"boolean","description":"Present and true on an unpublished draft.","uniqueKey":"workflow.draft","typeLabel":"boolean"},"draftExpiresAt":{"type":"string","format":"date-time","description":"When an unpublished draft is deleted.","uniqueKey":"workflow.draftExpiresAt","typeLabel":"string\u003cdate-time>"},"created":{"type":"integer","description":"Unix time (seconds).","uniqueKey":"workflow.created","typeLabel":"integer"},"modified":{"type":"integer","description":"Unix time (seconds).","uniqueKey":"workflow.modified","typeLabel":"integer"}},"additionalProperties":false,"uniqueKey":"workflow","typeLabel":"Workflow · object"},"dryRun":{"type":"boolean","description":"Present and true when nothing was saved.","uniqueKey":"dryRun","typeLabel":"boolean"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"workflow":{"intake":{"ruleId":"\u003cstring>","onError":"halt","enabled":true},"schemaVersion":1,"title":"\u003cstring>","description":"","tags":[],"trigger":"order_placed","streams":[],"merge":{"mode":"none","config":{},"onError":"halt","enabled":true},"finalize":[],"proofing":{"enabled":false,"type":"basic","timing":"after_intake","requireApproval":true,"config":{},"previewer":{"kind":"pages"}},"optionSet":{"enabled":false,"title":"","description":"","fields":[],"config":{}},"delivery":{"enabled":false,"destinationIds":[]},"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"},"9517f825-22d3-4b9b-bfdf-b32e7e7577cd":{"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"},"6578cf4e-5015-4110-ba40-377584e84ff6":{"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"},"31d19006-7e84-48cd-a5f1-c4a9149c558d":{"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"},"8a2c27fe-a743-46d4-94f2-cc4847ed1d9e":{"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":"Update a workflow - Filecheck","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-11T08:51:31.661Z","originalFileLocation":"api-reference/workflows/update-a-workflow.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=\"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 workflow saves your own copy under the same id (customized: true), which you can undo with revert.\">\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=\"Update a workflow - Filecheck\">\u003cmeta data-mint-head property=\"og:description\" content=\"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 workflow saves your own copy under the same id (customized: true), which you can undo with revert.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Filecheck\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://filecheck.io/docs/api-reference/workflows/update-a-workflow\">\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=Workflows\u0026amp;title=Update+a+workflow\u0026amp;description=A+JSON+Merge+Patch+%28RFC+7396%29%3A+send+only+what+changes.+Objects+merge+key+by+key%2C+%60null%60+removes+a+key%2C+arrays+replace+the+whole+list.+Patching+a+catalog+workflo\u0026amp;theme=2d8b0f160f4bd456e90bb9d1\u0026amp;signature=be8aa872438d0e1406ac252bc6a91adb4b0a135d16f4bf3897ed1660285c0415\">\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=\"Update a workflow - Filecheck\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"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 workflow saves your own copy under the same id (customized: true), which you can undo with revert.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://filecheck.mintlify.site/docs/_mintlify/api/og/v2?division=Workflows\u0026amp;title=Update+a+workflow\u0026amp;description=A+JSON+Merge+Patch+%28RFC+7396%29%3A+send+only+what+changes.+Objects+merge+key+by+key%2C+%60null%60+removes+a+key%2C+arrays+replace+the+whole+list.+Patching+a+catalog+workflo\u0026amp;theme=2d8b0f160f4bd456e90bb9d1\u0026amp;signature=be8aa872438d0e1406ac252bc6a91adb4b0a135d16f4bf3897ed1660285c0415\">\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/workflows/update-a-workflow\">\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/workflows/update-a-workflow.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/workflows/update-a-workflow#webpage\",\"url\":\"https://filecheck.io/docs/api-reference/workflows/update-a-workflow\",\"name\":\"Update a workflow\",\"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 workflow saves your own copy under the same id (customized: true), which you can undo with revert.\",\"dateModified\":\"2026-11-11T08:51:31.661Z\",\"isPartOf\":{\"@id\":\"https://filecheck.io/docs#website\"},\"breadcrumb\":{\"@id\":\"https://filecheck.io/docs/api-reference/workflows/update-a-workflow#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://filecheck.io/docs/api-reference/workflows/update-a-workflow#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Workflows\",\"item\":\"https://filecheck.io/docs/api-reference/workflows/list-workflows\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Update a workflow\",\"item\":\"https://filecheck.io/docs/api-reference/workflows/update-a-workflow\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://filecheck.io/docs/api-reference/workflows/update-a-workflow#apireference\",\"headline\":\"Update a workflow\",\"name\":\"Update a workflow\",\"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 workflow saves your own copy under the same id (customized: true), which you can undo with revert.\",\"url\":\"https://filecheck.io/docs/api-reference/workflows/update-a-workflow\",\"mainEntityOfPage\":{\"@id\":\"https://filecheck.io/docs/api-reference/workflows/update-a-workflow#webpage\"},\"dateModified\":\"2026-11-11T08:51:31.661Z\",\"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/workflows/update-a-workflow.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","description":"Creates a workflow. Records it points at must exist and be visible to you; a published workflow cannot point at a draft.","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","description":"Deleting a catalog workflow hides it from your account; deleting your own removes it (recoverable by support for 30 days); deleting a draft removes it at once. Refused with `in_use` while a published record or product still uses it.","deprecated":null,"version":null,"openapi":"/openapi.json delete /workflows/{id}","href":"/api-reference/workflows/delete-a-workflow"},{"title":"Publish a draft workflow","deprecated":null,"version":null,"openapi":"/openapi.json post /workflows/{id}/publish","href":"/api-reference/workflows/publish-a-draft-workflow"},{"title":"Revert to the catalog workflow","deprecated":null,"version":null,"openapi":"/openapi.json post /workflows/{id}/revert","href":"/api-reference/workflows/revert-to-the-catalog-workflow"}]},{"group":"Rules","pages":[{"title":"List rules","deprecated":null,"version":null,"openapi":"/openapi.json get /rules","href":"/api-reference/rules/list-rules"},{"title":"Get a rule","deprecated":null,"version":null,"openapi":"/openapi.json get /rules/{id}","href":"/api-reference/rules/get-a-rule"},{"title":"Create a rule","deprecated":null,"version":null,"openapi":"/openapi.json post /rules","href":"/api-reference/rules/create-a-rule"},{"title":"Update a rule","deprecated":null,"version":null,"openapi":"/openapi.json patch /rules/{id}","href":"/api-reference/rules/update-a-rule"},{"title":"Delete a rule","deprecated":null,"version":null,"openapi":"/openapi.json delete /rules/{id}","href":"/api-reference/rules/delete-a-rule"},{"title":"Publish a draft rule","deprecated":null,"version":null,"openapi":"/openapi.json post /rules/{id}/publish","href":"/api-reference/rules/publish-a-draft-rule"},{"title":"Revert to the catalog rule","deprecated":null,"version":null,"openapi":"/openapi.json post /rules/{id}/revert","href":"/api-reference/rules/revert-to-the-catalog-rule"}]},{"group":"Profiles","pages":[{"title":"List preflight profiles","deprecated":null,"version":null,"openapi":"/openapi.json get /profiles","href":"/api-reference/profiles/list-preflight-profiles"},{"title":"Get a preflight profile","deprecated":null,"version":null,"openapi":"/openapi.json get /profiles/{id}","href":"/api-reference/profiles/get-a-preflight-profile"},{"title":"Create a preflight profile","deprecated":null,"version":null,"openapi":"/openapi.json post /profiles","href":"/api-reference/profiles/create-a-preflight-profile"},{"title":"Update a preflight profile","deprecated":null,"version":null,"openapi":"/openapi.json patch /profiles/{id}","href":"/api-reference/profiles/update-a-preflight-profile"},{"title":"Delete a preflight profile","deprecated":null,"version":null,"openapi":"/openapi.json delete /profiles/{id}","href":"/api-reference/profiles/delete-a-preflight-profile"},{"title":"Publish a draft preflight profile","deprecated":null,"version":null,"openapi":"/openapi.json post /profiles/{id}/publish","href":"/api-reference/profiles/publish-a-draft-preflight-profile"},{"title":"Revert to the catalog preflight profile","deprecated":null,"version":null,"openapi":"/openapi.json post /profiles/{id}/revert","href":"/api-reference/profiles/revert-to-the-catalog-preflight-profile"}]},{"group":"Connectors","pages":[{"title":"List connectors","deprecated":null,"version":null,"openapi":"/openapi.json get /connectors","href":"/api-reference/connectors/list-connectors"},{"title":"Get a connector","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":"Update a workflow - 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"]}