Replace a global document

use Fetchski\AttractCmsLaravel\Facades\Attract;

$globalContent = Attract::globalContent()->replaceGlobal(id: 'ckitdo5oq004pu69kr6oxo6fr:en:published', cookiePolicyVersion: '1', cookieMessage: 'This website uses cookies to supplement a balanced diet and provide a much deserved reward to the senses after consuming bland but nutritious meals. Accepting our cookies is optional but recommended, as they are delicious.', cookieAcceptLabel: 'Accept all', cookieRejectLabel: 'Reject all', cookiePrefsTitle: 'Cookie preferences');

{
  "_id": "global",
  "slug": "global",
  "type": "@apostrophecms/global",
  "cookiePolicyVersion": "1",
  "cookieMessage": "This website uses cookies to supplement a balanced diet and provide a much deserved reward to the senses after consuming bland but nutritious meals. Accepting our cookies is optional but recommended, as they are delicious.",
  "cookieAcceptLabel": "Accept all",
  "cookieRejectLabel": "Reject all",
  "cookiePrefsTitle": "Cookie preferences",
  "createdAt": "2026-10-24T09:30:00.000Z",
  "updatedAt": "2026-10-24T09:30:00.000Z"
}

use Fetchski\AttractCmsLaravel\Facades\Attract;

$globalContent = Attract::globalContent()->replaceGlobal(id: 'ckitdo5oq004pu69kr6oxo6fr:en:published', cookiePolicyVersion: '1', cookieMessage: 'This website uses cookies to supplement a balanced diet and provide a much deserved reward to the senses after consuming bland but nutritious meals. Accepting our cookies is optional but recommended, as they are delicious.', cookieAcceptLabel: 'Accept all', cookieRejectLabel: 'Reject all', cookiePrefsTitle: 'Cookie preferences');

{
  "_id": "global",
  "slug": "global",
  "type": "@apostrophecms/global",
  "cookiePolicyVersion": "1",
  "cookieMessage": "This website uses cookies to supplement a balanced diet and provide a much deserved reward to the senses after consuming bland but nutritious meals. Accepting our cookies is optional but recommended, as they are delicious.",
  "cookieAcceptLabel": "Accept all",
  "cookieRejectLabel": "Reject all",
  "cookiePrefsTitle": "Cookie preferences",
  "createdAt": "2026-10-24T09:30:00.000Z",
  "updatedAt": "2026-10-24T09:30:00.000Z"
}

In your app

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

Add the controller

app/Http/Controllers/ReplaceGlobalController.php

<?php

declare(strict_types=1);

namespace App\Http\Controllers;

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

final class ReplaceGlobalController
{
    public function __invoke(string $id): GlobalContent
    {
        return Attract::globalContent()->replaceGlobal(id: $id, cookiePolicyVersion: '1', cookieMessage: 'This website uses cookies to supplement a balanced diet and provide a much deserved reward to the senses after consuming bland but nutritious meals. Accepting our cookies is optional but recommended, as they are delicious.', cookieAcceptLabel: 'Accept all', cookieRejectLabel: 'Reject all', cookiePrefsTitle: 'Cookie preferences');
    }
}

The other values are the example’s: take yours from the request, a form or your database.

Add the route

routes/web.php

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

