Skip to main content
PATCH
Update a preflight profile

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

The preflight profile 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 preflight profile: the checks FileCheck runs on an uploaded file, each with its settings (target), how a failure is judged (severity) and whether it is repaired automatically. There are two kinds. A PDF profile (kind omitted or 'pdf') checks PDFs, and vector and office files once converted to PDF; its checks sit in the sections geometry (geom.), color (color.), text (text.), images (image.) and structure (struct.). A raster profile (kind: 'raster') checks image uploads (JPEG, PNG, TIFF and so on) with the single section raster (raster.). An upload rule points at profiles through rule.accepts[].preflight.profileId: pdf, vector and office accepts need a PDF profile, raster accepts a raster profile. A check runs only when both its section's enabled and its own enabled are true; everything omitted is off. Each check has a severity. reject: a failing file is rejected (shown as a warning instead when the upload rule's onFail is not reject). warn: it passes with a warning. ignore: the finding is recorded but never fails or warns. autofix: the customer is told FileCheck repairs it, and the finding is judged as reject when this file is beyond the repair; autofix is accepted only on checks that have a repair (their description says Autofix: …). Repairs run only in workflows with an autofix step, which repairs every failed check that has a repair whatever its severity, so to stop a repair disable the check. Units are in the field names: _mm millimetres, _pt points (1/72 in), _dpi or dpi pixels per inch, percent, _px pixels, _mb megabytes. Unknown check ids, a check in the wrong section and misspelled settings are refused.

sections
object
required

The checks, grouped in sections keyed by section id. PDF profiles: geometry (geom.* checks), color (color.), text (text.), images (image.), structure (struct.) and page_rules (reserved, keep empty). Raster profiles: raster (raster.*). Each section is { enabled, rules: { : { enabled, severity, target, autofixStrategy } } }. To change one setting, PATCH only that path, e.g. { "sections": { "geometry": { "rules": { "geom.bleed.required": { "target": { "required_mm": 3 } } } } } }; when enabling a check, also send its section's enabled: true.

title
string

Name shown in the dashboard and in the profile picker of upload rules, e.g. 'Business cards 85 x 55 mm'. Keep it under 45 characters, the dashboard editor's limit; the dashboard will not save a profile without one.

Required string length: 1 - 120
description
string
default:""

Note for the print shop: what the profile is for. Shown in the dashboard editor of PDF profiles; never shown to customers.

Maximum string length: 2000
kind
enum<string>
conditionally required

'raster' for an image profile; 'pdf' or omitted for a PDF profile. Decides which sections are valid: changing it on an existing profile means replacing its sections too, and upload rules pointing at it must match the new kind.

Available options:
pdf,
raster
metadata
object

Legacy metadata carried by built-in catalog profiles.

tags
string[]

Free-form labels for your own organisation, e.g. ['business-cards', 'cmyk']. Not shown to customers.

Required string length: 1 - 64
schemaVersion
enum<number>
default:1

Record format version. Always 1.

Available options:
1

Response

OK

profile
Profile · object

A preflight profile: the checks FileCheck runs on an uploaded file, each with its settings (target), how a failure is judged (severity) and whether it is repaired automatically. There are two kinds. A PDF profile (kind omitted or 'pdf') checks PDFs, and vector and office files once converted to PDF; its checks sit in the sections geometry (geom.), color (color.), text (text.), images (image.) and structure (struct.). A raster profile (kind: 'raster') checks image uploads (JPEG, PNG, TIFF and so on) with the single section raster (raster.). An upload rule points at profiles through rule.accepts[].preflight.profileId: pdf, vector and office accepts need a PDF profile, raster accepts a raster profile. A check runs only when both its section's enabled and its own enabled are true; everything omitted is off. Each check has a severity. reject: a failing file is rejected (shown as a warning instead when the upload rule's onFail is not reject). warn: it passes with a warning. ignore: the finding is recorded but never fails or warns. autofix: the customer is told FileCheck repairs it, and the finding is judged as reject when this file is beyond the repair; autofix is accepted only on checks that have a repair (their description says Autofix: …). Repairs run only in workflows with an autofix step, which repairs every failed check that has a repair whatever its severity, so to stop a repair disable the check. Units are in the field names: _mm millimetres, _pt points (1/72 in), _dpi or dpi pixels per inch, percent, _px pixels, _mb megabytes. Unknown check ids, a check in the wrong section and misspelled settings are refused.

dryRun
boolean

Present and true when nothing was saved.