Create an FAQ entry
/support/faqsCreates an FAQ entry with a question and its answer.
Entries are created as drafts unless status is set to published. Creating a published entry also requires the faqs.publish permission.
Groups are labels: a group exists as soon as an entry is assigned to it, so there is no separate operation to create one.
Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.
In: header
Header Parameters
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
curl -X POST "https://example.com/support/faqs" \ -H "Idempotency-Key: string" \ -H "Content-Type: application/json" \ -d '{ "answer": {}, "question": "string" }'List FAQ entries GET
Lists the FAQ entries of the current account. The collection can be filtered by group and status. Entries are sorted by group name, with ungrouped entries last, and then by position within each group. All matching entries are returned in a single response. Collection items do not include the answer. Use the retrieve operation to obtain it.
Reorder FAQ entries PUT
Replaces the order of the FAQ entries within a single group. Identify the group in `group`; omit it or send `null` to reorder the entries without a group. `ids` must list the public IDs of every entry in that group exactly once, in the desired order. If the supplied IDs do not match the entries in the group, the API returns `order_set_mismatch` and the existing order remains unchanged.