POST/hyax-api/v1/helpdesk/articles

Create helpdesk article

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

Request body

Field	Required	Description
title	Yes
content	Yes	HTML content
excerpt	No	Short summary (max 500 chars)
status	No	`DRAFT` (default) \| `PUBLISHED`
categoryId	No	Category ID; defaults to first category
slug	No	Auto-generated from title if omitted

Request examples

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

curl -X POST 'https://platform.hyax.com/hyax-api/v1/helpdesk/articles' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "title": "How to reset your password",
    "content": "<h2>Reset steps</h2><p>Go to Settings → Security…</p>",
    "excerpt": "Step-by-step password reset guide",
    "status": "DRAFT",
    "categoryId": "clx_cat_basics",
    "slug": "how-to-reset-your-password"
  }'

Example response

Shape varies by data; values are illustrative.

{
  "success": true,
  "data": {
    "id": "clx…",
    "title": "How to reset your password",
    "slug": "how-to-reset-your-password",
    "status": "DRAFT",
    "categoryId": "clx…",
    "order": 0,
    "createdAt": "2025-01-15T12:00:00.000Z"
  }
}