Reorder FAQ entries
/support/faqs/orderReplaces 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.
Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.
In: header
Header Parameters
Client-generated key that makes the request safe to retry. Must be 1 to 128 characters from [A-Za-z0-9._:-]. Optional on this operation; when sent, a malformed key returns idempotency_key_invalid, and repeating the request with the same key and the same body returns the stored result with Idempotent-Replayed: true.
Optional client-generated identifier of the request, up to 64 characters from [A-Za-z0-9._-]. Echoed back in the response and recorded in the request log; it never replaces the server-generated X-Request-Id.
length <= 64Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X PUT "https://example.com/support/faqs/order" \ -H "Content-Type: application/json" \ -d '{ "ids": [ "string" ] }'Create an FAQ entry POST
Creates 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.
Retrieve an FAQ entry GET
Retrieves an FAQ entry by its public ID, including the answer content in `answer.blocks`. The response includes an `ETag` representing the current revision. Send this value in the `If-Match` header when updating the entry to avoid overwriting a newer version.