Copy a form to another locale

use Fetchski\AttractCmsLaravel\Facades\Attract;

$form = Attract::forms()->localizeForm(id: 'clx8m2k4p0000a1b2c3d4e5f6', toLocale: 'en');

{
  "title": "Example title",
  "contents": {
    "metaType": "area",
    "_id": "clx8m2k4p0000a1b2c3d4e5f6",
    "items": [
      {
        "type": "form-section",
        "_id": "clx8m2k4p0000a1b2c3d4e5f6",
        "metaType": "widget",
        "formFontOverrides": [],
        "formEyebrowEnabled": true,
        "formEyebrow": "Get in touch",
        "formEyebrowColor": "Example form eyebrow color",
        "formEyebrowColorLight": "Example form eyebrow color light",
        "formEyebrowWeight": "bold",
        "formEyebrowSize": "normal",
        "formHeading": "Send us a message",
        "formHeadingColor": "Example form heading color",
        "formHeadingColorLight": "Example form heading color light",
        "formHeadingWeight": "extrabold",
        "formHeadingSize": "normal",
        "formIntro": "Fill out the form below and we’ll get back to you shortly.",
        "formIntroColor": "Example form intro color",
        "formIntroColorLight": "Example form intro color light",
        "formIntroWeight": "normal",
        "formIntroSize": "normal",
        "formBand": "raised",
        "formAccentColor": "Example form accent color",
        "formAccentColorLight": "Example form accent color light",
        "formAlign": "center",
        "formWidth": "normal",
        "formLabelGap": "normal",
        "formBg": "transparent",
        "formBgCustom": "Example form bg custom",
        "formBgLight": "inherit",
        "formBgLightCustom": "Example form bg light custom",
        "formSubmitLabel": "Submit",
        "formSubmitVariant": "solid",
        "formSubmitSize": "normal",
        "formSubmitRadius": "slight",
        "formSubmitColor": "--fetchski-accent",
        "formSubmitColorLight": "Example form submit color light",
        "formSubmitTextColor": "--fetchski-ink",
        "formSubmitTextColorLight": "Example form submit text color light",
        "formSubmitHoverColor": "Example form submit hover color",
        "formSubmitHoverColorLight": "Example form submit hover color light",
        "formSubmitStyle": "sweep",
        "formSubmitShadowColor": "Example form submit shadow color",
        "formSubmitShadowColorLight": "Example form submit shadow color light",
        "formSubmitAnimation": "lift-scale",
        "formSubmitIcon": "Example form submit icon",
        "formSubmitIconFamily": "classic-regular",
        "formSubmitIconPosition": "before",
        "formSubmitIconNudge": false,
        "_form": [
          {}
        ],
        "sectionCss": {
          "slots": {
            "key": "Example value"
          },
          "css": "Example css",
          "mark": "Example mark"
        },
        "fields": {
          "metaType": "area",
          "_id": "clx8m2k4p0000a1b2c3d4e5f6",
          "items": [
            {}
          ]
        }
      }
    ]
  },
  "slug": "example-slug",
  "visibility": "public",
  "scheduledPublish": "Example scheduled publish",
  "scheduledUnpublish": "Example scheduled unpublish",
  "thankYouHeading": "Example thank you heading",
  "thankYouBody": {
    "metaType": "area",
    "_id": "clx8m2k4p0000a1b2c3d4e5f6",
    "items": [
      {
        "type": "@apostrophecms/rich-text",
        "_id": "clx8m2k4p0000a1b2c3d4e5f6",
        "metaType": "widget",
        "content": "<p>Hello from the API.</p>",
        "sectionCss": {
          "slots": {
            "key": "Example value"
          },
          "css": "Example css",
          "mark": "Example mark"
        }
      }
    ]
  },
  "sendConfirmationEmail": true,
  "emailConfirmationField": "jo@acme.example",
  "emails": [],
  "email": "jo@acme.example",
  "googleSheetSubmissions": true,
  "googleSpreadsheetId": "clx8m2k4p0000a1b2c3d4e5f6",
  "googleSheetName": "Example google sheet name",
  "submitLabel": "Example submit label",
  "enableRecaptcha": true,
  "enableQueryParams": true,
  "queryParamList": [],
  "formActions": [],
  "archived": false,
  "_id": "clx8m2k4p0000a1b2c3d4e5f6",
  "type": "Example type",
  "createdAt": "2026-10-24T09:30:00.000Z",
  "updatedAt": "2026-10-24T09:30:00.000Z",
  "aposShareKey": "k3v9x2m7q1z8w4p6"
}

