Skip to main content
PATCH
Update Tracked Product

Authorizations

X-API-Key
string
header
required

API key for authentication. Get yours from the Promptwatch dashboard under Settings > API Keys.

Path Parameters

id
string<uuid>
required

Tracked product identifier

Body

application/json
name
string
required

Product name

Required string length: 1 - 500
description
string | null

Optional product description

Maximum string length: 2000

Response

Default Response

id
string<uuid>
required

Tracked product identifier

externalProductId
string
required

Catalog product id supplied on upload

name
string
required

Product name

description
string | null
required

Product description

createdAt
string<date-time>
required

When the tracked product was created

updatedAt
string<date-time>
required

When the tracked product was last updated

shoppingItem
object | null
required

Matched extracted product, or null while unmatched