PATCH/hyax-api/v1/community/threads/:id

Update forum thread

Send only changed fields. Slug must be unique within the forum (409 if taken).

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
slug	No	Must be unique in forum
status	No	`ACTIVE` \| `ARCHIVED` \| `DRAFT`
isPinned	No	Boolean
isLocked	No	Boolean

Request examples

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

curl -X PATCH 'https://platform.hyax.com/hyax-api/v1/community/threads/clx_example_id' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "status": "ARCHIVED",
    "isLocked": true
  }'

Example response

Shape varies by data; values are illustrative.

{
  "success": true,
  "data": {
    "id": "clx…",
    "title": "Welcome thread",
    "slug": "welcome-thread",
    "status": "ARCHIVED",
    "isPinned": false,
    "isLocked": true,
    "forum": { "id": "clx…", "name": "Announcements", "slug": "announcements" },
    "createdAt": "2025-01-15T12:00:00.000Z",
    "updatedAt": "2025-01-16T09:00:00.000Z"
  }
}