use Fetchski\AttractCmsLaravel\Facades\Attract;

$form = Attract::forms()->localizeForm(id: 'clx8m2k4p0000a1b2c3d4e5f6', toLocale: 'en');

{
  "title": "Example title",
  "contents": {
    "metaType": "area",
    "_id": "clx8m2k4p0000a1b2c3d4e5f6",
    "items": [
      {
        "type": "form-section",
        "_id": "clx8m2k4p0000a1b2c3d4e5f6",
        "metaType": "widget",
        "formFontOverrides": [],
        "formEyebrowEnabled": true,
        "formEyebrow": "Get in touch",
        "formEyebrowColor": "Example form eyebrow color",
        "formEyebrowColorLight": "Example form eyebrow color light",
        "formEyebrowWeight": "bold",
        "formEyebrowSize": "normal",
        "formHeading": "Send us a message",
        "formHeadingColor": "Example form heading color",
        "formHeadingColorLight": "Example form heading color light",
        "formHeadingWeight": "extrabold",
        "formHeadingSize": "normal",
        "formIntro": "Fill out the form below and we’ll get back to you shortly.",
        "formIntroColor": "Example form intro color",
        "formIntroColorLight": "Example form intro color light",
        "formIntroWeight": "normal",
        "formIntroSize": "normal",
        "formBand": "raised",
        "formAccentColor": "Example form accent color",
        "formAccentColorLight": "Example form accent color light",
        "formAlign": "center",
        "formWidth": "normal",
        "formLabelGap": "normal",
        "formBg": "transparent",
        "formBgCustom": "Example form bg custom",
        "formBgLight": "inherit",
        "formBgLightCustom": "Example form bg light custom",
        "formSubmitLabel": "Submit",
        "formSubmitVariant": "solid",
        "formSubmitSize": "normal",
        "formSubmitRadius": "slight",
        "formSubmitColor": "--fetchski-accent",
        "formSubmitColorLight": "Example form submit color light",
        "formSubmitTextColor": "--fetchski-ink",
        "formSubmitTextColorLight": "Example form submit text color light",
        "formSubmitHoverColor": "Example form submit hover color",
        "formSubmitHoverColorLight": "Example form submit hover color light",
        "formSubmitStyle": "sweep",
        "formSubmitShadowColor": "Example form submit shadow color",
        "formSubmitShadowColorLight": "Example form submit shadow color light",
        "formSubmitAnimation": "lift-scale",
        "formSubmitIcon": "Example form submit icon",
        "formSubmitIconFamily": "classic-regular",
        "formSubmitIconPosition": "before",
        "formSubmitIconNudge": false,
        "_form": [
          {}
        ],
        "sectionCss": {
          "slots": {
            "key": "Example value"
          },
          "css": "Example css",
          "mark": "Example mark"
        },
        "fields": {
          "metaType": "area",
          "_id": "clx8m2k4p0000a1b2c3d4e5f6",
          "items": [
            {}
          ]
        }
      }
    ]
  },
  "slug": "example-slug",
  "visibility": "public",
  "scheduledPublish": "Example scheduled publish",
  "scheduledUnpublish": "Example scheduled unpublish",
  "thankYouHeading": "Example thank you heading",
  "thankYouBody": {
    "metaType": "area",
    "_id": "clx8m2k4p0000a1b2c3d4e5f6",
    "items": [
      {
        "type": "@apostrophecms/rich-text",
        "_id": "clx8m2k4p0000a1b2c3d4e5f6",
        "metaType": "widget",
        "content": "<p>Hello from the API.</p>",
        "sectionCss": {
          "slots": {
            "key": "Example value"
          },
          "css": "Example css",
          "mark": "Example mark"
        }
      }
    ]
  },
  "sendConfirmationEmail": true,
  "emailConfirmationField": "jo@acme.example",
  "emails": [],
  "email": "jo@acme.example",
  "googleSheetSubmissions": true,
  "googleSpreadsheetId": "clx8m2k4p0000a1b2c3d4e5f6",
  "googleSheetName": "Example google sheet name",
  "submitLabel": "Example submit label",
  "enableRecaptcha": true,
  "enableQueryParams": true,
  "queryParamList": [],
  "formActions": [],
  "archived": false,
  "_id": "clx8m2k4p0000a1b2c3d4e5f6",
  "type": "Example type",
  "createdAt": "2026-10-24T09:30:00.000Z",
  "updatedAt": "2026-10-24T09:30:00.000Z",
  "aposShareKey": "k3v9x2m7q1z8w4p6"
}

