Publishing

Restore an FAQ item’s previous publish

Puts the previously published version back as the published document. Answers it; 400 invalid when there is none.

Access: an API key with content:faq-items:publish (or a master above it: content:faq-items:all, content:all, admin:all). A signed-in person may call it as far as their own permissions allow; anyone else gets 403.

Rate limit: the key’s own writes-per-minute limit, set when the key is created (default 120); over it, 429 with Retry-After.

POST

faq-item

{_id}

revert-published-to-previous

cURL

curl --request POST \
  --url https://{host}/api/v1/faq-item/{_id}/revert-published-to-previous \
  --header 'Authorization: <api-key>'

import { createSiteClient } from '@fetchski/attract-cms-sdk';

const site = createSiteClient();
const faqItem = await site.faqItems().revertFaqItemPublishedToPrevious({ id: 'clx8m2k4p0000a1b2c3d4e5f6' });

{
  "title": "",
  "answer": {
    "items": [
      {
        "type": "@apostrophecms/rich-text",
        "content": "<p>Hello from the API.</p>"
      }
    ]
  },
  "slug": "",
  "_id": "<string>",
  "type": "<string>",
  "_category": [
    {}
  ],
  "featured": false,
  "sortOrder": 0,
  "visibility": "public",
  "scheduledPublish": "<string>",
  "scheduledUnpublish": "<string>",
  "faqFontOverrides": [],
  "source": "manual",
  "sourceId": "",
  "archived": false,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "aposShareKey": "k3v9x2m7q1z8w4p6"
}

{
  "name": "<string>",
  "message": "<string>",
  "data": {}
}

{
  "name": "<string>",
  "message": "<string>",
  "data": {}
}

{
  "name": "<string>",
  "message": "<string>",
  "data": {}
}

{
  "name": "<string>",
  "message": "<string>",
  "data": {}
}

{
  "name": "<string>",
  "message": "<string>",
  "data": {}
}

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:publish

Path Parameters

_id

string

required

The document’s _id: a full id names its own locale and mode (the draft’s …:en:draft, the published one’s …:en:published; no aposMode needed), a bare aposDocId takes the request’s (aposLocale, aposMode).

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.

Show child attributes

Example:

{
  "items": [
    {
      "type": "@apostrophecms/rich-text",
      "content": "<p>Hello from the API.</p>"
    }
  ]
}

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

Show child attributes

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).

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"

cURL

curl --request POST \
  --url https://{host}/api/v1/faq-item/{_id}/revert-published-to-previous \
  --header 'Authorization: <api-key>'

import { createSiteClient } from '@fetchski/attract-cms-sdk';

const site = createSiteClient();
const faqItem = await site.faqItems().revertFaqItemPublishedToPrevious({ id: 'clx8m2k4p0000a1b2c3d4e5f6' });

{
  "title": "",
  "answer": {
    "items": [
      {
        "type": "@apostrophecms/rich-text",
        "content": "<p>Hello from the API.</p>"
      }
    ]
  },
  "slug": "",
  "_id": "<string>",
  "type": "<string>",
  "_category": [
    {}
  ],
  "featured": false,
  "sortOrder": 0,
  "visibility": "public",
  "scheduledPublish": "<string>",
  "scheduledUnpublish": "<string>",
  "faqFontOverrides": [],
  "source": "manual",
  "sourceId": "",
  "archived": false,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "aposShareKey": "k3v9x2m7q1z8w4p6"
}

{
  "name": "<string>",
  "message": "<string>",
  "data": {}
}

{
  "name": "<string>",
  "message": "<string>",
  "data": {}
}

{
  "name": "<string>",
  "message": "<string>",
  "data": {}
}

{
  "name": "<string>",
  "message": "<string>",
  "data": {}
}

{
  "name": "<string>",
  "message": "<string>",
  "data": {}
}

Get started

How the API works

Pages & Site

Content

Media

Forms

Ads & Conversions

Analytics

Signing in (people)

Restore an FAQ item’s previous publish

Authorizations

Scopes

Path Parameters

Response