Skip to main content
PATCH
/
catalog
/
products
/
{pk}
/
Update a product
curl --request PATCH \
  --url https://api.kelviq.com/api/v1/catalog/products/{pk}/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Pro Suite v2",
  "description": "Updated description.",
  "taxCode": "saas",
  "imageKeys": [
    "tmp/new-hero.jpg"
  ],
  "fileKeys": [
    "tmp/changelog.pdf"
  ]
}
'
{
  "id": "0d65f7c0-7e91-4f56-9b32-13a9a6a7c1de",
  "identifier": "pro-suite",
  "name": "Pro Suite",
  "description": "Premium tools for growing teams.",
  "taxCode": "saas",
  "createdBy": "Jane Smith",
  "modifiedOn": "2025-04-12T08:21:14.910Z",
  "images": [
    {
      "id": "1f7e1b54-7c6f-4d7e-9a4f-2c9c2d8b9d31",
      "name": "hero-banner.png",
      "image": "media/.../products/<id>/<uuid>/hero-banner.png",
      "ordering": 0,
      "thumbnail": true,
      "enabled": true
    }
  ]
}

Authorizations

​
Authorization
string
header
required

The Server API Key obtained from the kelviq application. Pass as a Bearer token in the Authorization header. Example: 'Authorization: Bearer YOUR_API_KEY'

Path Parameters

​
pk
string<uuid>
required

Product UUID.

Body

application/json

Payload for PATCH /products/{id}/. Most identifying fields are read-only.

​
name
string
Example:

"Pro Suite v2"

​
description
string
Example:

"Updated description."

​
taxCode
enum<string>

Tax code for the product. Must be one of the supported values.

Available options:
saas,
saas_business,
software,
videocontent,
informationservice,
ebook,
digitalgraphic,
videogame,
eservice,
training
Example:

"saas"

​
imageKeys
string[]

Additional temporary S3 keys to append to the product's images.

Example:
["tmp/new-hero.jpg"]
​
fileKeys
string[]
Example:
["tmp/changelog.pdf"]

Response

Updated product.

A product in the catalog. Each product can have multiple plans, images and files.

​
id
string<uuid>
read-only
Example:

"0d65f7c0-7e91-4f56-9b32-13a9a6a7c1de"

​
identifier
string

Human-readable, URL-safe slug. Auto-generated from name if omitted on create.

Example:

"pro-suite"

​
name
string
Example:

"Pro Suite"

​
description
string
Example:

"Premium tools for growing teams."

​
taxCode
enum<string>

Tax code for the product. Must be one of the supported values.

Available options:
saas,
saas_business,
software,
videocontent,
informationservice,
ebook,
digitalgraphic,
videogame,
eservice,
training
Example:

"saas"

​
createdBy
string
read-only

Display name of the user who created the product.

Example:

"Jane Smith"

​
modifiedOn
string<date-time>
read-only
Example:

"2025-04-12T08:21:14.910Z"

​
images
object[]
read-only