In your app

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

Add the controller

app/Http/Controllers/LocalizeFormController.php

<?php

declare(strict_types=1);

namespace App\Http\Controllers;

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

final class LocalizeFormController
{
    public function __invoke(string $id): Form
    {
        return Attract::forms()->localizeForm(id: $id, toLocale: 'en');
    }
}

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\LocalizeFormController;
use Illuminate\Support\Facades\Route;

Route::post('/form/{id}/localize', LocalizeFormController::class)->middleware('auth');

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

Call it

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

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

Terminal

php artisan make:attract-action forms.localizeForm

Call it from the terminal

Terminal

php artisan attract:call forms.localizeForm id=clx8m2k4p0000a1b2c3d4e5f6 toLocale=en

It calls localizeForm() 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. Answers that copy. 409 conflict when one exists and update is not true.

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

Terminal

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

string

required

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

string

required

Required. The locale to copy it into: a configured locale, not the current one.

Optional parameters

?bool

Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. Overwrite the copy if one already exists there (default false: 409 conflict instead).

Returns

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

string

Always sent. Its title: the name it goes by in every list, and the heading of its page where it has one.

string

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

Enums\Visibility|string

Always sent. Select whether this content is public or private. One of public, loginRequired; a newer site may send others, so keep a fallback.

string

Always sent. The “from” address on this form’s emails. A new form starts with the Email in Site settings → Brand; change it here for this form.

string

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

string

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

CarbonImmutable

Always sent. When it was created (ISO 8601). Format: an ISO 8601 date and time.

CarbonImmutable

Always sent. When it last changed (ISO 8601). Format: an ISO 8601 date and time.

?FormSectionArea

Sometimes sent: null when the site leaves it out. A FormSectionArea. Widgets, top to bottom: send { "items": [ … ] }, one object per widget with its type. Writing it replaces the whole area. A new document starts with form-section.

Show FormSectionArea (Fetchski\AttractCmsLaravel\Data\FormSectionArea)

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

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

A form-section widget: its type and its own fields. A field left out takes its default.

Enums\FormSectionWidgetType|string

Always sent. The widget’s type: always form-section. One of form-section; 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, FormSectionWidgetFormFontOverridesItem>|null

Sometimes sent: null when the site leaves it out. A list of FormSectionWidgetFormFontOverridesItem. Optional. Set part of this form in a different typeface. Leave empty to follow the site’s fonts (Site design → Typography). At most 4 items.

Show FormSectionWidgetFormFontOverridesItem (Fetchski\AttractCmsLaravel\Data\FormSectionWidgetFormFontOverridesItem)

?string

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

Enums\Target|string|null

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

Enums\Source|string|null

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

Enums\Slot|string|null

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

Enums\Curated|string|null

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

Enums\CdnProvider|string|null

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

?string

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

?string

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

Collection<int, FormSectionWidgetFormFontOverridesItemUploadsItem>|null

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

Show FormSectionWidgetFormFontOverridesItemUploadsItem (Fetchski\AttractCmsLaravel\Data\FormSectionWidgetFormFontOverridesItemUploadsItem)

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

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

array<string, mixed>

?bool

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

?string

Sometimes sent: null when the site leaves it out. Small label shown above the title.

?string

Sometimes sent: null when the site leaves it out. Optional. Overrides the eyebrow + its dash. Leave empty to use the secondary (mint) color.

?string

Sometimes sent: null when the site leaves it out. Optional light-theme override. Falls back to the dark-theme color, then the mint default.

Enums\FormEyebrowWeight|string|null

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

Enums\FormEyebrowSize|string|null

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

?string

Sometimes sent: null when the site leaves it out. Optional — leave empty to track the theme text color.

?string

Sometimes sent: null when the site leaves it out. Optional light-theme override. Falls back to the dark-theme color.

Enums\FormHeadingWeight|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\FormHeadingSize|string|null

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

?string

Sometimes sent: null when the site leaves it out. Optional short sentence under the heading.

?string

Sometimes sent: null when the site leaves it out. Optional — leave empty to use the muted text color.

?string

Sometimes sent: null when the site leaves it out. Optional light-theme override. Falls back to the dark-theme color.

Enums\FormIntroWeight|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\FormIntroSize|string|null

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

Enums\FormBand|string|null

Sometimes sent: null when the site leaves it out. Plain sits on the page; Raised is a contained card; Accent is a solid brand-color band. One of plain, raised, accent; a newer site may send others, so keep a fallback.

?string

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

?string

Sometimes sent: null when the site leaves it out. Optional light-theme override. Falls back to the dark-theme color, then the accent.

Enums\FormAlign|string|null

Sometimes sent: null when the site leaves it out. Alignment of the section header (the form fields stay left-aligned for legibility). One of center, left; a newer site may send others, so keep a fallback.

Enums\FormWidth|string|null

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

Enums\FormLabelGap|string|null

Sometimes sent: null when the site leaves it out. Vertical space between each field’s label and its input. One of compact, normal, roomy, spacious; a newer site may send others, so keep a fallback.

Enums\FormBg|string|null

Sometimes sent: null when the site leaves it out. The section’s full-width background band in dark mode. Transparent lets the page background show through. The palette options track the site colors; choose “Custom color…” for a specific color. One of transparent, surface, raised, sunken, hill, accent-soft, custom; a newer site may send others, so keep a fallback.

?string

Sometimes sent: null when the site leaves it out. Used when “Section background (dark theme)” is set to Custom color.

Enums\FormBgLight|string|null

Sometimes sent: null when the site leaves it out. “Match dark theme” reuses the dark-theme choice; otherwise set the light-mode band independently. One of inherit, transparent, surface, raised, sunken, hill, accent-soft, custom; a newer site may send others, so keep a fallback.

?string

Sometimes sent: null when the site leaves it out. Used when “Section background (light theme)” is set to Custom color.

?string

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

Enums\FormSubmitVariant|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\FormSubmitSize|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\FormSubmitRadius|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. Optional light-theme override. Falls back to the dark-theme color. (Brand tokens already flip per theme.)

?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. Optional light-theme override. Falls back to the dark-theme label color.

?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. Optional light-theme override. Falls back to the dark-theme hover color.

Enums\FormSubmitStyle|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. Optional light-theme override. Falls back to the dark-theme shadow color.

Enums\FormSubmitAnimation|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\FormSubmitIconFamily|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\FormSubmitIconPosition|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).

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

Sometimes sent: null when the site leaves it out. The Form record that stores this form’s submissions and routes them (its Actions / integrations / Google Sheet). Create one in the Forms manager. The fields themselves are built right here on the page. The related @apostrophecms/form 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.

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

?FormSectionFieldsArea

Sometimes sent: null when the site leaves it out. A FormSectionFieldsArea. Add and arrange the form’s fields here — edited live on the page. Widgets, top to bottom: send { "items": [ … ] }, one object per widget with its type. Writing it replaces the whole area.

Show FormSectionFieldsArea (Fetchski\AttractCmsLaravel\Data\FormSectionFieldsArea)

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.

Sometimes sent: null when the site leaves it out. A list of FormSectionFieldsAreaItem. 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).

Show FormSectionFieldsAreaItem (Fetchski\AttractCmsLaravel\Data\FormSectionFieldsAreaItem)

A widget in an area that takes @apostrophecms/form-text-field, @apostrophecms/form-textarea-field, @apostrophecms/form-file-field, @apostrophecms/form-boolean-field, @apostrophecms/form-select-field, @apostrophecms/form-radio-field, @apostrophecms/form-checkboxes-field, @apostrophecms/form-conditional, @apostrophecms/form-group, @apostrophecms/form-divider, @apostrophecms/rich-text: the one its type names.

Show FormTextFieldWidget (Fetchski\AttractCmsLaravel\Data\FormTextFieldWidget)

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

Enums\FormTextFieldWidgetType|string

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

string

Always sent. Field label.

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

?bool

Sometimes sent: null when the site leaves it out. Is this field required?

?string

Sometimes sent: null when the site leaves it out. No spaces or punctuation other than dashes. If left blank, the form will populate this with a simplified form of the label. Changing this field after a form is in use may cause problems with any integrations.

Enums\InputType|string|null

