Update a product

curl --request PATCH \
  --url https://sandboxapi.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"
  ]
}
'

import requests

url = "https://sandboxapi.kelviq.com/api/v1/catalog/products/{pk}/"

payload = {
    "name": "Pro Suite v2",
    "description": "Updated description.",
    "taxCode": "saas",
    "imageKeys": ["tmp/new-hero.jpg"],
    "fileKeys": ["tmp/changelog.pdf"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Pro Suite v2',
    description: 'Updated description.',
    taxCode: 'saas',
    imageKeys: ['tmp/new-hero.jpg'],
    fileKeys: ['tmp/changelog.pdf']
  })
};

fetch('https://sandboxapi.kelviq.com/api/v1/catalog/products/{pk}/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandboxapi.kelviq.com/api/v1/catalog/products/{pk}/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Pro Suite v2',
    'description' => 'Updated description.',
    'taxCode' => 'saas',
    'imageKeys' => [
        'tmp/new-hero.jpg'
    ],
    'fileKeys' => [
        'tmp/changelog.pdf'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://sandboxapi.kelviq.com/api/v1/catalog/products/{pk}/"

	payload := strings.NewReader("{\n  \"name\": \"Pro Suite v2\",\n  \"description\": \"Updated description.\",\n  \"taxCode\": \"saas\",\n  \"imageKeys\": [\n    \"tmp/new-hero.jpg\"\n  ],\n  \"fileKeys\": [\n    \"tmp/changelog.pdf\"\n  ]\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://sandboxapi.kelviq.com/api/v1/catalog/products/{pk}/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Pro Suite v2\",\n  \"description\": \"Updated description.\",\n  \"taxCode\": \"saas\",\n  \"imageKeys\": [\n    \"tmp/new-hero.jpg\"\n  ],\n  \"fileKeys\": [\n    \"tmp/changelog.pdf\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandboxapi.kelviq.com/api/v1/catalog/products/{pk}/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Pro Suite v2\",\n  \"description\": \"Updated description.\",\n  \"taxCode\": \"saas\",\n  \"imageKeys\": [\n    \"tmp/new-hero.jpg\"\n  ],\n  \"fileKeys\": [\n    \"tmp/changelog.pdf\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "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
    }
  ]
}

PATCH

catalog

products

{pk}

Update a product

curl --request PATCH \
  --url https://sandboxapi.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"
  ]
}
'

import requests

url = "https://sandboxapi.kelviq.com/api/v1/catalog/products/{pk}/"

payload = {
    "name": "Pro Suite v2",
    "description": "Updated description.",
    "taxCode": "saas",
    "imageKeys": ["tmp/new-hero.jpg"],
    "fileKeys": ["tmp/changelog.pdf"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Pro Suite v2',
    description: 'Updated description.',
    taxCode: 'saas',
    imageKeys: ['tmp/new-hero.jpg'],
    fileKeys: ['tmp/changelog.pdf']
  })
};

fetch('https://sandboxapi.kelviq.com/api/v1/catalog/products/{pk}/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandboxapi.kelviq.com/api/v1/catalog/products/{pk}/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Pro Suite v2',
    'description' => 'Updated description.',
    'taxCode' => 'saas',
    'imageKeys' => [
        'tmp/new-hero.jpg'
    ],
    'fileKeys' => [
        'tmp/changelog.pdf'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://sandboxapi.kelviq.com/api/v1/catalog/products/{pk}/"

	payload := strings.NewReader("{\n  \"name\": \"Pro Suite v2\",\n  \"description\": \"Updated description.\",\n  \"taxCode\": \"saas\",\n  \"imageKeys\": [\n    \"tmp/new-hero.jpg\"\n  ],\n  \"fileKeys\": [\n    \"tmp/changelog.pdf\"\n  ]\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://sandboxapi.kelviq.com/api/v1/catalog/products/{pk}/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Pro Suite v2\",\n  \"description\": \"Updated description.\",\n  \"taxCode\": \"saas\",\n  \"imageKeys\": [\n    \"tmp/new-hero.jpg\"\n  ],\n  \"fileKeys\": [\n    \"tmp/changelog.pdf\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandboxapi.kelviq.com/api/v1/catalog/products/{pk}/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Pro Suite v2\",\n  \"description\": \"Updated description.\",\n  \"taxCode\": \"saas\",\n  \"imageKeys\": [\n    \"tmp/new-hero.jpg\"\n  ],\n  \"fileKeys\": [\n    \"tmp/changelog.pdf\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "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
    }
  ]
}

Click the base URL in the API playground and select the Sandbox host for test data or the Production host for live data. Use credentials from the same environment.

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

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.

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

Show child attributes

Get Started

API Documentation

Update a product

Authorizations

Path Parameters

Body

Response