PATCH/hyax-api/v1/settings

Update site settings

Writable via API: branding text (siteName, title, description, brandingText, brandingSubheadline), logo/favicon/featuredImage URLs, theme + basic colors (accentColor, backgroundColor, textColor, nav/button colors), fonts, social/contact links, links-page toggles, helpdeskTitle/helpdeskSubtitle, hasFooter, useLinksAsHomepage. Read-only via API: feature flags (has*), analytics IDs/tokens, shortUrlDomain, customHomepageLandingPageId, sidebarOrder, contentSections, sitemapEnabled, autoAltTextMode, detailed style tokens.

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

Request examples

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

curl -X PATCH 'https://platform.hyax.com/hyax-api/v1/settings' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "siteName": "Acme Blog",
    "socialTwitter": "https://x.com/acme",
    "linksPageShowSubscribe": true
  }'

Example response

Shape varies by data; values are illustrative.

{
  "success": true,
  "updatedFields": ["siteName", "socialTwitter", "linksPageShowSubscribe"],
  "data": { "siteName": "Acme Blog", "socialTwitter": "https://x.com/acme" }
}