Sometimes sent: null when the site leaves it out. If you are requesting certain formatted information (e.g., email, url, phone number), select the relevant input type here. If not, use “Text”. One of text, email, tel, url, date, password; a newer site may send others, so keep a fallback.

?string

Sometimes sent: null when the site leaves it out. Text to display in the field before someone uses it (e.g., to provide additional directions).

array<string, mixed>

Show FormTextareaFieldWidget (Fetchski\AttractCmsLaravel\Data\FormTextareaFieldWidget)

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

Enums\FormTextareaFieldWidgetType|string

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

string

Always sent. Field label.

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

?bool

Sometimes sent: null when the site leaves it out. Is this field required?

?string

Sometimes sent: null when the site leaves it out. Text to display in the field before someone uses it (e.g., to provide additional directions).

array<string, mixed>

Show FormFileFieldWidget (Fetchski\AttractCmsLaravel\Data\FormFileFieldWidget)

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

Enums\FormFileFieldWidgetType|string

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

string

Always sent. Field label.

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

?bool

Sometimes sent: null when the site leaves it out. Is this field required?

?string

?bool

Sometimes sent: null when the site leaves it out. Allow multiple file attachments.

?bool

Sometimes sent: null when the site leaves it out. Limit file size?

?int

Sometimes sent: null when the site leaves it out. In Bytes.

array<string, mixed>

Show FormBooleanFieldWidget (Fetchski\AttractCmsLaravel\Data\FormBooleanFieldWidget)

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

Enums\FormBooleanFieldWidgetType|string

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

string

Always sent. Field label.

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

?bool

Sometimes sent: null when the site leaves it out. Is this field required?

?string

?bool

Sometimes sent: null when the site leaves it out. If “yes,” the checkbox will start in the checked state.

array<string, mixed>

Show FormSelectFieldWidget (Fetchski\AttractCmsLaravel\Data\FormSelectFieldWidget)

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

Enums\FormSelectFieldWidgetType|string

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

string

Always sent. Field label.

Collection<int, FormSelectFieldWidgetChoicesItem>

Always sent. A list of FormSelectFieldWidgetChoicesItem. Select input options.

Show FormSelectFieldWidgetChoicesItem (Fetchski\AttractCmsLaravel\Data\FormSelectFieldWidgetChoicesItem)

string

Always sent. The readable label displayed to users.

?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. The value saved (as text) in the database. If not entered, the label will be used.

array<string, mixed>

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

?bool

Sometimes sent: null when the site leaves it out. Is this field required?

?string

?bool

Sometimes sent: null when the site leaves it out. Allow multiple options to be selected.

?int

Sometimes sent: null when the site leaves it out. Number of options in the list that should be visible. At least 0.

array<string, mixed>

Show FormRadioFieldWidget (Fetchski\AttractCmsLaravel\Data\FormRadioFieldWidget)

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

Enums\FormRadioFieldWidgetType|string

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

string

Always sent. Field label.

Collection<int, FormRadioFieldWidgetChoicesItem>

Always sent. A list of FormRadioFieldWidgetChoicesItem. Radio input options. At least 1 items.

Show FormRadioFieldWidgetChoicesItem (Fetchski\AttractCmsLaravel\Data\FormRadioFieldWidgetChoicesItem)

string

Always sent. The readable label displayed to users.

?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. The value saved (as text) in the database. If not entered, the label will be used.

array<string, mixed>

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

?bool

Sometimes sent: null when the site leaves it out. Is this field required?

?string

?bool

Sometimes sent: null when the site leaves it out. Allow multiple options to be selected.

?int

Sometimes sent: null when the site leaves it out. Number of options in the list that should be visible. At least 0.

array<string, mixed>

Show FormCheckboxesFieldWidget (Fetchski\AttractCmsLaravel\Data\FormCheckboxesFieldWidget)

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

Enums\FormCheckboxesFieldWidgetType|string

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

string

Always sent. Field label.

Collection<int, FormCheckboxesFieldWidgetChoicesItem>

Always sent. A list of FormCheckboxesFieldWidgetChoicesItem. Checkbox input options. At least 1 items.

Show FormCheckboxesFieldWidgetChoicesItem (Fetchski\AttractCmsLaravel\Data\FormCheckboxesFieldWidgetChoicesItem)

string

Always sent. The readable label displayed to users.

?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. The value saved (as text) in the database. If not entered, the label will be used.

