Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Paste your API key as the CMS showed it: fsk_<site>_<key id>_<secret> (issued under API Keys). ApiKey in front of it works too. Leave it empty to read as the public.

Scopes

content:faq-items:write

Path Parameters

_id
string
required

The draft’s exact _id (…:en:draft).

Body

application/json

Whether the draft can be previewed through a share link.

share
boolean

true adds a share key (aposShareKey) to the draft; false (the default) removes it.

Response

Done.

FaqItem content type

title
string
default:""
required

The question exactly as a visitor would ask it — it renders as the accordion row and in the page’s FAQ structured data.

answer
Answer · object
required

Widgets, top to bottom: send { "items": [ … ] }, one object per widget with its type. Writing it replaces the whole area.

Example:
slug
string
default:""
required

The URL name: lowercase words joined by hyphens (letters outside a–z, even emoji, are kept).

_id
string
required
read-only

The document’s id. On a type with drafts it ends in its locale and mode (…:en:published, …:en:draft): the part before the first colon is its aposDocId, shared by both copies. The {_id} the type’s routes take.

type
string
required
read-only

The document type’s name: always this type’s.

_category
Category · object[] | null

Optional. FAQ sections can group questions under category subheadings and filter to specific categories. Manage the list under FAQ Categories. The related faq-category documents, in order (empty when none). To set it, send a list of { "_id": "…" }, one per document (one at most); a document the site can’t find is left out.

Maximum array length: 1
featured
boolean | null
default:false

Hand-curation flag: FAQ sections can show only featured questions — e.g. a short top-questions block on the home page.

sortOrder
integer | null
default:0

Questions are listed lowest number first — the explicit FAQ order.

visibility
enum<string> | null
default:public

Select whether this content is public or private

Available options:
public,
loginRequired,
null
scheduledPublish
string | null

An ISO 8601 date and time, e.g. 2026-10-21T14:30:00.000Z.

scheduledUnpublish
string | null

An ISO 8601 date and time, e.g. 2026-10-21T14:30:00.000Z.

faqFontOverrides
Typeface for this card · object[] | null

Optional. Set part of this question’s card in a different typeface. Leave empty to follow the section (and the site fonts).

Maximum array length: 4
source
enum<string> | null
default:manual
read-only

Set automatically. Demo placeholders are removed the moment a real question is published.

Available options:
manual,
demo,
null
sourceId
string | null
default:""
read-only

Internal de-duplication key set by the demo seed.

archived
boolean | null
default:false

In the archive: kept, but out of every list and off the site until it is restored. false (or null) for a live document.

createdAt
string<date-time> | null
read-only

When it was created (ISO 8601).

updatedAt
string<date-time> | null
read-only

When it last changed (ISO 8601).

aposShareKey
string | null
read-only

The draft’s preview share key, while its share link is on: the link is the draft’s _url with aposShareKey and aposShareId (the draft’s _id) in its query. Absent otherwise, and on published documents.

Example:

"k3v9x2m7q1z8w4p6"