Skip to content

UpsertComponentInput ​

Type: Input

Input for creating or updating a component

Fields ​

NameTypeDefaultDescription
actualSubstrateIdSubstrateIDActual substrate/paper ID
colorsComponentColorInfoInputColor specification for front and back
componentGroupIdComponentGroupIDParent component group ID (optional — leave nil for ungrouped components)
createdAtISO8601Override creation timestamp (ISO8601). Honored only on create — passing on update is rejected.
descriptionStringComponent description
desiredSubstrateIdSubstrateIDDesired substrate/paper ID
externalIdStringExternal system ID
finishedSizeJSONFinished size after trimming (JSON)
finishingFinishingSpecInputFinishing specification (varnish, die, foil, emboss)
idComponentIDID for update; omit for create
jobIdJobID!Parent job ID (required)
kindComponentKind!Component classification (required)
layoutComponentLayoutInputLayout specification with layers
mediaJSONMedia/paper specification (JSON)
nameString!Component name (required)
quantityInt!Number of units (required)
sortOrderIntSort order (defaults to 0)
totalPagesIntTotal number of pages
updatedAtISO8601Override update timestamp (ISO8601). Honored on create or update; defaults to now.

Connect machines, automate workflows, and build custom apps for print production.