Replace a language list

use Fetchski\AttractCmsLaravel\Facades\Attract;

$siteLanguages = Attract::languages()->replaceSiteLanguages(id: 'clx8m2k4p0000a1b2c3d4e5f6');

{
  "mainLanguageName": "English",
  "languages": [],
  "_id": "clx8m2k4p0000a1b2c3d4e5f6",
  "type": "Example type",
  "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 replaceSiteLanguages() and returns the answer.

Add the controller

app/Http/Controllers/ReplaceSiteLanguagesController.php

<?php

declare(strict_types=1);

namespace App\Http\Controllers;

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

final class ReplaceSiteLanguagesController
{
    public function __invoke(string $id): SiteLanguages
    {
        return Attract::languages()->replaceSiteLanguages(id: $id);
    }
}

Add the route

routes/web.php

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

Route::put('/site-languages/{id}', ReplaceSiteLanguagesController::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 /site-languages/clx8m2k4p0000a1b2c3d4e5f6 (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/ReplaceSiteLanguages.php (an invokable Action that calls replaceSiteLanguages()) and its test under tests/Feature/Actions/Attract/ (Pest when your app has it):

Terminal

php artisan make:attract-action languages.replaceSiteLanguages

Call it from the terminal

Terminal

php artisan attract:call languages.replaceSiteLanguages id=clx8m2k4p0000a1b2c3d4e5f6

It calls replaceSiteLanguages() 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. Live at once, with the same checks as the Languages screen.

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::languages()->listSiteLanguagesPick(fields: ['id'])->first(); // ['id' => …], or null

Terminal

php artisan attract:call languages.listSiteLanguagesPick fields=id

Pass $row['id'] as id. See Find an id.

Required parameters

Named arguments, e.g. replaceSiteLanguages(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).

Optional parameters

?string

Optional. Leave it out and the site uses "English". The language the site is written in first, named as its speakers write it. Its pages keep their addresses as they are (/about).

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

Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. Each language gets its own addresses (/fr/about) and its own copy of every page, translated with Localize. A language you remove keeps its translations: add the same code again and they come back.

Show SiteLanguagesLanguagesItem (Fetchski\AttractCmsLaravel\Data\SiteLanguagesLanguagesItem)

string

required

Required. As its speakers write it, for example “Français”. Shown in the language switcher.

string

required

Required. A lowercase language code, for example “fr”; add a region (“pt-br”, “es-419”), a script (“zh-hant”) or both (“zh-hant-tw”). It starts every address in this language (/fr/…) and can’t be “en”.

?string

The row’s id, unique in its array.

?bool

No: only people signed in to the CMS see this language, so it can be translated first. Yes: visitors see it and the language switcher lists it.

array<string, mixed>

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

Returns

A SiteLanguages (Fetchski\AttractCmsLaravel\Data\SiteLanguages). SiteLanguages content type. Read its properties ($siteLanguages->id): each says whether the site always sends it. The example answer is the site’s wire JSON: one key differs from the property names (_id → id).

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.

?string

Sometimes sent: null when the site leaves it out. The language the site is written in first, named as its speakers write it. Its pages keep their addresses as they are (/about).

Collection<int, SiteLanguagesLanguagesItem>|null

Sometimes sent: null when the site leaves it out. A list of SiteLanguagesLanguagesItem. Each language gets its own addresses (/fr/about) and its own copy of every page, translated with Localize. A language you remove keeps its translations: add the same code again and they come back.

Show SiteLanguagesLanguagesItem (Fetchski\AttractCmsLaravel\Data\SiteLanguagesLanguagesItem)

string

Always sent. As its speakers write it, for example “Français”. Shown in the language switcher.

string

Always sent. A lowercase language code, for example “fr”; add a region (“pt-br”, “es-419”), a script (“zh-hant”) or both (“zh-hant-tw”). It starts every address in this language (/fr/…) and can’t be “en”.

?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. No: only people signed in to the CMS see this language, so it can be translated first. Yes: visitors see it and the language switcher lists it.

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.

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 languages:write (or a master above it: languages: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/ReplaceSiteLanguagesTest.php, then run your tests:

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

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

        $this->actingAs(User::factory()->create())
            ->putJson('/site-languages/clx8m2k4p0000a1b2c3d4e5f6')
            ->assertOk();

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

Terminal

php artisan test

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

tests/Feature/ReplaceSiteLanguagesAnswerTest.php

<?php

declare(strict_types=1);

namespace Tests\Feature;

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

final class ReplaceSiteLanguagesAnswerTest extends TestCase
{
    public function test_replace_site_languages_answers_your_values(): void
    {
        Attract::fake([
            'languages.replaceSiteLanguages' => SiteLanguages::factory()->make(['id' => 'Your value']),
        ]);

        $siteLanguages = Attract::languages()->replaceSiteLanguages(id: 'clx8m2k4p0000a1b2c3d4e5f6');

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

List the Global fields each language translates

Attract::languages()->getGlobalTranslatedFields()

List language lists

Attract::languages()->listSiteLanguages()

Get a language list

Attract::languages()->getSiteLanguages()

Update a language list

Attract::languages()->updateSiteLanguages()

PUT /site-languages/{_id}

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

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 the Global fields each language translates

List language lists

Get a language list

Update a language list

PUT /site-languages/{_id}

In your app

Call it from the terminal

Find the id

Behavior

Test it

Related

List the Global fields each language translates

List language lists

Get a language list

Update a language list

PUT /site-languages/{_id}