Skip to main content
POST
Upsert an image by your own key

Authorizations

Authorization
string
header
required

Workspace-scoped API key (mk_live_...). Each operation lists the scope it requires in x-required-scopes. See the Authentication guide for the full scope table and key management.

Body

application/json
merge_key
string
required

A defined text-family attribute key to match on (e.g. sku).

attributes
object
required

Map of attribute key → new value (sparse — only keys being written). Scalars set the value; null OR "" clears it (the key then disappears from reads). A single-reference key accepts a bare UUID string or an {id} object; a list-reference key accepts an array of either — list writes REPLACE the current set. Read stubs re-sent verbatim are valid writes (extra stub fields like type/label are ignored). Unknown keys are a 400; select values must be one of the attribute's acceptable_values.

parent_id
string<uuid> | null

Response

An existing image matched and was updated (full resource).

data
object

The one shape for every entity read and mutation response. System fields live at the top level; every customer-defined key lives in attributes, so customer keys can never collide with system ones.

Example: