Share an FAQ item’s draft

use Fetchski\AttractCmsLaravel\Facades\Attract;

$faqItem = Attract::faqItems()->shareFaqItem(id: 'clx8m2k4p0000a1b2c3d4e5f6');

{
  "title": "Example title",
  "answer": {
    "metaType": "area",
    "_id": "clx8m2k4p0000a1b2c3d4e5f6",
    "items": [
      {
        "type": "@apostrophecms/rich-text",
        "_id": "clx8m2k4p0000a1b2c3d4e5f6",
        "metaType": "widget",
        "content": "<p>Hello from the API.</p>",
        "sectionCss": {
          "slots": {
            "key": "Example value"
          },
          "css": "Example css",
          "mark": "Example mark"
        }
      }
    ]
  },
  "_category": [
    {}
  ],
  "featured": false,
  "sortOrder": 0,
  "slug": "example-slug",
  "visibility": "public",
  "scheduledPublish": "Example scheduled publish",
  "scheduledUnpublish": "Example scheduled unpublish",
  "faqFontOverrides": [],
  "source": "manual",
  "sourceId": "clx8m2k4p0000a1b2c3d4e5f6",
  "archived": false,
  "_id": "clx8m2k4p0000a1b2c3d4e5f6",
  "type": "Example type",
  "createdAt": "2026-10-24T09:30:00.000Z",
  "updatedAt": "2026-10-24T09:30:00.000Z",
  "aposShareKey": "k3v9x2m7q1z8w4p6"
}

use Fetchski\AttractCmsLaravel\Facades\Attract;

$faqItem = Attract::faqItems()->shareFaqItem(id: 'clx8m2k4p0000a1b2c3d4e5f6');

{
  "title": "Example title",
  "answer": {
    "metaType": "area",
    "_id": "clx8m2k4p0000a1b2c3d4e5f6",
    "items": [
      {
        "type": "@apostrophecms/rich-text",
        "_id": "clx8m2k4p0000a1b2c3d4e5f6",
        "metaType": "widget",
        "content": "<p>Hello from the API.</p>",
        "sectionCss": {
          "slots": {
            "key": "Example value"
          },
          "css": "Example css",
          "mark": "Example mark"
        }
      }
    ]
  },
  "_category": [
    {}
  ],
  "featured": false,
  "sortOrder": 0,
  "slug": "example-slug",
  "visibility": "public",
  "scheduledPublish": "Example scheduled publish",
  "scheduledUnpublish": "Example scheduled unpublish",
  "faqFontOverrides": [],
  "source": "manual",
  "sourceId": "clx8m2k4p0000a1b2c3d4e5f6",
  "archived": false,
  "_id": "clx8m2k4p0000a1b2c3d4e5f6",
  "type": "Example type",
  "createdAt": "2026-10-24T09:30:00.000Z",
  "updatedAt": "2026-10-24T09:30:00.000Z",
  "aposShareKey": "k3v9x2m7q1z8w4p6"
}

In your app

A controller answers a route on your app: it calls shareFaqItem() and returns the answer.

Add the controller

app/Http/Controllers/ShareFaqItemController.php

<?php

declare(strict_types=1);

namespace App\Http\Controllers;

use Fetchski\AttractCmsLaravel\Data\FaqItem;
use Fetchski\AttractCmsLaravel\Facades\Attract;

final class ShareFaqItemController
{
    public function __invoke(string $id): FaqItem
    {
        return Attract::faqItems()->shareFaqItem(id: $id);
    }
}

Add the route

routes/web.php

use App\Http\Controllers\ShareFaqItemController;
use Illuminate\Support\Facades\Route;

Route::post('/faq-item/{id}/share', ShareFaqItemController::class)->middleware('auth');

It acts with your key’s access, so auth lets only your signed-in users reach it.

Call it

Your own page’s form or script sends POST /faq-item/clx8m2k4p0000a1b2c3d4e5f6/share (a form adds @csrf, as every web route checks it), and gets back its answer as JSON. Test it, below, calls it.

To keep the call in an Action instead, this writes app/Actions/Attract/ShareFaqItem.php (an invokable Action that calls shareFaqItem()) and its test under tests/Feature/Actions/Attract/ (Pest when your app has it):