array<string, mixed>

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

?bool

Sometimes sent: null when the site leaves it out. Is this field required?

?string

array<string, mixed>

Show FormConditionalWidget (Fetchski\AttractCmsLaravel\Data\FormConditionalWidget)

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

Enums\FormConditionalWidgetType|string

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

string

Always sent. Form field to check.

string

Always sent. Value that activates this group.

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

?FormConditionalContentsArea

Sometimes sent: null when the site leaves it out. A FormConditionalContentsArea. aposForm:conditionalContentsHelp Widgets, top to bottom: send { "items": [ … ] }, one object per widget with its type. Writing it replaces the whole area.

Show FormConditionalContentsArea (Fetchski\AttractCmsLaravel\Data\FormConditionalContentsArea)

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.

Sometimes sent: null when the site leaves it out. A list of FormConditionalContentsAreaItem. 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). Its fields are listed under the first FormConditionalContentsAreaItem above.

array<string, mixed>

Show FormGroupWidget (Fetchski\AttractCmsLaravel\Data\FormGroupWidget)

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

Enums\FormGroupWidgetType|string

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

string

Always sent. Group Label.

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

?FormGroupContentsArea

Sometimes sent: null when the site leaves it out. A FormGroupContentsArea. aposForm:groupContentsHelp Widgets, top to bottom: send { "items": [ … ] }, one object per widget with its type. Writing it replaces the whole area.

Show FormGroupContentsArea (Fetchski\AttractCmsLaravel\Data\FormGroupContentsArea)

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.

Sometimes sent: null when the site leaves it out. A list of FormGroupContentsAreaItem. 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). Its fields are listed under the first FormGroupContentsAreaItem above.

array<string, mixed>

Show FormDividerWidget (Fetchski\AttractCmsLaravel\Data\FormDividerWidget)

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

Enums\FormDividerWidgetType|string

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

array<string, mixed>

Show RichTextWidget (Fetchski\AttractCmsLaravel\Data\RichTextWidget)

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

Enums\RichTextWidgetType|string

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

?string

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

Enums\MetaType|string|null

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

?string

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

?CustomCSS

array<string, mixed>

?string

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

?string

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

?string

Sometimes sent: null when the site leaves it out. Thank you message title.

?RichTextArea

Sometimes sent: null when the site leaves it out. A RichTextArea. Widgets, top to bottom: send { "items": [ … ] }, one object per widget with its type. Writing it replaces the whole area.

Show RichTextArea (Fetchski\AttractCmsLaravel\Data\RichTextArea)

Enums\AfterContentAreaMetaType|string|null

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

?string

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

Collection<int, RichTextWidget>|null

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

array<string, mixed>

?bool

Sometimes sent: null when the site leaves it out. Enable this to send a message to the person who submits this form.

?string

Sometimes sent: null when the site leaves it out. Enter the “name” value of the field where people with enter their email address. For best results, make sure this field only accepts email addresses.

Collection<int, FormEmailsItem>|null

Sometimes sent: null when the site leaves it out. A list of FormEmailsItem. Email Address(es) for Results.

Show FormEmailsItem (Fetchski\AttractCmsLaravel\Data\FormEmailsItem)

string

Always sent. Email Address for Results. Format: an email address.

?string

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

Collection<int, FormEmailsItemConditionsItem>|null

Sometimes sent: null when the site leaves it out. A list of FormEmailsItemConditionsItem. For example, if you only notify this email address if the “country” field is set to “Austria”. All conditions must be met. Add the email again with another conditional set if needed.

Show FormEmailsItemConditionsItem (Fetchski\AttractCmsLaravel\Data\FormEmailsItemConditionsItem)

?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. Only select (drop-down) and checkbox fields can be used for this condition.

?string

Sometimes sent: null when the site leaves it out. Enter the value an end-user will enter to meet this conditional.

array<string, mixed>

?bool

Sometimes sent: null when the site leaves it out. Submit to Google Spreadsheets.

?string

Sometimes sent: null when the site leaves it out. Google Spreadsheet ID.

?string

Sometimes sent: null when the site leaves it out. The name of the sheet tab in your Google spreadsheet where you want the submission appended. If not provided, the first sheet of the spreadsheet will be used.

?string

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

?bool

Sometimes sent: null when the site leaves it out. To use, reCAPTCHA a site ID and secret key must be configured in website code or the website global settings.

