PATCH/hyax-api/v1/helpdesk/articles/:id

Update helpdesk article

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

Request body

Field	Required	Description
title	No
content	No	HTML content
excerpt	No
status	No	`DRAFT` \| `PUBLISHED`
categoryId	No
slug	No
order	No	Sort order within category

Request examples

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

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

Example response

Shape varies by data; values are illustrative.

{
  "success": true,
  "data": {
    "id": "clx…",
    "title": "Getting started",
    "slug": "getting-started",
    "status": "PUBLISHED",
    "categoryId": "clx…",
    "order": 0,
    "updatedAt": "2025-01-15T12:00:00.000Z"
  }
}