← Home
—/hyax-api/mcp

Available MCP tools

59 tools covering team stats, posts, landing pages, people, the full product catalogue (options, variants, categories, publishing), webhook schema discovery, email marketing, automations, community, and media uploads. All are team-scoped via the API key. Use tools/list for live schemas.

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

Request

# This route is session-based, multipart, or provider-specific.
# Inspect: apps/web/server/routes/hyax-api/

Response

Team
  team_summary. Content counts (posts, people, products, etc.)

Posts
  posts_list, List posts (status, postType, search, slug filters)
  posts_get. Get post by ID or slug (includes content)
  posts_update. Update title, content, status, tags, pricing, etc.
  posts_archive, Archive a post
  posts_delete, Permanently delete a post

Landing pages
  landing_pages_list, List pages (status, builder mode, search, slug filters)
  landing_pages_get. Get complete page content and configuration
  landing_pages_update. Update a page and automatically create a rollback version

People
  people_list, List CRM contacts (category, tag, search filters)
  people_get. Get person by ID
  people_get_by_email. Look up person by email
  people_add. Create or return existing person
  people_update. Update profile fields
  people_delete. Delete person
  people_add_tags. Add tags (by email or personId)
  people_remove_tags. Remove tags (by email or personId)

Products
  products_list, List products (type, active, archived, search)
  products_get. Get product by ID or slug, with options, variants and buy URLs
  products_create. Create a product (draft unless it already passes readiness)
  products_update. Update title, pricing, active status, etc.
  products_publish_readiness. What is still blocking publication
  products_publish, Take a product live
  products_unpublish, Return a product to draft
  products_archive, Archive a product (reversible)
  products_restore, Bring an archived product back as a draft

Product options and variants
  product_options_get. Get the dimensions buyers choose from
  product_options_update. Replace the option grid (names alone are enough)
  product_variants_generate. Create one variant per combination
  product_variants_list, List variants, each with its own buy URL
  product_variants_get. Get a variant by id, SKU code or title
  product_variants_create. Add a single variant
  product_variants_update. Change code, label, price, stock or image
  product_variants_delete, Retire a variant (force to hard-delete)
  product_variants_restore, Put a retired variant back on sale
  product_variants_reorder. Set display order and the default variant

Product categories
  product_categories_list, List categories with product counts
  product_categories_create. Create a category
  product_categories_update. Rename a category
  product_categories_delete, Delete a category (products become uncategorised)

Webhooks
  webhooks_schema. Events, delivery contract, order.created schema, sample payload
  webhooks_integration_brief. Markdown brief for writing the receiving endpoint

Email
  email_list_broadcasts, List broadcasts
  email_get_broadcast. Get broadcast/email by ID
  email_list_sequences, List drip sequences
  email_get_sequence. Get sequence with emails and triggers
  email_send. Send transactional email
  email_enroll_in_sequence, Enroll subscriber in a sequence

Automations
  automations_list, List workflows
  automations_get. Get automation with nodes and edges
  automations_create. Create new automation (DRAFT)
  automations_update. Update name or description
  automations_toggle, Activate or pause

Community
  community_list_categories, List forum categories and forums
  community_list_forums, List forums
  community_list_threads, List threads
  community_get_thread. Get thread with replies
  community_get_settings. Get community access settings

Media
  media_upload_from_url. Upload an image from a URL (http/https or data:image base64) and return the CDN URL