Route::put('/global/{id}', ReplaceGlobalController::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 PUT /global/ckitdo5oq004pu69kr6oxo6fr:en:published (a form adds @csrf, as every web route checks it, and @method('PUT')), 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/ReplaceGlobal.php (an invokable Action that calls replaceGlobal()) and its test under tests/Feature/Actions/Attract/ (Pest when your app has it):

Terminal

php artisan make:attract-action globalContent.replaceGlobal

Call it from the terminal

Terminal

php artisan attract:call globalContent.replaceGlobal \
  id=ckitdo5oq004pu69kr6oxo6fr:en:published \
  cookiePolicyVersion=1 \
  'cookieMessage=This website uses cookies to supplement a balanced diet and provide a much deserved reward to the senses after consuming bland but nutritious meals. Accepting our cookies is optional but recommended, as they are delicious.' \
  'cookieAcceptLabel=Accept all' \
  'cookieRejectLabel=Reject all' \
  'cookiePrefsTitle=Cookie preferences'

It calls replaceGlobal() 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. PATCH changes only the fields sent. Completely replace a specific global document document by ID using PUT semantics

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::globalContent()->listGlobalContentPick(fields: ['title', 'slug'])->firstWhere('slug', 'getting-started'); // ['id' => …, 'title' => …, 'slug' => …], or null

Terminal

php artisan attract:call globalContent.listGlobalContentPick 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. replaceGlobal(id: …); leave out the optional ones.

string

required

Required. Computed document ID (can optionally include mode and locale, e.g., id:en:published) Matches ^\S+$.

Required. Change this — to “2”, a date, anything — and every visitor is asked again. Do that whenever what you do with the data materially changes; consent given under the old terms does not carry over.

Required. Banner message.

Required. Accept button.

Required. Give this the same visual weight as Accept. A reject option that is harder to find than accept is the single most commonly penalized banner design.

Required. Preferences panel heading.

Optional parameters

Enums\AposMode|string|null

Optional. Leave it out and the site uses "published". published (the default) or draft. Drafts need a credential that may see them: an API key with the type’s write scope (content:<type>:write), or a signed-in editor. The public and a key with only the read scope get 403. One of draft, published.

?string

Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. The locale to read or write, e.g. en (default: the site’s default locale).

?string

Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. The _id of the piece/page that was copied to create this document (only present if created via _copyingId)

?string

Optional. Leave it out and the site uses "Fetchski Attract". Business name.

?string

Optional. Leave it out and the site uses "The website platform for modern businesses". Tagline.

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

Optional. Shown in the site header on the dark theme (and over the hero). Upload to the Images library first. The related @apostrophecms/image 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.

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

Optional. Optional darker logo for the light theme. If empty, the white logo is auto-inverted. The related @apostrophecms/image 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.

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

Optional. Browser tab icon — the default, also used when the browser is in dark mode. Upload a square PNG or SVG (at least 64×64) to the Images library. If empty, the bundled default icon is used. The related @apostrophecms/image 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.

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

Optional. Optional. Used when the visitor’s BROWSER or device is in light mode — this follows the browser’s color scheme, not the site’s own theme toggle. If empty, the main favicon is used everywhere. The related @apostrophecms/image 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.

?string

Optional. Leave it out and the site uses "Your City, ST". Shown in the footer. Use up to three lines for a full street address, or just one for a town/region.

?string

Optional. Leave it out and the site uses "". Address line 2.

?string

Optional. Leave it out and the site uses "". Address line 3.

?string

Optional. Leave it out and the site uses "(555) 000-0000". Phone.

?string

Optional. Leave it out and the site uses "hello@example.com". Email.

?string

Optional. Leave it out and the site uses "". The registered name of the company, e.g. “Example Holdings LLC”. Fills [Business legal name].

?string

Optional. Leave it out and the site uses "". Any other names the business operates under, e.g. “Example Studio and Example Supply”. Fills [Trade names].

?string

Optional. Leave it out and the site uses "". Where the business is based, for governing law. Fills [State or region].

?string

Optional. Leave it out and the site uses "". Fills [Country].

?string

Optional. Leave it out and the site uses "". Where legal disputes are heard. Fills [County or venue].

?string

Optional. Leave it out and the site uses "". The youngest age your website is intended for, e.g. “13”. Fills [Minimum age].

?string

Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. Your main brand color — buttons, links, accents. Hover + soft tints are derived automatically. Leave empty for the built-in design color.

?string

Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. A CSS color (#625bff, #625bffff, rgb(…), hsl(…), a color name) or a palette token’s name (--fetchski-accent).

?string

Optional. Text/icon color shown ON primary-colored buttons. Defaults to white — set a dark color if your primary is pale.

?string

Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. Supporting color — eyebrows, offset shadows, secondary accents.

?string

Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. Warm accent, used sparingly.

?string

Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. Body-text link color (rich-text content). Leave empty to track the primary color.

?string

Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. The base page background.

?string

Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. Cards and raised panels that sit above the page background.

?string

Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. Recessed / inset bands.

?string

Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. Primary text color. Mind contrast against the page background.

?string

Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. Secondary / muted text color.

?string

Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. Borders and dividers.

?string

Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. Positive / confirmation state (forms, alerts).

?string

Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. Caution state.

?string

Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. Error / destructive state.

?string

Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. Informational state.

?string

Enums\FontDisplaySource|string|null

Optional. Leave it out and the site uses "default". Typeface used for headings and display type. Default is the built-in design font; the other sources replace it site-wide. One of default, curated, cdn, upload.

Enums\FontDisplayCurated|string|null

Optional. Leave it out and the site uses "clash-display". Display font — curated pick. One of clash-display, satoshi, general-sans, space-grotesk, bricolage-grotesque, archivo, sora, syne, outfit, unbounded, fraunces, playfair-display, zodiak, sentient.

Enums\FontDisplayCdnProvider|string|null

Optional. Leave it out and the site uses "bunny". Where to browse for the family. Pick one, then follow the link below to find the exact name. One of bunny, fontshare.

?string

Optional. Leave it out and the site uses "". Exactly as the provider’s catalog spells it, e.g. “Space Grotesk” or “Clash Display”.

?string

Optional. Leave it out and the site uses "". Comma-separated weights to load, e.g. 400, 700. Empty loads 500, 700, 800. Weights the family doesn’t ship are skipped by the CDN and synthesized by the browser (faux bold).

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

Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. One file per weight/style of the SAME typeface. woff2 strongly recommended (smallest, universally supported); woff/ttf/otf also accepted. At most 8 items.

Show GlobalFontDisplayUploadsItem (Fetchski\AttractCmsLaravel\Data\GlobalFontDisplayUploadsItem)

array<string, mixed>

required

Required. File attachment reference.

?string

The row’s id, unique in its array.

Enums\Weight|string|null

Weight. One of 100, 200, 300, 400, 500, 600, 700, 800, 900.

Enums\Style|string|null

Style. One of normal, italic.

array<string, mixed>

Optional: any keys not listed above, by their wire names; they are sent with the rest.

Enums\FontDisplayFallback|string|null

Optional. Leave it out and the site uses "sans". Generic system fonts shown while the font loads (and if it fails). Curated picks set this automatically. One of sans, serif, mono.

Enums\FontBodySource|string|null

Optional. Leave it out and the site uses "default". Typeface used for body text and UI. Default is the built-in design font; the other sources replace it site-wide. One of default, curated, cdn, upload.

Enums\FontBodyCurated|string|null

Optional. Leave it out and the site uses "inter". Body font — curated pick. One of inter, manrope, public-sans, work-sans, nunito-sans, ibm-plex-sans, source-sans-3, dm-sans, karla, switzer, supreme, satoshi, general-sans, lora, source-serif-4.

Enums\FontBodyCdnProvider|string|null

Optional. Leave it out and the site uses "bunny". Where to browse for the family. Pick one, then follow the link below to find the exact name. One of bunny, fontshare.

?string

Optional. Leave it out and the site uses "". Exactly as the provider’s catalog spells it, e.g. “Space Grotesk” or “Clash Display”.

?string

Optional. Leave it out and the site uses "". Comma-separated weights to load, e.g. 400, 700. Empty loads 400, 500, 600, 700. Weights the family doesn’t ship are skipped by the CDN and synthesized by the browser (faux bold).

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

Show GlobalFontBodyUploadsItem (Fetchski\AttractCmsLaravel\Data\GlobalFontBodyUploadsItem)

array<string, mixed>

required

Required. File attachment reference.

?string

The row’s id, unique in its array.

Enums\Weight|string|null

Weight. One of 100, 200, 300, 400, 500, 600, 700, 800, 900.

Enums\Style|string|null

Style. One of normal, italic.

array<string, mixed>

Optional: any keys not listed above, by their wire names; they are sent with the rest.

Enums\FontBodyFallback|string|null

Optional. Leave it out and the site uses "sans". Generic system fonts shown while the font loads (and if it fails). Curated picks set this automatically. One of sans, serif, mono.

Enums\FontAccentSource|string|null

Optional. Leave it out and the site uses "default". Typeface used for code blocks and monospace accents. Default is the built-in design font; the other sources replace it site-wide. One of default, curated, cdn, upload.

Enums\FontAccentCurated|string|null

Optional. Leave it out and the site uses "jetbrains-mono". Accent / mono font — curated pick. One of jetbrains-mono, ibm-plex-mono, fira-code, space-mono, source-code-pro, dm-mono, inconsolata, ubuntu-mono, courier-prime, red-hat-mono, spline-sans-mono, victor-mono.

Enums\FontAccentCdnProvider|string|null

Optional. Leave it out and the site uses "bunny". Where to browse for the family. Pick one, then follow the link below to find the exact name. One of bunny, fontshare.

?string

Optional. Leave it out and the site uses "". Exactly as the provider’s catalog spells it, e.g. “Space Grotesk” or “Clash Display”.

?string

Optional. Leave it out and the site uses "". Comma-separated weights to load, e.g. 400, 700. Empty loads 400, 700. Weights the family doesn’t ship are skipped by the CDN and synthesized by the browser (faux bold).

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

Show GlobalFontAccentUploadsItem (Fetchski\AttractCmsLaravel\Data\GlobalFontAccentUploadsItem)

array<string, mixed>

required

Required. File attachment reference.

?string

The row’s id, unique in its array.

Enums\Weight|string|null

Weight. One of 100, 200, 300, 400, 500, 600, 700, 800, 900.

Enums\Style|string|null

Style. One of normal, italic.

array<string, mixed>

Optional: any keys not listed above, by their wire names; they are sent with the rest.

Enums\FontAccentFallback|string|null

Optional. Leave it out and the site uses "mono". Generic system fonts shown while the font loads (and if it fails). Curated picks set this automatically. One of sans, serif, mono.

Enums\ContentWidth|string|null

Optional. Leave it out and the site uses "wide". The widest the page content gets: sections, layouts, the header and the footer all line up to it. Smaller screens always use their full width, minus the side margins. One of standard, wide, xwide.

Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. Each profile is optional — add only the networks you use. A link only appears once it has a URL. Pick a platform for its brand icon, or “Other / custom” to choose any icon.

Show GlobalSocialLinksItem (Fetchski\AttractCmsLaravel\Data\GlobalSocialLinksItem)

Enums\Platform|string

required

Required. Platform. One of instagram, facebook, x-twitter, youtube, tiktok, linkedin, github, pinterest, whatsapp, snapchat, threads, bluesky, mastodon, yelp, google, spotify, vimeo, custom.

string

required

Required. Full link to the profile, e.g. https://instagram.com/yourbusiness. Format: an absolute URL.

?string

The row’s id, unique in its array.

?string

Overrides the screen-reader / tooltip label. Recommended for a custom platform — defaults to the icon name (e.g. “discord” → “Discord”).

?string

Font Awesome icon name (no “fa-” prefix), e.g. discord. Browse fontawesome.com/icons.

Enums\IconFamily|string|null

Custom icon family. One of classic-regular, duotone-regular, brands, jelly, jelly-duo, whiteboard.

array<string, mixed>

Optional: any keys not listed above, by their wire names; they are sent with the rest.

ImageArea|array<string, mixed>|null

Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. Site-wide fallback for link previews (Open Graph): used on any page that has neither its own Social share image nor a featured image. Recommended 1200×630. Widgets, top to bottom: send { "items": [ … ] }, one object per widget with its type. Writing it replaces the whole area.

Show ImageArea (Fetchski\AttractCmsLaravel\Data\ImageArea)

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

Enums\AfterContentAreaMetaType|string|null

Always area. One of area.

?string

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

Collection<int, ImageWidget>|null

A list of ImageWidget. 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 ImageWidget (Fetchski\AttractCmsLaravel\Data\ImageWidget)

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

Enums\ImageWidgetType|string

required

Required. The widget’s type: always @apostrophecms/image. One of @apostrophecms/image.

?string

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

Always widget. One of widget.

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

The related @apostrophecms/image 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.

?string

Caption.

Enums\LinkTo|string|null

Link To… One of none, @apostrophecms/any-page-type, _url.

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

The related @apostrophecms/any-page-type 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.

?string

apostrophe:linkHrefHelp When set, a URL; empty or null when not.

?string

Link Title.

?string

If empty, the title of the related document will be used.

Collection<int, Enums\LinkTarget|string>|null

Link Target. Each one of _blank.

?CustomCSS

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

The CSS typed into each part slot, by slot name.

?string

The compiled CSS (read only: rebuilt from slots).

?string

The site’s check mark for css (read only).

array<string, mixed>

Optional: any keys not listed above, by their wire names; they are sent with the rest.

array<string, mixed>

Optional: any keys not listed above, by their wire names; they are sent with the rest.

?bool

Optional. Leave it out and the site uses false. Adds schema.org structured data about the business to every page, built from the Brand tab’s business name, address, phone and email plus the Social Links list. Helps search engines show rich results. Nothing is published until this is on and a business name is set.

Enums\SeoStructuredDataType|string|null

Optional. Leave it out and the site uses "LocalBusiness". The schema.org type that best describes the business. “Local business” fits most sites with a physical location or service area. One of LocalBusiness, Organization, ProfessionalService, Store.

?bool

Optional. Leave it out and the site uses true. Adds the Service Area Map’s coverage (place names, service radius) to the business structured data on every page, and the full zip-code/boundary detail on pages with a Service Area Map section. Helps search engines and AI answers understand where the business serves — there is no visual search result for this, and it never affects map-pack ranking. Keep it consistent with the areas on the business’s Google Business Profile. Demo map data is never published.

?string

Optional. Leave it out and the site uses "". Optional, plain words — e.g. “House cleaning” or “Airport transfers”. When set, the structured data pairs it with the service areas as a schema.org Service; when empty the areas attach directly to the business.

Enums\AnalyticsProvider|string|null

Optional. Leave it out and the site uses "none". Plausible is a privacy-friendly, cookieless analytics service. Visitor page views are counted anonymously; logged-in editors are never tracked. One of none, plausible.

?string

Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. Paste the script address from your site’s snippet in Plausible → Site Settings → Site Installation (it looks like https://plausible.io/js/pa-XXXXXXXX.js and is unique per site). Analytics stay off until this is set. Optional measurements (outbound links, file downloads, form submissions) are toggled in the Plausible dashboard — no change needed here. When set, a URL; empty or null when not.

Optional. Leave it out and the site uses true. Off hides the banner AND stops every non-essential cookie and third-party embed — declining is the only safe reading of “never asked”. Turn it off only on a site that sets nothing beyond the strictly necessary.

Optional. Leave it out and the site uses "eu". Where opt-in applies, nothing non-essential runs until the visitor agrees. Everyone else sees the same banner as a notice: analytics and embedded content work immediately, and declining switches them off. The first option follows the law that is strictest about being asked first, without putting a wall in front of visitors whose law does not require one. One of eu, all, notice.

Optional. Leave it out and the site uses "lenient". Country comes from your CDN or proxy (Cloudflare’s header, or one you configure). Without it the site falls back to this, plus a browser time-zone check that quietly upgrades an apparently European visitor to opt-in. Put Cloudflare or a GeoIP header in front of the site and this setting stops mattering. One of lenient, strict.

Optional. Leave it out and the site uses "left". Banner position. One of left, right, center, full.

Optional. Leave it out and the site uses true. Opens the per-category preferences panel. Leaving it on is the safer choice: accept-or-reject with no middle option is what regulators have been fining sites over.

Optional. Leave it out and the site uses false. A small button pinned to the bottom corner, over the page. Off by default because the footer link below already offers this — turn it on if you want the control visible without scrolling.

Optional. Leave it out and the site uses true. Puts the reopen control at the bottom of every page, under the “Powered by” line — where visitors look for it. Uses the reopen label from the Cookie banner wording tab. Leave this on unless the floating button above is on instead: consent must stay as easy to withdraw as it was to give.

Optional. Leave it out and the site uses true. GPC is a browser-level “do not sell or share my data” signal, legally binding in several US states. When on, a visitor sending it starts with everything non-essential switched off — they can still turn categories on by hand.

Optional. Leave it out and the site uses false. A third-party script that has already run cannot be switched off in place: it keeps running until the next full page load (each vendor is still told about the withdrawal straight away). On, the page reloads as soon as a visitor switches a category OFF, so nothing they declined keeps running. Off by default: the reload interrupts whatever the visitor was doing, and most visitors are not in a region that requires it.

Optional. Leave it out and the site uses 180. How long a visitor’s answer stands before the banner returns. Six months is the common practice and twelve is the usual ceiling. 1 to 365.

Optional. Leave it out and the site uses true. Stores a receipt for each decision (which categories, when, under which policy version) so you can show consent was given. Kept for two years, then deleted automatically.

Optional. Leave it out and the site uses "". Optional. Leave empty for the message alone, which is how most banners read best.

Optional. Leave it out and the site uses "See our cookie policy.". Rendered after the message as a link to the policy page. Leave empty to omit it.

Optional. Leave it out and the site uses "/cookie-policy". A path on this site or a full URL. The default matches the parked Cookie Policy page.

Optional. Leave it out and the site uses "Customize". Customize button.

Optional. Leave it out and the site uses "Save my choices". Save-choices button.

Optional. Leave it out and the site uses "Cookie preferences". Reopen control label.

Optional. Leave it out and the site uses "Choose which cookies we may use. You can change your mind at any time — nothing here is permanent.". Preferences panel intro.

Optional. Leave it out and the site uses "Strictly necessary". Strictly necessary — label.

Optional. Leave it out and the site uses

"Required for the site to work — security, load balancing, remembering your cookie choices. These are never used to track you and cannot be switched off."

. Shown beside this category’s switch in the preferences panel. Say what the visitor gains or loses, not which vendors are involved.

Optional. Leave it out and the site uses "Functional". Functional — label.

Optional. Leave it out and the site uses

"Remember your preferences and power embedded features such as maps, media and social content. Turning these off may leave parts of a page unavailable."

. Shown beside this category’s switch in the preferences panel. Say what the visitor gains or loses, not which vendors are involved.

Optional. Leave it out and the site uses "Analytics". Analytics — label.

Optional. Leave it out and the site uses

"Help us understand which pages are visited and how people move through the site, so we can improve it. Aggregate only — never used to identify you personally."

. Shown beside this category’s switch in the preferences panel. Say what the visitor gains or loses, not which vendors are involved.

Optional. Leave it out and the site uses "Marketing". Marketing — label.

Optional. Leave it out and the site uses

"Measure whether an advertisement or campaign brought you here, and let us tailor what we show you. These are the cookies most people mean by \"tracking\"."

. Shown beside this category’s switch in the preferences panel. Say what the visitor gains or loses, not which vendors are involved.

Optional. Leave it out and the site uses "Content not loaded". Shown in place of an embed (a map, a social video) that is waiting on consent.

Optional. Leave it out and the site uses

"This content is served by another company, which would receive your IP address and browser details. It loads once you accept functional cookies — or just for this one item, if you press the button."

. Blocked-content message.

Optional. Leave it out and the site uses "Load this content". Blocked-content button.

?bool

Optional. Leave it out and the site uses true. Takes the public site offline. Visitors and search engines see a “be right back” page (served with the correct temporary-outage signals, so search rankings are preserved); logged-in editors keep the full site and can continue editing. A new site starts with this on: turn it off when the site is ready to go live.

Enums\MaintenanceRetryAfter|string|null

Optional. Leave it out and the site uses "3600". How long search engines should wait before checking back (the Retry-After hint). A rough estimate is fine — it is a hint, not a promise, and nothing switches back automatically. One of 3600, 14400, 43200, 86400, 259200, 604800.

?string

Optional. Leave it out and the site uses "". Optional short message shown on the maintenance page (e.g. what is happening or when you expect to be back). Leave empty for a generic “we’ll be back soon” line.

?bool

Optional. Leave it out and the site uses true. Master switch for the site’s scroll and entrance motion (section reveals, count-ups, marquees, the hero). When off, no animation code is loaded and every section appears in its final, static state. Visitors whose device requests reduced motion always get the static experience regardless of this setting.

DesignLayer|array<string, mixed>|null

Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. Site-wide CSS for every section of a type and for shared elements (buttons, the header, the footer…). Type into the slot of the part you want to style; a section’s own CSS tab wins over this.

Show DesignLayer (Fetchski\AttractCmsLaravel\Data\DesignLayer)

array<string, string>|null

The CSS typed into each part slot, by slot name.

?string

The compiled CSS (read only: rebuilt from slots).

?string

The site’s check mark for css (read only).

Enums\HeaderStyle|string|null

Optional. Leave it out and the site uses "floating". Floating rests transparent over the hero and morphs to glass on scroll; Glass is frosted from the top; Solid is an opaque bar (uses the bar background color). One of floating, glass, solid.

Enums\HeaderWidth|string|null

Optional. Leave it out and the site uses "island". Island floats as a contained pill; Full width spans edge-to-edge (squared corners, content still centered). Full width ignores the corner radius below. One of island, full.

Enums\HeaderBarRadius|string|null

Optional. Leave it out and the site uses "rounded". Applies to the Island bar (Full width is always squared). One of pill, rounded, slight, square.

?string

Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. The bar fill for Glass / Solid styles (and the glass tint when scrolled). Leave empty to use the raised surface color.

?string

?bool

Optional. Leave it out and the site uses true. A hairline outline around the bar (shown when glass / solid / scrolled).

?bool

Optional. Leave it out and the site uses true. A soft drop shadow under the bar (when glass / solid / scrolled).

?bool

Optional. Leave it out and the site uses true. The bar slides away when scrolling down and returns when scrolling up.

?bool

Optional. Leave it out and the site uses true. The floating bar stays transparent at the top and becomes a glass pill once the page scrolls. Turn off to keep it transparent.

?bool

Optional. Leave it out and the site uses false. Keeps the whole navbar (bar, logo, wordmark, links, dropdown, button and mobile menu) in its dark-theme look even when a visitor switches to the light theme, e.g. a header that always sits over a dark hero photo. While on, the light-theme header colors and the light-theme logo are not used. Off follows the site theme.

Enums\HeaderNavBreakpoint|string|null

Optional. Leave it out and the site uses "lg". Below this width the links collapse into the mobile menu (hamburger). Raise it if you have many or long links. One of md, lg, xl.

Enums\HeaderLogoHeight|string|null

Optional. Leave it out and the site uses "medium". Logo height. One of small, medium, large.

?bool

Optional. Leave it out and the site uses true. A subtle tilt + scale when the cursor is over the logo lockup.

?bool

Optional. Leave it out and the site uses true. The business name in type beside the logo. Turn off when the logo already includes the name.

?string

Optional. Leave it out and the site uses "". Optional override of the text wordmark. Leave empty to use the business name.

?bool

Optional. Leave it out and the site uses true. Render the first word large and the rest as a small tracked-out caption beneath it. Off renders the whole wordmark on one line.

?string

Enums\HeaderNameWeight|string|null

Optional. Leave it out and the site uses "extrabold". Weight. One of normal, medium, semibold, bold, extrabold.

Enums\HeaderNameSize|string|null

Optional. Leave it out and the site uses "normal". Size. One of small, normal, large.

?string

Enums\HeaderSublineWeight|string|null

Optional. Leave it out and the site uses "bold". Weight. One of normal, medium, semibold, bold, extrabold.

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

Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. Header navigation.

Show GlobalHeaderNavItem (Fetchski\AttractCmsLaravel\Data\GlobalHeaderNavItem)

string

required

Required. Label.

string

required

Required. URL.

?string

The row’s id, unique in its array.

Enums\Placement|string|null

Desktop only — every link is listed in the mobile menu. One of visible, more.

array<string, mixed>

Optional: any keys not listed above, by their wire names; they are sent with the rest.

?string

Optional. Leave it out and the site uses "More". Label for the overflow dropdown that holds links placed in “More”.

?string

Enums\HeaderNavLinkWeight|string|null

Optional. Leave it out and the site uses "extrabold". Weight. One of normal, medium, semibold, bold, extrabold.

Enums\HeaderNavLinkSize|string|null

Optional. Leave it out and the site uses "normal". Size. One of small, normal, large.

Enums\HeaderNavIndicator|string|null

Optional. Leave it out and the site uses "sweep". How the hovered / active link is marked. One of sweep, grow, pill, none.

?string

Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. Optional. Leave empty to use the site accent color.

?string

Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. Color + indicator for the current page’s link. Leave empty to use the secondary (mint) color.

?string

Optional. Leave it out and the site uses "Member Portal". The visible button text. Leave empty to hide the button.

?string

Optional. Leave it out and the site uses "https://fetchski.com". Where the button goes — a path (/blog) or full URL.

?bool

Optional. Leave it out and the site uses false. Opens the link in a new browser tab (adds rel=“noopener noreferrer”).

Enums\HeaderCtaVariant|string|null

Optional. Leave it out and the site uses "solid". Solid fills with the color; Outline / Soft / Text link use it for the border + text. One of solid, outline, soft, link.

Enums\HeaderCtaSize|string|null

Optional. Leave it out and the site uses "normal". Button size. One of small, normal, large.

Enums\HeaderCtaRadius|string|null

Optional. Leave it out and the site uses "slight". Corner radius. One of pill, rounded, slight, square.

?string

Optional. Leave it out and the site uses "--fetchski-accent". Solid fill, or the border + text for the other styles. Defaults to the brand accent; CLEAR it for a transparent, outline-only button.

?string

Optional. Leave it out and the site uses "--fetchski-ink". The text/icon color. Clear it to derive from the button color (readable on solid fills).

?string

Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. Optional. Drives the hover treatment. Leave empty to derive it from the button color.

?string

Enums\HeaderCtaStyle|string|null

Optional. Leave it out and the site uses "sweep". The hover treatment: a soft shadow, a colored offset shadow, a glow, a fill sweep, or a thicker border. One of none, single, dual, glow, sweep, thicken.

?string

Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. Optional. The offset-shadow or glow color on hover. Leave empty to use the site secondary color.

?string

Enums\HeaderCtaAnimation|string|null

Optional. Leave it out and the site uses "lift-scale". Hover motion. One of lift, scale, lift-scale, none.

?string

Optional. Leave it out and the site uses "". Any Font Awesome icon name, e.g. star, bolt, arrow-left-to-bracket (no “fa-” prefix). Browse at fontawesome.com/icons.

Enums\HeaderCtaIconFamily|string|null

Optional. Leave it out and the site uses "classic-regular". Icon family. One of classic-regular, duotone-regular, brands, jelly, jelly-duo, whiteboard.

Enums\HeaderCtaIconPosition|string|null

Optional. Leave it out and the site uses "before". Which side of the label the icon sits on (when an icon name is set). One of before, after.

?bool

Optional. Leave it out and the site uses false. The icon slides toward its side on hover (e.g. an arrow edges outward).

Enums\HeaderMobileSide|string|null

Optional. Leave it out and the site uses "right". Drawer side. One of right, left.

Enums\HeaderMobileWidth|string|null

Optional. Leave it out and the site uses "normal". Drawer width. One of narrow, normal, wide.

?string

Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. Optional. Leave empty to use the site surface color.

?string

?bool

Optional. Leave it out and the site uses true. Show logo in drawer.

?bool

Optional. Leave it out and the site uses true. Repeat the header button at the bottom of the mobile drawer.

?bool

Optional. Leave it out and the site uses true. A small animated hint shown when the menu links overflow.

?string

Enums\HeaderMobileLinkWeight|string|null

Optional. Leave it out and the site uses "bold". Weight. One of normal, medium, semibold, bold, extrabold.

Enums\HeaderMobileLinkSize|string|null

Optional. Leave it out and the site uses "normal". Size. One of small, normal, large.

?string

Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. Optional. Leave empty to use the site accent color.

?string

Enums\FooterBackgroundType|string|null

Optional. Leave it out and the site uses "default". Site default keeps the footer’s sunken surface; Solid color and Image override it. The site surface color is the fallback when a color is left empty. One of default, solid, image.

?string

Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. Used for a Solid background (and as the fallback behind an Image). Leave empty to use the site surface color.

?string

ImageArea|array<string, mixed>|null

Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. Widgets, top to bottom: send { "items": [ … ] }, one object per widget with its type. Writing it replaces the whole area.

?string

Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. Scrim over the image to keep the footer legible. Leave empty to use the surface color.

?string

?float

Optional. Leave it out and the site uses 85. Overlay opacity (%). 0 to 100.

Enums\FooterPadding|string|null

Optional. Leave it out and the site uses "normal". Vertical padding. One of tight, normal, roomy.

?bool

Optional. Leave it out and the site uses true. A hairline rule along the top edge of the footer.

?bool

Optional. Leave it out and the site uses true. Show “Back to top” button.

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

Optional. Optional logo shown at the top of the company column, used on the dark theme. Leave both footer logos empty to use the site logo (Site settings → Brand); with no logo at all the business name leads. Upload to the Images library first. The related @apostrophecms/image 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.

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

Enums\FooterLogoHeight|string|null

Optional. Leave it out and the site uses "medium". Logo height. One of small, medium, large.

Enums\FooterLogoAlign|string|null

Optional. Leave it out and the site uses "left". Aligns the logo within the company column (e.g. centered above the business name). One of left, center, right.

?bool

Optional. Leave it out and the site uses true. The business name as a heading at the top of the column. Turn off when the logo already carries the name.

?bool

Optional. Leave it out and the site uses true. Show tagline.

?bool

Optional. Leave it out and the site uses true. Show address, phone & email.

?string

Enums\FooterNameWeight|string|null

Optional. Leave it out and the site uses "bold". Weight. One of normal, medium, semibold, bold, extrabold.

Enums\FooterNameSize|string|null

Optional. Leave it out and the site uses "normal". Size. One of small, normal, large.

?string

Enums\FooterBrandWeight|string|null

Optional. Leave it out and the site uses "normal". Weight. One of normal, medium, semibold, bold, extrabold.

Enums\FooterBrandSize|string|null

Optional. Leave it out and the site uses "normal". Size. One of small, normal, large.

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

Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. Each group becomes a column in the footer. Add a Legal group for Terms & Privacy, etc.

Show GlobalFooterLinkGroupsItem (Fetchski\AttractCmsLaravel\Data\GlobalFooterLinkGroupsItem)

string

required

Required. Group heading.

?string

The row’s id, unique in its array.

Collection<int, GlobalFooterLinkGroupsItemLinksItem>|null

A list of GlobalFooterLinkGroupsItemLinksItem. Links.

Show GlobalFooterLinkGroupsItemLinksItem (Fetchski\AttractCmsLaravel\Data\GlobalFooterLinkGroupsItemLinksItem)

string

required

Required. Label.

string

required

Required. URL.

?string

The row’s id, unique in its array.

?bool

Opens in a new tab with an arrow indicator.

array<string, mixed>

Optional: any keys not listed above, by their wire names; they are sent with the rest.

array<string, mixed>

Optional: any keys not listed above, by their wire names; they are sent with the rest.

Enums\FooterLinkColumns|string|null

Optional. Leave it out and the site uses "2". How many columns the link groups flow into. Auto fits to the available width; a fixed count packs shorter groups together (e.g. Legal stacked under Elsewhere). Groups are never split across columns. One of auto, 2, 3, 4.

?string

Enums\FooterHeadingWeight|string|null

Optional. Leave it out and the site uses "bold". Weight. One of normal, medium, semibold, bold, extrabold.

Enums\FooterHeadingSize|string|null

Optional. Leave it out and the site uses "normal". Size. One of small, normal, large, xlarge.

?string

Enums\FooterLinkWeight|string|null

Optional. Leave it out and the site uses "normal". Weight. One of normal, medium, semibold, bold, extrabold.

Enums\FooterLinkSize|string|null

Optional. Leave it out and the site uses "normal". Size. One of small, normal, large.

?string

Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. Optional. Leave empty to use the site accent color.

?string

Enums\FooterLinkHoverEffect|string|null

Optional. Leave it out and the site uses "slide". Hover effect. One of none, slide, underline.

?bool

Optional. Leave it out and the site uses true. A slow ribbon of phrases scrolling across the top of the footer. Any page can override this for itself in Page Settings → Footer.

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

Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. Each phrase can carry its own icon; without one, a dot separates it from the next phrase.

Show GlobalFooterMarqueeItem (Fetchski\AttractCmsLaravel\Data\GlobalFooterMarqueeItem)

string

required

Required. Phrase.

?string

The row’s id, unique in its array.

?string

Any Font Awesome icon name, e.g. star, bolt, arrow-left-to-bracket (no “fa-” prefix). Browse at fontawesome.com/icons.

Enums\IconFamily|string|null

Icon family. One of classic-regular, duotone-regular, brands, jelly, jelly-duo, whiteboard.

?string

Optional — leave empty to use the design’s own color rhythm.

Enums\IconAnimation|string|null

Icon animation. One of none, fa-beat, fa-bounce, fa-fade, fa-beat-fade, fa-flip, fa-shake, fa-spin.

array<string, mixed>

Optional: any keys not listed above, by their wire names; they are sent with the rest.

Enums\FooterMarqueeSpeed|string|null

Optional. Leave it out and the site uses "normal". Marquee speed. One of slow, normal, fast.

?bool

Optional. Leave it out and the site uses false. Adds a small, unobtrusive pause/play control so visitors can stop the auto-playing background motion (WCAG 2.2.2). Only appears when a moving background is set.

?string

Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. Optional. Leave empty for the muted default.

?string

Enums\FooterMarqueeWeight|string|null

Optional. Leave it out and the site uses "bold". Weight. One of normal, medium, semibold, bold, extrabold.

?bool

Optional. Leave it out and the site uses true. A giant outlined word along the bottom of the footer. Reveals/fills on hover.

?string

Optional. Leave it out and the site uses "". Keep it to one short word — it renders at display size. Leave empty to use the business name.

Enums\FooterWordmarkSize|string|null

Optional. Leave it out and the site uses "display". Watermark size. One of display, large, medium.

Enums\FooterWordmarkAlign|string|null

Optional. Leave it out and the site uses "left". Watermark alignment. One of left, center, right.

Enums\FooterWordmarkFill|string|null

Optional. Leave it out and the site uses "letter". Outlined letters that fill on hover one at a time, all at once, or always-solid (no ghost effect). One of letter, word, solid.

?string

Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. Optional. Overrides the wordmark fill + outline tint. Leave empty to track the theme’s text color.

?string

Optional. Leave it out and the site uses "© {year} {business}. All rights reserved.". Type {year} where this year goes (it updates itself every January) and {business} for the business name. Left empty, the site shows “© {year} {business}. All rights reserved.”

?string

Optional. Leave it out and the site uses "". Optional short line shown beside the copyright (e.g. a slogan or license number).

?string

Enums\FooterCopyrightWeight|string|null

Optional. Leave it out and the site uses "normal". Weight. One of normal, medium, semibold, bold, extrabold.

Enums\FooterCopyrightSize|string|null

Optional. Leave it out and the site uses "small". Size. One of small, normal, large.

Optional. Leave it out and the site uses true. Render the site’s social profiles (configured in the “Social Links” tab) in the footer.

Optional. Leave it out and the site uses "". Optional small heading above the icons (e.g. “Follow us”). Leave empty for none.

Optional. Leave it out and the site uses "brand". In the company column (under the contact details) or as its own centered row above the copyright bar. One of brand, bar.

Optional. Leave it out and the site uses false. A hairline rule above the dedicated social row, for a touch of separation from the watermark.

Optional. Leave it out and the site uses "outline". Icon style. One of bare, outline, solid.

Optional. Leave it out and the site uses "normal". Icon size. One of small, normal, large, xlarge.

Optional. Leave it out and the site uses "normal". Gap between the icons. One of tight, normal, loose.

Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. Optional. Leave empty to match the footer’s other group headings (Footer: Links tab).

Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. Resting icon color. Leave empty for the muted default.

Optional. Leave it out and the site uses "brand". Hover to each platform’s own brand color, or to the site accent (or a chosen hover color). One of brand, accent.

Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. Used when “Hover color” is Accent / custom. Leave empty for the site accent.

?bool

Optional. Leave it out and the site uses false. OFF by default. While off, the server rejects every file submitted through a public form, regardless of the form’s fields. Turn on only after setting the limits below — anonymous file uploads are a deliberate, security-sensitive choice.

?int

Optional. Leave it out and the site uses 3. How many files one submission may include (hard ceiling 8). 1 to 8.

?int

Optional. Leave it out and the site uses 5. Largest single file accepted, in megabytes (hard ceiling 10 MB). 1 to 10.

array<int, Enums\FormUploadAllowedTypes|string>|Collection<int, Enums\FormUploadAllowedTypes|string>|null

Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. Only these categories are accepted. Each file’s actual contents are verified by signature (magic bytes), not just its extension, so a renamed file is rejected. SVG and other script-capable formats can never be enabled here. Each one of image, pdf, office, text.

Returns

A GlobalContent (Fetchski\AttractCmsLaravel\Data\GlobalContent). The site-wide settings document (one per site and locale), with the fields this site adds. Read its properties ($globalContent->id): 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, _logo → logo, _logoLight → logoLight …).

string

Always sent. Unique identifier.

string

Always sent. Default slug field.

string

Always sent.

Always sent. Change this — to “2”, a date, anything — and every visitor is asked again. Do that whenever what you do with the data materially changes; consent given under the old terms does not carry over.

Always sent. Banner message.

Always sent. Accept button.

Always sent. Give this the same visual weight as Accept. A reject option that is harder to find than accept is the single most commonly penalized banner design.

Always sent. Preferences panel heading.

CarbonImmutable

Always sent. Created At. Format: an ISO 8601 date and time.

CarbonImmutable

Always sent. Updated At. Format: an ISO 8601 date and time.

?string

Sometimes sent: null when the site leaves it out. Default title field.

?string

Sometimes sent: null when the site leaves it out. The _id of the piece/page that was copied to create this document (only present if created via _copyingId)

?string

Sometimes sent: null when the site leaves it out. Business name.

?string

Sometimes sent: null when the site leaves it out. Tagline.

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

Sometimes sent: null when the site leaves it out. Shown in the site header on the dark theme (and over the hero). Upload to the Images library first. The related @apostrophecms/image 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.

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

Sometimes sent: null when the site leaves it out. Optional darker logo for the light theme. If empty, the white logo is auto-inverted. The related @apostrophecms/image 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.

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

Sometimes sent: null when the site leaves it out. Browser tab icon — the default, also used when the browser is in dark mode. Upload a square PNG or SVG (at least 64×64) to the Images library. If empty, the bundled default icon is used. The related @apostrophecms/image 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.

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

Sometimes sent: null when the site leaves it out. Optional. Used when the visitor’s BROWSER or device is in light mode — this follows the browser’s color scheme, not the site’s own theme toggle. If empty, the main favicon is used everywhere. The related @apostrophecms/image 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.

?string

Sometimes sent: null when the site leaves it out. Shown in the footer. Use up to three lines for a full street address, or just one for a town/region.

?string

Sometimes sent: null when the site leaves it out. Address line 2.

?string

Sometimes sent: null when the site leaves it out. Address line 3.

?string

Sometimes sent: null when the site leaves it out. Phone.

?string

Sometimes sent: null when the site leaves it out. Email.

?string

Sometimes sent: null when the site leaves it out. The registered name of the company, e.g. “Example Holdings LLC”. Fills [Business legal name].

?string

Sometimes sent: null when the site leaves it out. Any other names the business operates under, e.g. “Example Studio and Example Supply”. Fills [Trade names].

?string

Sometimes sent: null when the site leaves it out. Where the business is based, for governing law. Fills [State or region].

?string

Sometimes sent: null when the site leaves it out. Fills [Country].

?string

Sometimes sent: null when the site leaves it out. Where legal disputes are heard. Fills [County or venue].

?string

Sometimes sent: null when the site leaves it out. The youngest age your website is intended for, e.g. “13”. Fills [Minimum age].

?string

Sometimes sent: null when the site leaves it out. Your main brand color — buttons, links, accents. Hover + soft tints are derived automatically. Leave empty for the built-in design color.

?string

Sometimes sent: null when the site leaves it out. A CSS color (#625bff, #625bffff, rgb(…), hsl(…), a color name) or a palette token’s name (--fetchski-accent).

?string

Sometimes sent: null when the site leaves it out. Text/icon color shown ON primary-colored buttons. Defaults to white — set a dark color if your primary is pale.

?string

Sometimes sent: null when the site leaves it out. A CSS color (#625bff, #625bffff, rgb(…), hsl(…), a color name) or a palette token’s name (--fetchski-accent).

?string

Sometimes sent: null when the site leaves it out. Supporting color — eyebrows, offset shadows, secondary accents.

?string

Sometimes sent: null when the site leaves it out. A CSS color (#625bff, #625bffff, rgb(…), hsl(…), a color name) or a palette token’s name (--fetchski-accent).

?string

Sometimes sent: null when the site leaves it out. Warm accent, used sparingly.

?string

Sometimes sent: null when the site leaves it out. A CSS color (#625bff, #625bffff, rgb(…), hsl(…), a color name) or a palette token’s name (--fetchski-accent).

?string

Sometimes sent: null when the site leaves it out. Body-text link color (rich-text content). Leave empty to track the primary color.

?string

Sometimes sent: null when the site leaves it out. A CSS color (#625bff, #625bffff, rgb(…), hsl(…), a color name) or a palette token’s name (--fetchski-accent).

?string

Sometimes sent: null when the site leaves it out. The base page background.

?string

Sometimes sent: null when the site leaves it out. A CSS color (#625bff, #625bffff, rgb(…), hsl(…), a color name) or a palette token’s name (--fetchski-accent).

?string

Sometimes sent: null when the site leaves it out. Cards and raised panels that sit above the page background.

?string

Sometimes sent: null when the site leaves it out. A CSS color (#625bff, #625bffff, rgb(…), hsl(…), a color name) or a palette token’s name (--fetchski-accent).

?string

Sometimes sent: null when the site leaves it out. Recessed / inset bands.

?string

Sometimes sent: null when the site leaves it out. A CSS color (#625bff, #625bffff, rgb(…), hsl(…), a color name) or a palette token’s name (--fetchski-accent).

?string

Sometimes sent: null when the site leaves it out. Primary text color. Mind contrast against the page background.

?string

Sometimes sent: null when the site leaves it out. A CSS color (#625bff, #625bffff, rgb(…), hsl(…), a color name) or a palette token’s name (--fetchski-accent).

?string

Sometimes sent: null when the site leaves it out. Secondary / muted text color.

?string

Sometimes sent: null when the site leaves it out. A CSS color (#625bff, #625bffff, rgb(…), hsl(…), a color name) or a palette token’s name (--fetchski-accent).

?string

Sometimes sent: null when the site leaves it out. Borders and dividers.

?string

Sometimes sent: null when the site leaves it out. A CSS color (#625bff, #625bffff, rgb(…), hsl(…), a color name) or a palette token’s name (--fetchski-accent).

?string

Sometimes sent: null when the site leaves it out. Positive / confirmation state (forms, alerts).

?string

Sometimes sent: null when the site leaves it out. A CSS color (#625bff, #625bffff, rgb(…), hsl(…), a color name) or a palette token’s name (--fetchski-accent).

?string

Sometimes sent: null when the site leaves it out. Caution state.

?string

Sometimes sent: null when the site leaves it out. A CSS color (#625bff, #625bffff, rgb(…), hsl(…), a color name) or a palette token’s name (--fetchski-accent).

?string

Sometimes sent: null when the site leaves it out. Error / destructive state.

?string

Sometimes sent: null when the site leaves it out. A CSS color (#625bff, #625bffff, rgb(…), hsl(…), a color name) or a palette token’s name (--fetchski-accent).

?string

Sometimes sent: null when the site leaves it out. Informational state.

?string

Sometimes sent: null when the site leaves it out. A CSS color (#625bff, #625bffff, rgb(…), hsl(…), a color name) or a palette token’s name (--fetchski-accent).

Enums\FontDisplaySource|string|null

Sometimes sent: null when the site leaves it out. Typeface used for headings and display type. Default is the built-in design font; the other sources replace it site-wide. One of default, curated, cdn, upload; a newer site may send others, so keep a fallback.

Enums\FontDisplayCurated|string|null

Sometimes sent: null when the site leaves it out. Display font — curated pick. One of clash-display, satoshi, general-sans, space-grotesk, bricolage-grotesque, archivo, sora, syne, outfit, unbounded, fraunces, playfair-display, zodiak, sentient; a newer site may send others, so keep a fallback.

Enums\FontDisplayCdnProvider|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”.

?string

Sometimes sent: null when the site leaves it out. Comma-separated weights to load, e.g. 400, 700. Empty loads 500, 700, 800. Weights the family doesn’t ship are skipped by the CDN and synthesized by the browser (faux bold).

Collection<int, GlobalFontDisplayUploadsItem>|null

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

Show GlobalFontDisplayUploadsItem (Fetchski\AttractCmsLaravel\Data\GlobalFontDisplayUploadsItem)

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>

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.

Enums\FontDisplayFallback|string|null

Sometimes sent: null when the site leaves it out. Generic system fonts shown while the font 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.

Enums\FontBodySource|string|null

Sometimes sent: null when the site leaves it out. Typeface used for body text and UI. Default is the built-in design font; the other sources replace it site-wide. One of default, curated, cdn, upload; a newer site may send others, so keep a fallback.

Enums\FontBodyCurated|string|null

Sometimes sent: null when the site leaves it out. Body font — curated pick. One of inter, manrope, public-sans, work-sans, nunito-sans, ibm-plex-sans, source-sans-3, dm-sans, karla, switzer, supreme, satoshi, general-sans, lora, source-serif-4; a newer site may send others, so keep a fallback.

Enums\FontBodyCdnProvider|string|null

?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”.

?string

Sometimes sent: null when the site leaves it out. Comma-separated weights to load, e.g. 400, 700. Empty loads 400, 500, 600, 700. Weights the family doesn’t ship are skipped by the CDN and synthesized by the browser (faux bold).

Collection<int, GlobalFontBodyUploadsItem>|null

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

Show GlobalFontBodyUploadsItem (Fetchski\AttractCmsLaravel\Data\GlobalFontBodyUploadsItem)

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\FontBodyFallback|string|null

Enums\FontAccentSource|string|null

Sometimes sent: null when the site leaves it out. Typeface used for code blocks and monospace accents. Default is the built-in design font; the other sources replace it site-wide. One of default, curated, cdn, upload; a newer site may send others, so keep a fallback.

Enums\FontAccentCurated|string|null

Sometimes sent: null when the site leaves it out. Accent / mono font — curated pick. One of jetbrains-mono, ibm-plex-mono, fira-code, space-mono, source-code-pro, dm-mono, inconsolata, ubuntu-mono, courier-prime, red-hat-mono, spline-sans-mono, victor-mono; a newer site may send others, so keep a fallback.

Enums\FontAccentCdnProvider|string|null

?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”.

?string

Sometimes sent: null when the site leaves it out. Comma-separated weights to load, e.g. 400, 700. Empty loads 400, 700. Weights the family doesn’t ship are skipped by the CDN and synthesized by the browser (faux bold).

Collection<int, GlobalFontAccentUploadsItem>|null

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

Show GlobalFontAccentUploadsItem (Fetchski\AttractCmsLaravel\Data\GlobalFontAccentUploadsItem)

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\FontAccentFallback|string|null

Enums\ContentWidth|string|null

Sometimes sent: null when the site leaves it out. The widest the page content gets: sections, layouts, the header and the footer all line up to it. Smaller screens always use their full width, minus the side margins. One of standard, wide, xwide; a newer site may send others, so keep a fallback.

Sometimes sent: null when the site leaves it out. A list of GlobalSocialLinksItem. Each profile is optional — add only the networks you use. A link only appears once it has a URL. Pick a platform for its brand icon, or “Other / custom” to choose any icon.

Show GlobalSocialLinksItem (Fetchski\AttractCmsLaravel\Data\GlobalSocialLinksItem)

Enums\Platform|string

Always sent. Platform. One of instagram, facebook, x-twitter, youtube, tiktok, linkedin, github, pinterest, whatsapp, snapchat, threads, bluesky, mastodon, yelp, google, spotify, vimeo, custom; a newer site may send others, so keep a fallback.

string

Always sent. Full link to the profile, e.g. https://instagram.com/yourbusiness. Format: an absolute URL.

?string

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

?string

Sometimes sent: null when the site leaves it out. Overrides the screen-reader / tooltip label. Recommended for a custom platform — defaults to the icon name (e.g. “discord” → “Discord”).

?string

Sometimes sent: null when the site leaves it out. Font Awesome icon name (no “fa-” prefix), e.g. discord. Browse fontawesome.com/icons.

Enums\IconFamily|string|null

Sometimes sent: null when the site leaves it out. Custom icon family. One of classic-regular, duotone-regular, brands, jelly, jelly-duo, whiteboard; a newer site may send others, so keep a fallback.

array<string, mixed>

?ImageArea

Sometimes sent: null when the site leaves it out. An ImageArea. Site-wide fallback for link previews (Open Graph): used on any page that has neither its own Social share image nor a featured image. Recommended 1200×630. Widgets, top to bottom: send { "items": [ … ] }, one object per widget with its type. Writing it replaces the whole area.

Show ImageArea (Fetchski\AttractCmsLaravel\Data\ImageArea)

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, ImageWidget>|null

Sometimes sent: null when the site leaves it out. A list of ImageWidget. 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 ImageWidget (Fetchski\AttractCmsLaravel\Data\ImageWidget)

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

Enums\ImageWidgetType|string

Always sent. The widget’s type: always @apostrophecms/image. One of @apostrophecms/image; 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.

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

Sometimes sent: null when the site leaves it out. The related @apostrophecms/image 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.

?string

Sometimes sent: null when the site leaves it out. Caption.

Enums\LinkTo|string|null

Sometimes sent: null when the site leaves it out. Link To… One of none, @apostrophecms/any-page-type, _url; a newer site may send others, so keep a fallback.

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

Sometimes sent: null when the site leaves it out. The related @apostrophecms/any-page-type 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.

?string

Sometimes sent: null when the site leaves it out. apostrophe:linkHrefHelp When set, a URL; empty or null when not.

?string

Sometimes sent: null when the site leaves it out. Link Title.

?string

Sometimes sent: null when the site leaves it out. If empty, the title of the related document will be used.

Collection<int, Enums\LinkTarget|string>|null

Sometimes sent: null when the site leaves it out. Link Target. Each one of _blank.

?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>

?bool

Sometimes sent: null when the site leaves it out. Adds schema.org structured data about the business to every page, built from the Brand tab’s business name, address, phone and email plus the Social Links list. Helps search engines show rich results. Nothing is published until this is on and a business name is set.

Enums\SeoStructuredDataType|string|null

Sometimes sent: null when the site leaves it out. The schema.org type that best describes the business. “Local business” fits most sites with a physical location or service area. One of LocalBusiness, Organization, ProfessionalService, Store; a newer site may send others, so keep a fallback.

?bool

Sometimes sent: null when the site leaves it out. Adds the Service Area Map’s coverage (place names, service radius) to the business structured data on every page, and the full zip-code/boundary detail on pages with a Service Area Map section. Helps search engines and AI answers understand where the business serves — there is no visual search result for this, and it never affects map-pack ranking. Keep it consistent with the areas on the business’s Google Business Profile. Demo map data is never published.

?string

Sometimes sent: null when the site leaves it out. Optional, plain words — e.g. “House cleaning” or “Airport transfers”. When set, the structured data pairs it with the service areas as a schema.org Service; when empty the areas attach directly to the business.

Enums\AnalyticsProvider|string|null

Sometimes sent: null when the site leaves it out. Plausible is a privacy-friendly, cookieless analytics service. Visitor page views are counted anonymously; logged-in editors are never tracked. One of none, plausible; a newer site may send others, so keep a fallback.

?string

Sometimes sent: null when the site leaves it out. Paste the script address from your site’s snippet in Plausible → Site Settings → Site Installation (it looks like https://plausible.io/js/pa-XXXXXXXX.js and is unique per site). Analytics stay off until this is set. Optional measurements (outbound links, file downloads, form submissions) are toggled in the Plausible dashboard — no change needed here. When set, a URL; empty or null when not.

Sometimes sent: null when the site leaves it out. Off hides the banner AND stops every non-essential cookie and third-party embed — declining is the only safe reading of “never asked”. Turn it off only on a site that sets nothing beyond the strictly necessary.

Sometimes sent: null when the site leaves it out. Where opt-in applies, nothing non-essential runs until the visitor agrees. Everyone else sees the same banner as a notice: analytics and embedded content work immediately, and declining switches them off. The first option follows the law that is strictest about being asked first, without putting a wall in front of visitors whose law does not require one. One of eu, all, notice; a newer site may send others, so keep a fallback.

Sometimes sent: null when the site leaves it out. Country comes from your CDN or proxy (Cloudflare’s header, or one you configure). Without it the site falls back to this, plus a browser time-zone check that quietly upgrades an apparently European visitor to opt-in. Put Cloudflare or a GeoIP header in front of the site and this setting stops mattering. One of lenient, strict; a newer site may send others, so keep a fallback.

Sometimes sent: null when the site leaves it out. Banner position. One of left, right, center, full; a newer site may send others, so keep a fallback.

Sometimes sent: null when the site leaves it out. Opens the per-category preferences panel. Leaving it on is the safer choice: accept-or-reject with no middle option is what regulators have been fining sites over.

Sometimes sent: null when the site leaves it out. A small button pinned to the bottom corner, over the page. Off by default because the footer link below already offers this — turn it on if you want the control visible without scrolling.

Sometimes sent: null when the site leaves it out. Puts the reopen control at the bottom of every page, under the “Powered by” line — where visitors look for it. Uses the reopen label from the Cookie banner wording tab. Leave this on unless the floating button above is on instead: consent must stay as easy to withdraw as it was to give.

Sometimes sent: null when the site leaves it out. GPC is a browser-level “do not sell or share my data” signal, legally binding in several US states. When on, a visitor sending it starts with everything non-essential switched off — they can still turn categories on by hand.

Sometimes sent: null when the site leaves it out. A third-party script that has already run cannot be switched off in place: it keeps running until the next full page load (each vendor is still told about the withdrawal straight away). On, the page reloads as soon as a visitor switches a category OFF, so nothing they declined keeps running. Off by default: the reload interrupts whatever the visitor was doing, and most visitors are not in a region that requires it.

Sometimes sent: null when the site leaves it out. How long a visitor’s answer stands before the banner returns. Six months is the common practice and twelve is the usual ceiling. 1 to 365.

Sometimes sent: null when the site leaves it out. Stores a receipt for each decision (which categories, when, under which policy version) so you can show consent was given. Kept for two years, then deleted automatically.

Sometimes sent: null when the site leaves it out. Optional. Leave empty for the message alone, which is how most banners read best.

Sometimes sent: null when the site leaves it out. Rendered after the message as a link to the policy page. Leave empty to omit it.

Sometimes sent: null when the site leaves it out. A path on this site or a full URL. The default matches the parked Cookie Policy page.

Sometimes sent: null when the site leaves it out. Customize button.

Sometimes sent: null when the site leaves it out. Save-choices button.

Sometimes sent: null when the site leaves it out. Reopen control label.

Sometimes sent: null when the site leaves it out. Preferences panel intro.

Sometimes sent: null when the site leaves it out. Strictly necessary — label.

Sometimes sent: null when the site leaves it out. Shown beside this category’s switch in the preferences panel. Say what the visitor gains or loses, not which vendors are involved.

Sometimes sent: null when the site leaves it out. Functional — label.

Sometimes sent: null when the site leaves it out. Shown beside this category’s switch in the preferences panel. Say what the visitor gains or loses, not which vendors are involved.

Sometimes sent: null when the site leaves it out. Analytics — label.

Sometimes sent: null when the site leaves it out. Shown beside this category’s switch in the preferences panel. Say what the visitor gains or loses, not which vendors are involved.

Sometimes sent: null when the site leaves it out. Marketing — label.

Sometimes sent: null when the site leaves it out. Shown beside this category’s switch in the preferences panel. Say what the visitor gains or loses, not which vendors are involved.

Sometimes sent: null when the site leaves it out. Shown in place of an embed (a map, a social video) that is waiting on consent.

Sometimes sent: null when the site leaves it out. Blocked-content message.

Sometimes sent: null when the site leaves it out. Blocked-content button.

?bool

Sometimes sent: null when the site leaves it out. Takes the public site offline. Visitors and search engines see a “be right back” page (served with the correct temporary-outage signals, so search rankings are preserved); logged-in editors keep the full site and can continue editing. A new site starts with this on: turn it off when the site is ready to go live.

Enums\MaintenanceRetryAfter|string|null

Sometimes sent: null when the site leaves it out. How long search engines should wait before checking back (the Retry-After hint). A rough estimate is fine — it is a hint, not a promise, and nothing switches back automatically. One of 3600, 14400, 43200, 86400, 259200, 604800; a newer site may send others, so keep a fallback.

?string

Sometimes sent: null when the site leaves it out. Optional short message shown on the maintenance page (e.g. what is happening or when you expect to be back). Leave empty for a generic “we’ll be back soon” line.

?string

Sometimes sent: null when the site leaves it out. Public reCAPTCHA v3 site key. Managed automatically from Connections → Spam protection — edit it there, not here.

?bool

Sometimes sent: null when the site leaves it out. Whether anonymous page views are being recorded. Managed automatically from Visitor data → Request log — edit it there, not here.

Sometimes sent: null when the site leaves it out. Whether anonymous visitors get the first-party visitor-ID cookie. Managed automatically from Visitor data → Request log — edit it there, not here.

?bool

Sometimes sent: null when the site leaves it out. Whether conversions and ad attribution are being recorded. Managed automatically from Visitor data → Conversions — edit it there, not here.

?string

Sometimes sent: null when the site leaves it out. Sites visitors continue to (a booking site), for cross-domain ad attribution. Managed automatically from Visitor data → Conversions — edit it there, not here.

?string

Sometimes sent: null when the site leaves it out. Public (referrer-restricted) Maps JavaScript key — the Service Area Map loads Google Maps with it. Managed automatically from Connections → Google Maps — edit it there, not here.

?bool

Sometimes sent: null when the site leaves it out. Master switch for the site’s scroll and entrance motion (section reveals, count-ups, marquees, the hero). When off, no animation code is loaded and every section appears in its final, static state. Visitors whose device requests reduced motion always get the static experience regardless of this setting.

?DesignLayer

Sometimes sent: null when the site leaves it out. A DesignLayer. Site-wide CSS for every section of a type and for shared elements (buttons, the header, the footer…). Type into the slot of the part you want to style; a section’s own CSS tab wins over this.

Show DesignLayer (Fetchski\AttractCmsLaravel\Data\DesignLayer)

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

Enums\HeaderStyle|string|null

Sometimes sent: null when the site leaves it out. Floating rests transparent over the hero and morphs to glass on scroll; Glass is frosted from the top; Solid is an opaque bar (uses the bar background color). One of floating, glass, solid; a newer site may send others, so keep a fallback.

Enums\HeaderWidth|string|null

Sometimes sent: null when the site leaves it out. Island floats as a contained pill; Full width spans edge-to-edge (squared corners, content still centered). Full width ignores the corner radius below. One of island, full; a newer site may send others, so keep a fallback.

Enums\HeaderBarRadius|string|null

Sometimes sent: null when the site leaves it out. Applies to the Island bar (Full width is always squared). One of pill, rounded, slight, square; a newer site may send others, so keep a fallback.

?string

Sometimes sent: null when the site leaves it out. The bar fill for Glass / Solid styles (and the glass tint when scrolled). Leave empty to use the raised surface color.

?string

Sometimes sent: null when the site leaves it out. A CSS color (#625bff, #625bffff, rgb(…), hsl(…), a color name) or a palette token’s name (--fetchski-accent).

?bool

Sometimes sent: null when the site leaves it out. A hairline outline around the bar (shown when glass / solid / scrolled).

?bool

Sometimes sent: null when the site leaves it out. A soft drop shadow under the bar (when glass / solid / scrolled).

?bool

Sometimes sent: null when the site leaves it out. The bar slides away when scrolling down and returns when scrolling up.

?bool

Sometimes sent: null when the site leaves it out. The floating bar stays transparent at the top and becomes a glass pill once the page scrolls. Turn off to keep it transparent.

?bool

Sometimes sent: null when the site leaves it out. Keeps the whole navbar (bar, logo, wordmark, links, dropdown, button and mobile menu) in its dark-theme look even when a visitor switches to the light theme, e.g. a header that always sits over a dark hero photo. While on, the light-theme header colors and the light-theme logo are not used. Off follows the site theme.

Enums\HeaderNavBreakpoint|string|null

Sometimes sent: null when the site leaves it out. Below this width the links collapse into the mobile menu (hamburger). Raise it if you have many or long links. One of md, lg, xl; a newer site may send others, so keep a fallback.

Enums\HeaderLogoHeight|string|null

Sometimes sent: null when the site leaves it out. Logo height. One of small, medium, large; a newer site may send others, so keep a fallback.

?bool

Sometimes sent: null when the site leaves it out. A subtle tilt + scale when the cursor is over the logo lockup.

?bool

Sometimes sent: null when the site leaves it out. The business name in type beside the logo. Turn off when the logo already includes the name.

?string

Sometimes sent: null when the site leaves it out. Optional override of the text wordmark. Leave empty to use the business name.

?bool

Sometimes sent: null when the site leaves it out. Render the first word large and the rest as a small tracked-out caption beneath it. Off renders the whole wordmark on one line.

?string

Sometimes sent: null when the site leaves it out. A CSS color (#625bff, #625bffff, rgb(…), hsl(…), a color name) or a palette token’s name (--fetchski-accent).

?string

Sometimes sent: null when the site leaves it out. A CSS color (#625bff, #625bffff, rgb(…), hsl(…), a color name) or a palette token’s name (--fetchski-accent).

Enums\HeaderNameWeight|string|null

Sometimes sent: null when the site leaves it out. Weight. One of normal, medium, semibold, bold, extrabold; a newer site may send others, so keep a fallback.

Enums\HeaderNameSize|string|null

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

?string

Sometimes sent: null when the site leaves it out. A CSS color (#625bff, #625bffff, rgb(…), hsl(…), a color name) or a palette token’s name (--fetchski-accent).

?string

Sometimes sent: null when the site leaves it out. A CSS color (#625bff, #625bffff, rgb(…), hsl(…), a color name) or a palette token’s name (--fetchski-accent).

Enums\HeaderSublineWeight|string|null

Sometimes sent: null when the site leaves it out. Weight. One of normal, medium, semibold, bold, extrabold; a newer site may send others, so keep a fallback.

Collection<int, GlobalHeaderNavItem>|null

Sometimes sent: null when the site leaves it out. A list of GlobalHeaderNavItem. Header navigation.

Show GlobalHeaderNavItem (Fetchski\AttractCmsLaravel\Data\GlobalHeaderNavItem)

string

Always sent. Label.

string

Always sent. URL.

?string

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

Enums\Placement|string|null

Sometimes sent: null when the site leaves it out. Desktop only — every link is listed in the mobile menu. One of visible, more; a newer site may send others, so keep a fallback.

array<string, mixed>

?string

Sometimes sent: null when the site leaves it out. Label for the overflow dropdown that holds links placed in “More”.

?string

Sometimes sent: null when the site leaves it out. A CSS color (#625bff, #625bffff, rgb(…), hsl(…), a color name) or a palette token’s name (--fetchski-accent).

?string

Sometimes sent: null when the site leaves it out. A CSS color (#625bff, #625bffff, rgb(…), hsl(…), a color name) or a palette token’s name (--fetchski-accent).

Enums\HeaderNavLinkWeight|string|null

Sometimes sent: null when the site leaves it out. Weight. One of normal, medium, semibold, bold, extrabold; a newer site may send others, so keep a fallback.

Enums\HeaderNavLinkSize|string|null

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

Enums\HeaderNavIndicator|string|null

Sometimes sent: null when the site leaves it out. How the hovered / active link is marked. One of sweep, grow, pill, none; a newer site may send others, so keep a fallback.

?string

Sometimes sent: null when the site leaves it out. Optional. Leave empty to use the site accent color.

?string

Sometimes sent: null when the site leaves it out. A CSS color (#625bff, #625bffff, rgb(…), hsl(…), a color name) or a palette token’s name (--fetchski-accent).

?string

Sometimes sent: null when the site leaves it out. Color + indicator for the current page’s link. Leave empty to use the secondary (mint) color.

?string

Sometimes sent: null when the site leaves it out. A CSS color (#625bff, #625bffff, rgb(…), hsl(…), a color name) or a palette token’s name (--fetchski-accent).

?string

Sometimes sent: null when the site leaves it out. The visible button text. Leave empty to hide the button.

?string

Sometimes sent: null when the site leaves it out. Where the button goes — a path (/blog) or full URL.

?bool

Sometimes sent: null when the site leaves it out. Opens the link in a new browser tab (adds rel=“noopener noreferrer”).

Enums\HeaderCtaVariant|string|null

Sometimes sent: null when the site leaves it out. Solid fills with the color; Outline / Soft / Text link use it for the border + text. One of solid, outline, soft, link; a newer site may send others, so keep a fallback.

Enums\HeaderCtaSize|string|null

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

Enums\HeaderCtaRadius|string|null

Sometimes sent: null when the site leaves it out. Corner radius. One of pill, rounded, slight, square; a newer site may send others, so keep a fallback.

?string

Sometimes sent: null when the site leaves it out. Solid fill, or the border + text for the other styles. Defaults to the brand accent; CLEAR it for a transparent, outline-only button.

?string

Sometimes sent: null when the site leaves it out. A CSS color (#625bff, #625bffff, rgb(…), hsl(…), a color name) or a palette token’s name (--fetchski-accent).

?string

Sometimes sent: null when the site leaves it out. The text/icon color. Clear it to derive from the button color (readable on solid fills).

?string

Sometimes sent: null when the site leaves it out. A CSS color (#625bff, #625bffff, rgb(…), hsl(…), a color name) or a palette token’s name (--fetchski-accent).

?string

Sometimes sent: null when the site leaves it out. Optional. Drives the hover treatment. Leave empty to derive it from the button color.

?string

Sometimes sent: null when the site leaves it out. A CSS color (#625bff, #625bffff, rgb(…), hsl(…), a color name) or a palette token’s name (--fetchski-accent).

Enums\HeaderCtaStyle|string|null

Sometimes sent: null when the site leaves it out. The hover treatment: a soft shadow, a colored offset shadow, a glow, a fill sweep, or a thicker border. One of none, single, dual, glow, sweep, thicken; a newer site may send others, so keep a fallback.

?string

Sometimes sent: null when the site leaves it out. Optional. The offset-shadow or glow color on hover. Leave empty to use the site secondary color.

?string

Sometimes sent: null when the site leaves it out. A CSS color (#625bff, #625bffff, rgb(…), hsl(…), a color name) or a palette token’s name (--fetchski-accent).

Enums\HeaderCtaAnimation|string|null

Sometimes sent: null when the site leaves it out. Hover motion. One of lift, scale, lift-scale, none; a newer site may send others, so keep a fallback.

?string

Sometimes sent: null when the site leaves it out. Any Font Awesome icon name, e.g. star, bolt, arrow-left-to-bracket (no “fa-” prefix). Browse at fontawesome.com/icons.

Enums\HeaderCtaIconFamily|string|null

Sometimes sent: null when the site leaves it out. Icon family. One of classic-regular, duotone-regular, brands, jelly, jelly-duo, whiteboard; a newer site may send others, so keep a fallback.

Enums\HeaderCtaIconPosition|string|null

Sometimes sent: null when the site leaves it out. Which side of the label the icon sits on (when an icon name is set). One of before, after; a newer site may send others, so keep a fallback.

?bool

Sometimes sent: null when the site leaves it out. The icon slides toward its side on hover (e.g. an arrow edges outward).

Enums\HeaderMobileSide|string|null

Sometimes sent: null when the site leaves it out. Drawer side. One of right, left; a newer site may send others, so keep a fallback.

Enums\HeaderMobileWidth|string|null

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

?string

Sometimes sent: null when the site leaves it out. Optional. Leave empty to use the site surface color.

?string

Sometimes sent: null when the site leaves it out. A CSS color (#625bff, #625bffff, rgb(…), hsl(…), a color name) or a palette token’s name (--fetchski-accent).

?bool

Sometimes sent: null when the site leaves it out. Show logo in drawer.

?bool

Sometimes sent: null when the site leaves it out. Repeat the header button at the bottom of the mobile drawer.

?bool

Sometimes sent: null when the site leaves it out. A small animated hint shown when the menu links overflow.

?string

Sometimes sent: null when the site leaves it out. A CSS color (#625bff, #625bffff, rgb(…), hsl(…), a color name) or a palette token’s name (--fetchski-accent).

?string

Sometimes sent: null when the site leaves it out. A CSS color (#625bff, #625bffff, rgb(…), hsl(…), a color name) or a palette token’s name (--fetchski-accent).

Enums\HeaderMobileLinkWeight|string|null

Sometimes sent: null when the site leaves it out. Weight. One of normal, medium, semibold, bold, extrabold; a newer site may send others, so keep a fallback.

Enums\HeaderMobileLinkSize|string|null

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

?string

Sometimes sent: null when the site leaves it out. Optional. Leave empty to use the site accent color.

?string

Sometimes sent: null when the site leaves it out. A CSS color (#625bff, #625bffff, rgb(…), hsl(…), a color name) or a palette token’s name (--fetchski-accent).

Enums\FooterBackgroundType|string|null

Sometimes sent: null when the site leaves it out. Site default keeps the footer’s sunken surface; Solid color and Image override it. The site surface color is the fallback when a color is left empty. One of default, solid, image; a newer site may send others, so keep a fallback.

?string

Sometimes sent: null when the site leaves it out. Used for a Solid background (and as the fallback behind an Image). Leave empty to use the site surface color.

?string

Sometimes sent: null when the site leaves it out. A CSS color (#625bff, #625bffff, rgb(…), hsl(…), a color name) or a palette token’s name (--fetchski-accent).

?ImageArea

Sometimes sent: null when the site leaves it out. An ImageArea. Widgets, top to bottom: send { "items": [ … ] }, one object per widget with its type. Writing it replaces the whole area. Its fields are listed under the first ImageArea above.

?string

Sometimes sent: null when the site leaves it out. Scrim over the image to keep the footer legible. Leave empty to use the surface color.

?string

Sometimes sent: null when the site leaves it out. A CSS color (#625bff, #625bffff, rgb(…), hsl(…), a color name) or a palette token’s name (--fetchski-accent).

?float

Sometimes sent: null when the site leaves it out. Overlay opacity (%). 0 to 100.

Enums\FooterPadding|string|null

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

?bool

Sometimes sent: null when the site leaves it out. A hairline rule along the top edge of the footer.

?bool

Sometimes sent: null when the site leaves it out. Show “Back to top” button.

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

Sometimes sent: null when the site leaves it out. Optional logo shown at the top of the company column, used on the dark theme. Leave both footer logos empty to use the site logo (Site settings → Brand); with no logo at all the business name leads. Upload to the Images library first. The related @apostrophecms/image 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.

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

Enums\FooterLogoHeight|string|null

Sometimes sent: null when the site leaves it out. Logo height. One of small, medium, large; a newer site may send others, so keep a fallback.

Enums\FooterLogoAlign|string|null

Sometimes sent: null when the site leaves it out. Aligns the logo within the company column (e.g. centered above the business name). One of left, center, right; a newer site may send others, so keep a fallback.

?bool

Sometimes sent: null when the site leaves it out. The business name as a heading at the top of the column. Turn off when the logo already carries the name.

?bool

Sometimes sent: null when the site leaves it out. Show tagline.

?bool

Sometimes sent: null when the site leaves it out. Show address, phone & email.

?string

Sometimes sent: null when the site leaves it out. A CSS color (#625bff, #625bffff, rgb(…), hsl(…), a color name) or a palette token’s name (--fetchski-accent).

?string

Sometimes sent: null when the site leaves it out. A CSS color (#625bff, #625bffff, rgb(…), hsl(…), a color name) or a palette token’s name (--fetchski-accent).

Enums\FooterNameWeight|string|null

Sometimes sent: null when the site leaves it out. Weight. One of normal, medium, semibold, bold, extrabold; a newer site may send others, so keep a fallback.

Enums\FooterNameSize|string|null

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

?string

Sometimes sent: null when the site leaves it out. A CSS color (#625bff, #625bffff, rgb(…), hsl(…), a color name) or a palette token’s name (--fetchski-accent).

?string

Sometimes sent: null when the site leaves it out. A CSS color (#625bff, #625bffff, rgb(…), hsl(…), a color name) or a palette token’s name (--fetchski-accent).

Enums\FooterBrandWeight|string|null

Sometimes sent: null when the site leaves it out. Weight. One of normal, medium, semibold, bold, extrabold; a newer site may send others, so keep a fallback.

Enums\FooterBrandSize|string|null

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

Collection<int, GlobalFooterLinkGroupsItem>|null

Sometimes sent: null when the site leaves it out. A list of GlobalFooterLinkGroupsItem. Each group becomes a column in the footer. Add a Legal group for Terms & Privacy, etc.

Show GlobalFooterLinkGroupsItem (Fetchski\AttractCmsLaravel\Data\GlobalFooterLinkGroupsItem)

string

Always sent. Group heading.

?string

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

Collection<int, GlobalFooterLinkGroupsItemLinksItem>|null

Sometimes sent: null when the site leaves it out. A list of GlobalFooterLinkGroupsItemLinksItem. Links.

Show GlobalFooterLinkGroupsItemLinksItem (Fetchski\AttractCmsLaravel\Data\GlobalFooterLinkGroupsItemLinksItem)

string

Always sent. Label.

string

Always sent. URL.

?string

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

?bool

Sometimes sent: null when the site leaves it out. Opens in a new tab with an arrow indicator.

array<string, mixed>

Enums\FooterLinkColumns|string|null

Sometimes sent: null when the site leaves it out. How many columns the link groups flow into. Auto fits to the available width; a fixed count packs shorter groups together (e.g. Legal stacked under Elsewhere). Groups are never split across columns. One of auto, 2, 3, 4; a newer site may send others, so keep a fallback.

?string

Sometimes sent: null when the site leaves it out. A CSS color (#625bff, #625bffff, rgb(…), hsl(…), a color name) or a palette token’s name (--fetchski-accent).

?string

Sometimes sent: null when the site leaves it out. A CSS color (#625bff, #625bffff, rgb(…), hsl(…), a color name) or a palette token’s name (--fetchski-accent).

Enums\FooterHeadingWeight|string|null

Sometimes sent: null when the site leaves it out. Weight. One of normal, medium, semibold, bold, extrabold; a newer site may send others, so keep a fallback.

Enums\FooterHeadingSize|string|null

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

?string

Sometimes sent: null when the site leaves it out. A CSS color (#625bff, #625bffff, rgb(…), hsl(…), a color name) or a palette token’s name (--fetchski-accent).

?string

Sometimes sent: null when the site leaves it out. A CSS color (#625bff, #625bffff, rgb(…), hsl(…), a color name) or a palette token’s name (--fetchski-accent).

Enums\FooterLinkWeight|string|null

Sometimes sent: null when the site leaves it out. Weight. One of normal, medium, semibold, bold, extrabold; a newer site may send others, so keep a fallback.

Enums\FooterLinkSize|string|null

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

?string

Sometimes sent: null when the site leaves it out. Optional. Leave empty to use the site accent color.

?string

Sometimes sent: null when the site leaves it out. A CSS color (#625bff, #625bffff, rgb(…), hsl(…), a color name) or a palette token’s name (--fetchski-accent).

Enums\FooterLinkHoverEffect|string|null

Sometimes sent: null when the site leaves it out. Hover effect. One of none, slide, underline; a newer site may send others, so keep a fallback.

?bool

Sometimes sent: null when the site leaves it out. A slow ribbon of phrases scrolling across the top of the footer. Any page can override this for itself in Page Settings → Footer.

Collection<int, GlobalFooterMarqueeItem>|null

Sometimes sent: null when the site leaves it out. A list of GlobalFooterMarqueeItem. Each phrase can carry its own icon; without one, a dot separates it from the next phrase.

Show GlobalFooterMarqueeItem (Fetchski\AttractCmsLaravel\Data\GlobalFooterMarqueeItem)

string

Always sent. Phrase.

?string

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

?string

Sometimes sent: null when the site leaves it out. Any Font Awesome icon name, e.g. star, bolt, arrow-left-to-bracket (no “fa-” prefix). Browse at fontawesome.com/icons.

Enums\IconFamily|string|null

?string

Sometimes sent: null when the site leaves it out. Optional — leave empty to use the design’s own color rhythm.

Enums\IconAnimation|string|null

Sometimes sent: null when the site leaves it out. Icon animation. One of none, fa-beat, fa-bounce, fa-fade, fa-beat-fade, fa-flip, fa-shake, fa-spin; a newer site may send others, so keep a fallback.

array<string, mixed>

Enums\FooterMarqueeSpeed|string|null

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

?bool

Sometimes sent: null when the site leaves it out. Adds a small, unobtrusive pause/play control so visitors can stop the auto-playing background motion (WCAG 2.2.2). Only appears when a moving background is set.

?string

Sometimes sent: null when the site leaves it out. Optional. Leave empty for the muted default.

?string

Sometimes sent: null when the site leaves it out. A CSS color (#625bff, #625bffff, rgb(…), hsl(…), a color name) or a palette token’s name (--fetchski-accent).

Enums\FooterMarqueeWeight|string|null

Sometimes sent: null when the site leaves it out. Weight. One of normal, medium, semibold, bold, extrabold; a newer site may send others, so keep a fallback.

?bool

Sometimes sent: null when the site leaves it out. A giant outlined word along the bottom of the footer. Reveals/fills on hover.

?string

Sometimes sent: null when the site leaves it out. Keep it to one short word — it renders at display size. Leave empty to use the business name.

Enums\FooterWordmarkSize|string|null

Sometimes sent: null when the site leaves it out. Watermark size. One of display, large, medium; a newer site may send others, so keep a fallback.

Enums\FooterWordmarkAlign|string|null

Sometimes sent: null when the site leaves it out. Watermark alignment. One of left, center, right; a newer site may send others, so keep a fallback.

Enums\FooterWordmarkFill|string|null

Sometimes sent: null when the site leaves it out. Outlined letters that fill on hover one at a time, all at once, or always-solid (no ghost effect). One of letter, word, solid; a newer site may send others, so keep a fallback.

?string

Sometimes sent: null when the site leaves it out. Optional. Overrides the wordmark fill + outline tint. Leave empty to track the theme’s text color.

?string

Sometimes sent: null when the site leaves it out. A CSS color (#625bff, #625bffff, rgb(…), hsl(…), a color name) or a palette token’s name (--fetchski-accent).

?string

Sometimes sent: null when the site leaves it out. Type {year} where this year goes (it updates itself every January) and {business} for the business name. Left empty, the site shows “© {year} {business}. All rights reserved.”

?string

Sometimes sent: null when the site leaves it out. Optional short line shown beside the copyright (e.g. a slogan or license number).

?string

Sometimes sent: null when the site leaves it out. A CSS color (#625bff, #625bffff, rgb(…), hsl(…), a color name) or a palette token’s name (--fetchski-accent).

?string

Sometimes sent: null when the site leaves it out. A CSS color (#625bff, #625bffff, rgb(…), hsl(…), a color name) or a palette token’s name (--fetchski-accent).

Enums\FooterCopyrightWeight|string|null

Sometimes sent: null when the site leaves it out. Weight. One of normal, medium, semibold, bold, extrabold; a newer site may send others, so keep a fallback.

Enums\FooterCopyrightSize|string|null

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

Sometimes sent: null when the site leaves it out. Render the site’s social profiles (configured in the “Social Links” tab) in the footer.

Sometimes sent: null when the site leaves it out. Optional small heading above the icons (e.g. “Follow us”). Leave empty for none.

Sometimes sent: null when the site leaves it out. In the company column (under the contact details) or as its own centered row above the copyright bar. One of brand, bar; a newer site may send others, so keep a fallback.

Sometimes sent: null when the site leaves it out. A hairline rule above the dedicated social row, for a touch of separation from the watermark.

Sometimes sent: null when the site leaves it out. Icon style. One of bare, outline, solid; a newer site may send others, so keep a fallback.

Sometimes sent: null when the site leaves it out. Icon size. One of small, normal, large, xlarge; a newer site may send others, so keep a fallback.

Sometimes sent: null when the site leaves it out. Gap between the icons. One of tight, normal, loose; a newer site may send others, so keep a fallback.

Sometimes sent: null when the site leaves it out. Optional. Leave empty to match the footer’s other group headings (Footer: Links tab).

Sometimes sent: null when the site leaves it out. A CSS color (#625bff, #625bffff, rgb(…), hsl(…), a color name) or a palette token’s name (--fetchski-accent).

Sometimes sent: null when the site leaves it out. Resting icon color. Leave empty for the muted default.

Sometimes sent: null when the site leaves it out. A CSS color (#625bff, #625bffff, rgb(…), hsl(…), a color name) or a palette token’s name (--fetchski-accent).

Sometimes sent: null when the site leaves it out. Hover to each platform’s own brand color, or to the site accent (or a chosen hover color). One of brand, accent; a newer site may send others, so keep a fallback.

Sometimes sent: null when the site leaves it out. Used when “Hover color” is Accent / custom. Leave empty for the site accent.

Sometimes sent: null when the site leaves it out. A CSS color (#625bff, #625bffff, rgb(…), hsl(…), a color name) or a palette token’s name (--fetchski-accent).

?bool

Sometimes sent: null when the site leaves it out. OFF by default. While off, the server rejects every file submitted through a public form, regardless of the form’s fields. Turn on only after setting the limits below — anonymous file uploads are a deliberate, security-sensitive choice.

?int

Sometimes sent: null when the site leaves it out. How many files one submission may include (hard ceiling 8). 1 to 8.

?int

Sometimes sent: null when the site leaves it out. Largest single file accepted, in megabytes (hard ceiling 10 MB). 1 to 10.

Collection<int, Enums\FormUploadAllowedTypes|string>|null

Sometimes sent: null when the site leaves it out. Only these categories are accepted. Each file’s actual contents are verified by signature (magic bytes), not just its extension, so a renamed file is rejected. SVG and other script-capable formats can never be enabled here. Each one of image, pdf, office, text.

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.

array<string, mixed>

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 global:write (or a master above it: global:all, admin:all). In published mode (the default) it goes live too, so the key also needs global:publish (or a master above it); send aposMode=draft (or a draft _id and no aposMode) to change only the draft. Custom CSS fields also need global:css. 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/ReplaceGlobalTest.php, then run your tests:

tests/Feature/ReplaceGlobalTest.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 ReplaceGlobalTest extends TestCase
{
    use RefreshDatabase;

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

        $this->actingAs(User::factory()->create())
            ->putJson('/global/ckitdo5oq004pu69kr6oxo6fr:en:published')
            ->assertOk();

        Attract::assertCalled('globalContent.replaceGlobal', fn (array $args): bool => $args['id'] === 'ckitdo5oq004pu69kr6oxo6fr:en:published');
    }
}

Terminal

php artisan test

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

tests/Feature/ReplaceGlobalAnswerTest.php

<?php

declare(strict_types=1);

namespace Tests\Feature;

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

final class ReplaceGlobalAnswerTest extends TestCase
{
    public function test_replace_global_answers_your_values(): void
    {
        Attract::fake([
            'globalContent.replaceGlobal' => GlobalContent::factory()->make(['id' => 'Your value']),
        ]);

        $globalContent = Attract::globalContent()->replaceGlobal(id: 'ckitdo5oq004pu69kr6oxo6fr:en:published', cookiePolicyVersion: '1', cookieMessage: 'This website uses cookies to supplement a balanced diet and provide a much deserved reward to the senses after consuming bland but nutritious meals. Accepting our cookies is optional but recommended, as they are delicious.', cookieAcceptLabel: 'Accept all', cookieRejectLabel: 'Reject all', cookiePrefsTitle: 'Cookie preferences');

        $this->assertSame('Your value', $globalContent->id);
    }
}

List global documents

Attract::globalContent()->listGlobalContent()

Create a global document

Attract::globalContent()->createGlobal()

Archive global documents

Attract::globalContent()->archiveGlobals()

Copy global documents to another locale

Attract::globalContent()->localizeGlobals()

Publish global documents

Attract::globalContent()->publishGlobals()

Restore global documents

Attract::globalContent()->restoreGlobals()

PUT /@apostrophecms/global/{_id}

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

use Fetchski\AttractCmsLaravel\Facades\Attract;

$globalContent = Attract::globalContent()->replaceGlobal(id: 'ckitdo5oq004pu69kr6oxo6fr:en:published', cookiePolicyVersion: '1', cookieMessage: 'This website uses cookies to supplement a balanced diet and provide a much deserved reward to the senses after consuming bland but nutritious meals. Accepting our cookies is optional but recommended, as they are delicious.', cookieAcceptLabel: 'Accept all', cookieRejectLabel: 'Reject all', cookiePrefsTitle: 'Cookie preferences');

{
  "_id": "global",
  "slug": "global",
  "type": "@apostrophecms/global",
  "cookiePolicyVersion": "1",
  "cookieMessage": "This website uses cookies to supplement a balanced diet and provide a much deserved reward to the senses after consuming bland but nutritious meals. Accepting our cookies is optional but recommended, as they are delicious.",
  "cookieAcceptLabel": "Accept all",
  "cookieRejectLabel": "Reject all",
  "cookiePrefsTitle": "Cookie preferences",
  "createdAt": "2026-10-24T09:30:00.000Z",
  "updatedAt": "2026-10-24T09:30:00.000Z"
}

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 global documents

Create a global document

Archive global documents

Copy global documents to another locale

Publish global documents

Restore global documents

PUT /@apostrophecms/global/{_id}

In your app

Call it from the terminal

Find the id

Behavior

Test it

Related

List global documents

Create a global document

Archive global documents

Copy global documents to another locale

Publish global documents

Restore global documents

PUT /@apostrophecms/global/{_id}