Terminal

php artisan make:attract-action faqItems.shareFaqItem

Call it from the terminal

Terminal

php artisan attract:call faqItems.shareFaqItem id=clx8m2k4p0000a1b2c3d4e5f6

It calls shareFaqItem() on your default site and prints its answer as JSON. It writes, so it asks first: add --force to skip the question in a script. See Call any method from the terminal for every argument type. Takes the draft’s exact _id (…:en:draft). Answers the draft, with its aposShareKey while the link is on: the link is the draft’s _url with aposShareKey and aposShareId (the draft’s _id) in its query.

Find the id

id is the document’s _id, from a list. Ask the list for only the fields you need: each row is a document’s id and those fields.

Laravel

use Fetchski\AttractCmsLaravel\Facades\Attract;

$row = Attract::faqItems()->listFaqItemsPick(fields: ['title', 'slug'])->firstWhere('slug', 'getting-started'); // ['id' => …, 'title' => …, 'slug' => …], or null

Terminal

php artisan attract:call faqItems.listFaqItemsPick fields=title,slug

Pass $row['id'] as id. Drafts: list with aposMode: 'draft' to get the draft’s id (Find an id).

Required parameters

Named arguments, e.g. shareFaqItem(id: …); leave out the optional ones.

string

required

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

Optional parameters

Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. true adds a share key (aposShareKey) to the draft; false (the default) removes it.

Returns

A FaqItem (Fetchski\AttractCmsLaravel\Data\FaqItem). FaqItem content type. Read its properties ($faqItem->title): each says whether the site always sends it. The example answer is the site’s wire JSON: some keys differ from the property names (_id → id, _category → category).

string

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

RichTextMax1Area

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

Show RichTextMax1Area (Fetchski\AttractCmsLaravel\Data\RichTextMax1Area)

The fuller explanation shown under this entry on the Cookie Policy page. Plain language, no legalese — what is collected, why, and what declining costs the visitor. Widgets, top to bottom: send { "items": [ … ] }, one object per widget with its type. Writing it replaces the whole area.

Enums\AfterContentAreaMetaType|string|null

Sometimes sent: null when the site leaves it out. Always area. One of area; a newer site may send others, so keep a fallback.

?string

Sometimes sent: null when the site leaves it out. The area’s id, set by the site: leave it out when you write one.

Collection<int, RichTextWidget>|null

Sometimes sent: null when the site leaves it out. A list of RichTextWidget. The widgets, top to bottom. Each is an object with its type and that widget’s own fields; _id and metaType may be left out (the site sets them). At most 1 items.

Show RichTextWidget (Fetchski\AttractCmsLaravel\Data\RichTextWidget)

A @apostrophecms/rich-text widget: its type and its own fields. A field left out takes its default.

Enums\RichTextWidgetType|string

Always sent. The widget’s type: always @apostrophecms/rich-text. One of @apostrophecms/rich-text; a newer site may send others, so keep a fallback.

?string

Sometimes sent: null when the site leaves it out. The widget’s id, unique on the page. Leave it out for a new widget (the site sets one); keep it to change a widget that is there.

Enums\MetaType|string|null

Sometimes sent: null when the site leaves it out. Always widget. One of widget; a newer site may send others, so keep a fallback.

?string

Sometimes sent: null when the site leaves it out. The text as HTML, e.g. <h2>Our story</h2><p>It began with <strong>one</strong> idea.</p>. The site keeps the tags and styles this area’s editor offers (paragraphs, headings, bold, italic, links, lists…) and removes the rest.

?CustomCSS

Sometimes sent: null when the site leaves it out. A CustomCSS. CSS for this one section, typed into the slot of the part it styles. It wins over Site design → Custom CSS. Nested rules like &:hover, @media (width >= 48rem) and [data-theme=“light”] & work inside a slot.

Show CustomCSS (Fetchski\AttractCmsLaravel\Data\CustomCSS)

array<string, string>|null

Sometimes sent: null when the site leaves it out. The CSS typed into each part slot, by slot name.

?string

Sometimes sent: null when the site leaves it out. The compiled CSS (read only: rebuilt from slots).

?string

