Skip to main content
PATCH
/
api
/
v1
/
items
/
{id}
curl --request PATCH \
  --url https://integrations.polinate.ai/api/v1/items/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <x-api-key>' \
  --header 'X-Business-Id: <x-business-id>' \
  --data '
{
  "name": "Updated Widget Name",
  "description": "Updated description"
}
'
{
  "id": "itm_123",
  "name": "Updated Widget Name",
  "handle": "widget-1"
}

Headers

​
X-Business-Id
string
required

Business identifier for external auth. Find in Polinate app → Business Settings → Integrations.

Example:

"{{businessId}}"

​
X-API-Key
string
required

Per-business API key for external auth. Find in Polinate app → Business Settings → Integrations.

Example:

"{{apiKey}}"

​
Idempotency-Key
string

Idempotency key for POST operations

Example:

"{{idempotencyKey}}"

Path Parameters

​
id
string
required
Example:

"itm_123"

Body

application/json
​
name
string
​
description
string | null
​
imgUrl
string<uri> | null
​
customType
string | null
​
brand
string | null
​
vendorName
string | null
​
status
enum<string>
Available options:
ACTIVE,
DRAFT,
ARCHIVED,
DELETED
​
properties
object
​
createVariants
object[]
​
updateVariants
object[]
​
deleteVariants
string[]

Response

OK

​
id
string
required
​
name
string
required
​
handle
string
required
​
description
string | null
​
imgUrl
string | null
​
customType
string | null
​
brand
string | null
​
vendorName
string | null
​
type
string
​
status
string
​
properties
object
​
createdAt
string
​
updatedAt
string
​
deletedAt
string | null
​
variants
object[]