Developers
FAQs6

Create an FAQ entry

POST/support/faqs

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.

Authorization

AuthorizationBearer <token>

Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.

In: header

Header Parameters

Idempotency-Key*string

Client-generated key that makes the request safe to retry. Must be 1 to 128 characters from [A-Za-z0-9._:-]. Required by this operation: a missing key returns idempotency_key_required, and a malformed key returns idempotency_key_invalid. Repeating the request with the same key and the same body returns the stored result with Idempotent-Replayed: true.

X-Client-Request-Id?string

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.

Lengthlength <= 64

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

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"  }'
{  "data": {    "answer": {      "blocks": [        {}      ]    },    "created_at": "2019-08-24T14:15:22Z",    "group": "string",    "id": "string",    "object": "faq",    "position": 0,    "question": "string",    "revision": "string",    "status": "draft",    "updated_at": "2019-08-24T14:15:22Z"  }}

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.