Sometimes sent: null when the site leaves it out. The site’s check mark for css (read only).

array<string, mixed>

Always there: [] when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too. An object in it that a PHP array would read as a list ({}, {"0": …}) is a stdClass, so it is sent back as an object.

array<string, mixed>

string

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

string

Always sent. 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.

string

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

Collection<int, array<string, mixed>>|null

Sometimes sent: null when the site leaves it out. 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. At most 1 items.

?bool

Sometimes sent: null when the site leaves it out. Hand-curation flag: FAQ sections can show only featured questions — e.g. a short top-questions block on the home page.

?int

Sometimes sent: null when the site leaves it out. Questions are listed lowest number first — the explicit FAQ order.

Enums\Visibility|string|null

Sometimes sent: null when the site leaves it out. Select whether this content is public or private. One of public, loginRequired; a newer site may send others, so keep a fallback.

?string

Sometimes sent: null when the site leaves it out. An ISO 8601 date and time, e.g. 2026-10-21T14:30:00.000Z.

?string

Sometimes sent: null when the site leaves it out. An ISO 8601 date and time, e.g. 2026-10-21T14:30:00.000Z.

Collection<int, FaqItemFaqFontOverridesItem>|null

Sometimes sent: null when the site leaves it out. A list of FaqItemFaqFontOverridesItem. Optional. Set part of this question’s card in a different typeface. Leave empty to follow the section (and the site fonts). At most 4 items.

Show FaqItemFaqFontOverridesItem (Fetchski\AttractCmsLaravel\Data\FaqItemFaqFontOverridesItem)

?string

Sometimes sent: null when the site leaves it out. The row’s id, unique in its array.

Enums\Target|string|null

Sometimes sent: null when the site leaves it out. Which text this typeface replaces. Rows apply in order, so a broad row (Everything) followed by a narrow one (Headings) gives the section a base face plus an exception. One of all, heading, body, eyebrow, button, code; a newer site may send others, so keep a fallback.

Enums\Source|string|null

Sometimes sent: null when the site leaves it out. Where the typeface comes from. The first option costs nothing extra — those faces are already loaded. The others load an additional font on pages that use this section. One of slot, curated, cdn, upload; a newer site may send others, so keep a fallback.

Enums\Slot|string|null

Sometimes sent: null when the site leaves it out. Set in Site design → Typography. Following the site’s own faces keeps a section on-brand and adds no download. One of display, body, accent; a newer site may send others, so keep a fallback.

Enums\Curated|string|null

Sometimes sent: null when the site leaves it out. Vetted families from Bunny Fonts and Fontshare, with their available weights already verified. One of archivo, bricolage-grotesque, clash-display, courier-prime, dm-mono, dm-sans, fira-code, fraunces, general-sans, ibm-plex-mono, ibm-plex-sans, inconsolata, inter, jetbrains-mono, karla, lora, manrope, nunito-sans, outfit, playfair-display, public-sans, red-hat-mono, satoshi, sentient, sora, source-code-pro, source-sans-3, source-serif-4, space-grotesk, space-mono, spline-sans-mono, supreme, switzer, syne, ubuntu-mono, unbounded, victor-mono, work-sans, zodiak; a newer site may send others, so keep a fallback.

Enums\CdnProvider|string|null

Sometimes sent: null when the site leaves it out. Where to browse for the family. Pick one, then follow the link below to find the exact name. One of bunny, fontshare; a newer site may send others, so keep a fallback.

?string

Sometimes sent: null when the site leaves it out. Exactly as the provider’s catalog spells it, e.g. “Space Grotesk” or “Clash Display”. A name the provider doesn’t have loads nothing and this row is ignored.

?string

Sometimes sent: null when the site leaves it out. Comma-separated weights to load, e.g. 400, 700. Empty loads 400, 500, 700. Weights the family doesn’t ship are skipped by the CDN and synthesized by the browser (faux bold) — but a family that ships only ONE weight (Acme, for instance) loads nothing at all unless that weight is among these, so set it explicitly if the typeface doesn’t appear.

Collection<int, FaqItemFaqFontOverridesItemUploadsItem>|null

