PATCH/hyax-api/v1/navigation

Update navigation links

Batch create, update, delete, or reorder links. All operations run in one transaction. CATEGORY links require categoryId; PAGE links require a published pageId.

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

Request body

Field	Required	Description
linkPlacement	No	`HEADER` (default) or `FOOTER`
create	No	Array of { label, order, url?, navigationType?, parentId?, categoryId?, pageId? }
update	No	Array of { id, label?, url?, order?, … }
deleteIds	No	Array of link IDs to delete
reorder	No	Array of { id, order, parentId? }

Request examples

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

curl -X PATCH 'https://platform.hyax.com/hyax-api/v1/navigation' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "linkPlacement": "HEADER",
    "create": [
      {
        "label": "Pricing",
        "url": "/pricing",
        "order": 3
      }
    ],
    "reorder": [
      {
        "id": "clx…",
        "order": 0
      }
    ]
  }'

Example response

Shape varies by data; values are illustrative.

{
  "success": true,
  "summary": { "created": 1, "updated": 0, "deleted": 0, "reordered": 1 },
  "linkPlacement": "HEADER",
  "data": []
}