?bool

Sometimes sent: null when the site leaves it out. Enable query parameter capture.

Collection<int, FormQueryParamListItem>|null

Sometimes sent: null when the site leaves it out. A list of FormQueryParamListItem. Create an array item for each query parameter value you wish to capture.

Show FormQueryParamListItem (Fetchski\AttractCmsLaravel\Data\FormQueryParamListItem)

string

Always sent. Key.

?string

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

?int

Sometimes sent: null when the site leaves it out. Enter a whole number to limit the length of the value saved. At least 1.

array<string, mixed>

Collection<int, FormFormActionsItem>|null

Sometimes sent: null when the site leaves it out. A list of FormFormActionsItem. What happens to each submission, beyond being stored in the CMS. Add one row per destination; several can run for one form. Storage always happens regardless.

Show FormFormActionsItem (Fetchski\AttractCmsLaravel\Data\FormFormActionsItem)

Enums\ActionType|string

Always sent. Action. One of webhook, emailNotify; a newer site may send others, so keep a fallback.

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

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

Sometimes sent: null when the site leaves it out. Where each submission is sent (⌘K → Webhook Destinations). It is signed with that destination’s secret, retried if the receiver is down, and listed on its Deliveries tab. The related webhook-destination 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. Where a copy of each submission is emailed (sent through Connections → Email). Replying answers the visitor. When set, an email address; empty or null when not.

array<string, mixed>

?bool

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

Sometimes sent: null when the site leaves it out. The draft’s preview share key, while its share link is on: the link is the draft’s _url with aposShareKey and aposShareId (the draft’s _id) in its query. Absent otherwise, and on published documents.

Errors

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

400

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

401

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

403

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

404

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

409

A copy already exists in that locale: send update: true to overwrite it.Retried first: No. Read: siteMessage(), errorName(), data().

500

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

no answer

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

not sent

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

any other

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

setup

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

setup

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

Behavior

Access: an API key with content:forms:write (or a master above it: content:forms:all, content:all, admin:all). A signed-in person may call it as far as their own permissions allow; anyone else gets 403.
Rate limit: the key’s own writes-per-minute limit, set when the key is created (default 120); over it, 429 with Retry-After. The client waits and retries for you; you see RateLimited only if that runs out.
Retries: a write is sent again only after a 429 (refused before it acted) or when it never reached the site. After a timeout or a 5xx it may have landed: check before you send it again.
Timeout: 15 s per attempt by default; raise timeout in config/fetchski-attract.php for longer.

Test it

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

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

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

        $this->actingAs(User::factory()->create())
            ->postJson('/form/clx8m2k4p0000a1b2c3d4e5f6/localize')
            ->assertOk();

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

Terminal

php artisan test

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

tests/Feature/LocalizeFormAnswerTest.php

<?php

declare(strict_types=1);

namespace Tests\Feature;

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