Sometimes sent: null when the site leaves it out. A list of FaqItemFaqFontOverridesItemUploadsItem. One file per weight/style of the SAME typeface. woff2 strongly recommended (smallest, universally supported); woff/ttf/otf also accepted. At most 4 items.

Show FaqItemFaqFontOverridesItemUploadsItem (Fetchski\AttractCmsLaravel\Data\FaqItemFaqFontOverridesItemUploadsItem)

array<string, mixed>

Always sent. File attachment reference.

?string

Sometimes sent: null when the site leaves it out. The row’s id, unique in its array.

Enums\Weight|string|null

Sometimes sent: null when the site leaves it out. Weight. One of 100, 200, 300, 400, 500, 600, 700, 800, 900; a newer site may send others, so keep a fallback.

Enums\Style|string|null

Sometimes sent: null when the site leaves it out. Style. One of normal, italic; a newer site may send others, so keep a fallback.

array<string, mixed>

Enums\Fallback|string|null

Sometimes sent: null when the site leaves it out. Generic system font shown while this typeface loads (and if it fails). Curated picks set this automatically. One of sans, serif, mono; a newer site may send others, so keep a fallback.

array<string, mixed>

Enums\FaqCategorySource|string|null

Sometimes sent: null when the site leaves it out. Set automatically. Demo placeholders are removed the moment a real question is published. One of manual, demo; a newer site may send others, so keep a fallback.

?string

Sometimes sent: null when the site leaves it out. Internal de-duplication key set by the demo seed.

?bool

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

?CarbonImmutable

Sometimes sent: null when the site leaves it out. When it was created (ISO 8601). Format: an ISO 8601 date and time.

?CarbonImmutable

Sometimes sent: null when the site leaves it out. When it last changed (ISO 8601). Format: an ISO 8601 date and time.

Sometimes sent: null when the site leaves it out. 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.

Errors

Nothing to catch: the SDK retries what is safe, and Laravel logs and renders the rest (see Errors and testing).

400

The site refused what was sent: errors() lists each field’s problem, siteMessage() the first.Retried first: No. Read: errors() (field → messages), siteMessage().

401

The API key is missing or refused (malformed, revoked, expired), or a signature its signing mode needs is missing or stale.Retried first: No. Read: siteMessage(), errorName(), data().

403

The key may not do this: a scope it lacks, or an address outside its allowlist. siteMessage() names it.Retried first: No. Read: siteMessage(), errorName(), data().

404

Nothing matches, or the caller may not see it.Retried first: No. Read: siteMessage(), errorName(), data().

500

The site failed. Its logs say why.Retried first: No: a write may have landed. Read: siteMessage(), errorName(), data().

no answer

No answer: DNS, a refused connection, TLS, or the timeout (15 s per attempt by default).Retried first: Only when nothing reached the site (neverConnected()); never after a timeout, when it may have landed. Read: reason(), neverConnected().

not sent

The client refused to send it (e.g. a path segment of ..); the site never saw it.Retried first: No. Read: reason() (what to change).

any other

Any other status, or a success whose JSON doesn’t match this SDK version’s types (update the SDK).Retried first: No. Read: reason(), status().

setup

Attract::site('acme') named a slug that isn’t under sites in config/fetchski-attract.php.Retried first: No: nothing was sent. Read: getMessage(), $e->slug.

setup

The site’s config entry is wrong: no url, a malformed api_key, a key filed under another slug, or no default site.Retried first: No: nothing was sent. Read: getMessage() (what to fix).

Behavior

