PATCH/hyax-api/v1/products/:id

Update product

Update safe product fields: title, slug, description, type, pricingType, price, currency, isActive, categoryId, membership/meeting fields, productSpecs. Does not modify course modules, SKUs, or media.

Base URL: https://platform.hyax.com · Replace YOUR_API_KEY with your team API key.

Request body

Field	Required	Description
title	No
slug	No
description	No
type	No	`DIGITAL` \| `PHYSICAL` \| `COURSE` \| `EVENT` \| `MEMBERSHIP` \| `MEETING`
pricingType	No	`SINGLE` \| `SUBSCRIPTION` \| `PAY_WHAT_YOU_WANT` \| `FREE`
price	No	Number or null
currency	No	Default team currency
isActive	No	Boolean
categoryId	No	Category ID or null to clear

Request examples

Same request in cURL, Node.js (fetch), and PHP (ext-curl).

curl -X PATCH 'https://platform.hyax.com/hyax-api/v1/products/clx_example_id' \
  -H 'Authorization: Bearer YOUR_API_KEY'

Example response

Shape varies by data; values are illustrative.

{
  "success": true,
  "data": {
    "id": "clx…",
    "title": "Pro plan",
    "slug": "pro-plan",
    "type": "MEMBERSHIP",
    "pricingType": "SUBSCRIPTION",
    "price": 99,
    "currency": "USD",
    "isActive": true,
    "isArchived": false,
    "createdAt": "2025-01-15T12:00:00.000Z",
    "updatedAt": "2025-01-16T08:00:00.000Z"
  }
}