final class LocalizeFormAnswerTest extends TestCase
{
    public function test_localize_form_answers_your_values(): void
    {
        Attract::fake([
            'forms.localizeForm' => Form::factory()->make(['title' => 'Your value']),
        ]);

        $form = Attract::forms()->localizeForm(id: 'clx8m2k4p0000a1b2c3d4e5f6', toLocale: 'en');

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

List a form’s locales

Attract::forms()->getFormLocales()

List forms

Attract::forms()->listForms()

Create a form

Attract::forms()->createForm()

Get a form

Attract::forms()->getForm()

Replace a form

Attract::forms()->replaceForm()

Delete a form

Attract::forms()->deleteForm()

POST /@apostrophecms/form/{_id}/localize

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

use Fetchski\AttractCmsLaravel\Facades\Attract;

$form = Attract::forms()->localizeForm(id: 'clx8m2k4p0000a1b2c3d4e5f6', toLocale: 'en');

{
  "title": "Example title",
  "contents": {
    "metaType": "area",
    "_id": "clx8m2k4p0000a1b2c3d4e5f6",
    "items": [
      {
        "type": "form-section",
        "_id": "clx8m2k4p0000a1b2c3d4e5f6",
        "metaType": "widget",
        "formFontOverrides": [],
        "formEyebrowEnabled": true,
        "formEyebrow": "Get in touch",
        "formEyebrowColor": "Example form eyebrow color",
        "formEyebrowColorLight": "Example form eyebrow color light",
        "formEyebrowWeight": "bold",
        "formEyebrowSize": "normal",
        "formHeading": "Send us a message",
        "formHeadingColor": "Example form heading color",
        "formHeadingColorLight": "Example form heading color light",
        "formHeadingWeight": "extrabold",
        "formHeadingSize": "normal",
        "formIntro": "Fill out the form below and we’ll get back to you shortly.",
        "formIntroColor": "Example form intro color",
        "formIntroColorLight": "Example form intro color light",
        "formIntroWeight": "normal",
        "formIntroSize": "normal",
        "formBand": "raised",
        "formAccentColor": "Example form accent color",
        "formAccentColorLight": "Example form accent color light",
        "formAlign": "center",
        "formWidth": "normal",
        "formLabelGap": "normal",
        "formBg": "transparent",
        "formBgCustom": "Example form bg custom",
        "formBgLight": "inherit",
        "formBgLightCustom": "Example form bg light custom",
        "formSubmitLabel": "Submit",
        "formSubmitVariant": "solid",
        "formSubmitSize": "normal",
        "formSubmitRadius": "slight",
        "formSubmitColor": "--fetchski-accent",
        "formSubmitColorLight": "Example form submit color light",
        "formSubmitTextColor": "--fetchski-ink",
        "formSubmitTextColorLight": "Example form submit text color light",
        "formSubmitHoverColor": "Example form submit hover color",
        "formSubmitHoverColorLight": "Example form submit hover color light",
        "formSubmitStyle": "sweep",
        "formSubmitShadowColor": "Example form submit shadow color",
        "formSubmitShadowColorLight": "Example form submit shadow color light",
        "formSubmitAnimation": "lift-scale",
        "formSubmitIcon": "Example form submit icon",
        "formSubmitIconFamily": "classic-regular",
        "formSubmitIconPosition": "before",
        "formSubmitIconNudge": false,
        "_form": [
          {}
        ],
        "sectionCss": {
          "slots": {
            "key": "Example value"
          },
          "css": "Example css",
          "mark": "Example mark"
        },
        "fields": {
          "metaType": "area",
          "_id": "clx8m2k4p0000a1b2c3d4e5f6",
          "items": [
            {}
          ]
        }
      }
    ]
  },
  "slug": "example-slug",
  "visibility": "public",
  "scheduledPublish": "Example scheduled publish",
  "scheduledUnpublish": "Example scheduled unpublish",
  "thankYouHeading": "Example thank you heading",
  "thankYouBody": {
    "metaType": "area",
    "_id": "clx8m2k4p0000a1b2c3d4e5f6",
    "items": [
      {
        "type": "@apostrophecms/rich-text",
        "_id": "clx8m2k4p0000a1b2c3d4e5f6",
        "metaType": "widget",
        "content": "<p>Hello from the API.</p>",
        "sectionCss": {
          "slots": {
            "key": "Example value"
          },
          "css": "Example css",
          "mark": "Example mark"
        }
      }
    ]
  },
  "sendConfirmationEmail": true,
  "emailConfirmationField": "jo@acme.example",
  "emails": [],
  "email": "jo@acme.example",
  "googleSheetSubmissions": true,
  "googleSpreadsheetId": "clx8m2k4p0000a1b2c3d4e5f6",
  "googleSheetName": "Example google sheet name",
  "submitLabel": "Example submit label",
  "enableRecaptcha": true,
  "enableQueryParams": true,
  "queryParamList": [],
  "formActions": [],
  "archived": false,
  "_id": "clx8m2k4p0000a1b2c3d4e5f6",
  "type": "Example type",
  "createdAt": "2026-10-24T09:30:00.000Z",
  "updatedAt": "2026-10-24T09:30:00.000Z",
  "aposShareKey": "k3v9x2m7q1z8w4p6"
}

Get started

Using the SDK

Going further

Pages & Site

Content

Media

Forms

Ads & Conversions

Analytics

In your app

Call it from the terminal

Find the id

Behavior

Test it

List a form’s locales

List forms

Create a form

Get a form

Replace a form

Delete a form

POST /@apostrophecms/form/{_id}/localize

In your app

Call it from the terminal

Find the id

Behavior

Test it

Related

List a form’s locales

List forms

Create a form

Get a form

Replace a form

Delete a form

POST /@apostrophecms/form/{_id}/localize