Skip to main content
PUT
Map a product to a workflow

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 product id, as your store knows it (Shopify: the numeric product 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

Which workflow a product in your store uses. The storefront Element loads the mapped workflow on that product's page, and the workflow's intake rule decides which files the customer can upload. A product can use one workflow for every variant, or a different workflow per variant (for example one per size); a variant without its own workflow uses the product's. The id in the path is the product id as your store knows it (Shopify: the numeric product id). On WooCommerce, PrestaShop and OpenCart the product's workflow is set in the FileCheck plugin's product settings instead.

workflowId
string
required

The published workflow every variant uses unless it has its own. null when only variants are mapped.

Minimum string length: 1
title
string

The product title, shown in the dashboard's product list.

Maximum string length: 300
url
string<uri> | null

The product's storefront page, so the dashboard can link to where the upload form now appears.

Maximum string length: 2048
variants
object

Per-variant workflows, keyed by the variant id as your store knows it (Shopify: the numeric variant id). Sending this replaces the whole set; leave it out to keep the stored one.

Response

OK

productMap
Product mapping · object

Which workflow a product in your store uses. The storefront Element loads the mapped workflow on that product's page, and the workflow's intake rule decides which files the customer can upload. A product can use one workflow for every variant, or a different workflow per variant (for example one per size); a variant without its own workflow uses the product's. The id in the path is the product id as your store knows it (Shopify: the numeric product id). On WooCommerce, PrestaShop and OpenCart the product's workflow is set in the FileCheck plugin's product settings instead.

dryRun
boolean

Present and true when nothing was saved.