FAQs

The FAQ knowledge base is a curated list of question/answer pairs. Published
entries are suggested to customers as they type a ticket subject, are served on
their own pages on the docs micro-site, and are grounding material for the AI
assistant — so a good FAQ set measurably reduces tickets.

All paths below are relative to https://api-v1.zingasuite.com/papi/v1.

Method	Path	Purpose
`GET`	`/solve/faqs`	List FAQs
`POST`	`/solve/faqs`	Create a FAQ
`GET`	`/solve/faqs/{id}`	Read a FAQ
`PATCH`	`/solve/faqs/{id}`	Update a FAQ
`DELETE`	`/solve/faqs/{id}`	Delete a FAQ

List filters: status (draft | published), q (question substring), plus
limit / offset.

curl -X POST https://api-v1.zingasuite.com/papi/v1/solve/faqs \
  -H "Authorization: Bearer zk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
        "question": "How often should the filter be replaced?",
        "answer": "Every **500 operating hours**, or sooner in dusty conditions.",
        "answerFormat": "md",
        "status": "published",
        "sortOrder": 1
      }'

Fields:

Field	Notes
`question`	Required, up to 500 characters
`answer`	Markdown by default (`answerFormat`: `md` or `html`)
`slug`	Defaults to a slugified question; used in the public URL
`locale`	Defaults to `en`
`status`	`draft` (default) or `published` — only published entries are suggested and served
`spaceId`	Optionally scope the FAQ to one documentation space
`sortOrder`	Ordering within the list

Responses also carry the read-only engagement counters viewCount,
helpfulUp and helpfulDown, so you can find the entries that need rewriting.

PATCH is a partial update — only the fields you send change, so flipping an
entry live is a one-field call:

curl -X PATCH https://api-v1.zingasuite.com/papi/v1/solve/faqs/<id> \
  -H "Authorization: Bearer zk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{"status": "published"}'