Access: an API key with content:faq-items:write (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. The client waits and retries for you; you see RateLimited only if that runs out.
Retries: a write is sent again only after a 429 (refused before it acted) or when it never reached the site. After a timeout or a 5xx it may have landed: check before you send it again.
Timeout: 15 s per attempt by default; raise timeout in config/fetchski-attract.php for longer.

Test it

It calls the route above with the SDK faked: the fake answers every call with a valid example, so nothing leaves your machine and no config or key is needed. Save it as tests/Feature/ShareFaqItemTest.php, then run your tests:

tests/Feature/ShareFaqItemTest.php

<?php

declare(strict_types=1);

namespace Tests\Feature;

use App\Models\User;
use Fetchski\AttractCmsLaravel\Facades\Attract;
use Illuminate\Foundation\Testing\RefreshDatabase;
use Tests\TestCase;

final class ShareFaqItemTest extends TestCase
{
    use RefreshDatabase;

    public function test_share_faq_item(): void
    {
        Attract::fake();

        $this->actingAs(User::factory()->create())
            ->postJson('/faq-item/clx8m2k4p0000a1b2c3d4e5f6/share')
            ->assertOk();

        Attract::assertCalled('faqItems.shareFaqItem', fn (array $args): bool => $args['id'] === 'clx8m2k4p0000a1b2c3d4e5f6');
    }
}

Terminal

php artisan test

Answer with your own values: fake faqItems.shareFaqItem with FaqItem::factory()->make([...]), the fields you give over a valid example.

tests/Feature/ShareFaqItemAnswerTest.php

<?php

declare(strict_types=1);

namespace Tests\Feature;

use Fetchski\AttractCmsLaravel\Data\FaqItem;
use Fetchski\AttractCmsLaravel\Facades\Attract;
use Tests\TestCase;

final class ShareFaqItemAnswerTest extends TestCase
{
    public function test_share_faq_item_answers_your_values(): void
    {
        Attract::fake([
            'faqItems.shareFaqItem' => FaqItem::factory()->make(['title' => 'Your value']),
        ]);

        $faqItem = Attract::faqItems()->shareFaqItem(id: 'clx8m2k4p0000a1b2c3d4e5f6');

        $this->assertSame('Your value', $faqItem->title);
    }
}

List an FAQ item’s locales

Attract::faqItems()->getFaqItemLocales()

List FAQ items

Attract::faqItems()->listFaqItems()

Create an FAQ item

Attract::faqItems()->createFaqItem()

Get an FAQ item

Attract::faqItems()->getFaqItem()

Replace an FAQ item

Attract::faqItems()->replaceFaqItem()

Delete an FAQ item

Attract::faqItems()->deleteFaqItem()

POST /faq-item/{_id}/share

The endpoint this calls, in the API reference: the HTTP request and answer, and every rule the site checks.

use Fetchski\AttractCmsLaravel\Facades\Attract;

$faqItem = Attract::faqItems()->shareFaqItem(id: 'clx8m2k4p0000a1b2c3d4e5f6');

{
  "title": "Example title",
  "answer": {
    "metaType": "area",
    "_id": "clx8m2k4p0000a1b2c3d4e5f6",
    "items": [
      {
        "type": "@apostrophecms/rich-text",
        "_id": "clx8m2k4p0000a1b2c3d4e5f6",
        "metaType": "widget",
        "content": "<p>Hello from the API.</p>",
        "sectionCss": {
          "slots": {
            "key": "Example value"
          },
          "css": "Example css",
          "mark": "Example mark"
        }
      }
    ]
  },
  "_category": [
    {}
  ],
  "featured": false,
  "sortOrder": 0,
  "slug": "example-slug",
  "visibility": "public",
  "scheduledPublish": "Example scheduled publish",
  "scheduledUnpublish": "Example scheduled unpublish",
  "faqFontOverrides": [],
  "source": "manual",
  "sourceId": "clx8m2k4p0000a1b2c3d4e5f6",
  "archived": false,
  "_id": "clx8m2k4p0000a1b2c3d4e5f6",
  "type": "Example type",
  "createdAt": "2026-10-24T09:30:00.000Z",
  "updatedAt": "2026-10-24T09:30:00.000Z",
  "aposShareKey": "k3v9x2m7q1z8w4p6"
}

Get started

Using the SDK

Going further

Pages & Site

Content

Media

Forms

Ads & Conversions

Analytics

In your app

Call it from the terminal

Find the id

Behavior

Test it

List an FAQ item’s locales

List FAQ items

Create an FAQ item

Get an FAQ item

Replace an FAQ item

Delete an FAQ item

POST /faq-item/{_id}/share

In your app

Call it from the terminal

Find the id

Behavior

Test it

Related

List an FAQ item’s locales

List FAQ items

Create an FAQ item

Get an FAQ item

Replace an FAQ item

Delete an FAQ item

POST /faq-item/{_id}/share