Update a file folder

use Fetchski\AttractCmsLaravel\Facades\Attract;

$fileFolder = Attract::fileFolders()->updateFileFolder(id: 'clx8m2k4p0000a1b2c3d4e5f6');

{
  "title": "Example title",
  "_parent": [
    {}
  ],
  "referenceOnly": false,
  "slug": "example-slug",
  "visibility": "public",
  "archived": false,
  "folderPath": "Example folder path",
  "folderParentId": "clx8m2k4p0000a1b2c3d4e5f6",
  "slugSegment": "Example slug segment",
  "level": 0,
  "_id": "clx8m2k4p0000a1b2c3d4e5f6",
  "type": "Example type",
  "createdAt": "2026-10-24T09:30:00.000Z",
  "updatedAt": "2026-10-24T09:30:00.000Z"
}

use Fetchski\AttractCmsLaravel\Facades\Attract;

$fileFolder = Attract::fileFolders()->updateFileFolder(id: 'clx8m2k4p0000a1b2c3d4e5f6');

{
  "title": "Example title",
  "_parent": [
    {}
  ],
  "referenceOnly": false,
  "slug": "example-slug",
  "visibility": "public",
  "archived": false,
  "folderPath": "Example folder path",
  "folderParentId": "clx8m2k4p0000a1b2c3d4e5f6",
  "slugSegment": "Example slug segment",
  "level": 0,
  "_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 updateFileFolder() and returns the answer.

Add the controller

app/Http/Controllers/UpdateFileFolderController.php

<?php

declare(strict_types=1);

namespace App\Http\Controllers;

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

final class UpdateFileFolderController
{
    public function __invoke(string $id): FileFolder
    {
        return Attract::fileFolders()->updateFileFolder(id: $id);
    }
}

Add the route

routes/web.php

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

Route::patch('/file-folder/{id}', UpdateFileFolderController::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 PATCH /file-folder/clx8m2k4p0000a1b2c3d4e5f6 (a form adds @csrf, as every web route checks it, and @method('PATCH')), 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/UpdateFileFolder.php (an invokable Action that calls updateFileFolder()) and its test under tests/Feature/Actions/Attract/ (Pest when your app has it):

Terminal

php artisan make:attract-action fileFolders.updateFileFolder

Call it from the terminal

Terminal

php artisan attract:call fileFolders.updateFileFolder id=clx8m2k4p0000a1b2c3d4e5f6

It calls updateFileFolder() 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.

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

Terminal

php artisan attract:call fileFolders.listFileFoldersPick fields=title,slug

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

Required parameters

Named arguments, e.g. updateFileFolder(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 "". Its title: the name it goes by in every list, and the heading of its page where it has one.

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

Optional. The related file-folder documents, in order (empty when none). To set it, send a list of { "_id": "…" }, one per document (one at most); a document the site can’t find is left out. At most 1 items.

?bool

Optional. Leave it out and the site uses false. Media in this folder (and every folder inside it) are kept for comparison only: you can browse them here, but they can never be used on the site.

?string

Optional. Leave it out and the site uses "". The URL name: lowercase words joined by hyphens (letters outside a–z, even emoji, are kept).

Enums\Visibility|string|null

Optional. Leave it out and the site uses "public". Select whether this content is public or private. One of public, loginRequired.

?bool

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

?string

Optional. Leave it out and the site uses "". Its place in the tree: each folder’s URL name from the top, joined by / (albums/summer). Set by the site from _parent and title; a value sent is ignored.

?string

Optional. Leave it out and the site uses "". The parent folder’s id, empty at the top. Set by the site from _parent; a value sent is ignored.

?string

Optional. Leave it out and the site uses "". Its own part of folderPath, made from its title. Set by the site; a value sent is ignored.

?int

Optional. Leave it out and the site uses 0. How deep it sits: 0 at the top. Set by the site from _parent; a value sent is ignored.

Returns

A FileFolder (Fetchski\AttractCmsLaravel\Data\FileFolder). FileFolder content type. Read its properties ($fileFolder->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, _parent → parent).

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

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

Sometimes sent: null when the site leaves it out. The related file-folder documents, in order (empty when none). To set it, send a list of { "_id": "…" }, one per document (one at most); a document the site can’t find is left out. At most 1 items.

?bool

Sometimes sent: null when the site leaves it out. Media in this folder (and every folder inside it) are kept for comparison only: you can browse them here, but they can never be used on the site.

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

?string

Sometimes sent: null when the site leaves it out. Its place in the tree: each folder’s URL name from the top, joined by / (albums/summer). Set by the site from _parent and title; a value sent is ignored.

?string

Sometimes sent: null when the site leaves it out. The parent folder’s id, empty at the top. Set by the site from _parent; a value sent is ignored.

?string

Sometimes sent: null when the site leaves it out. Its own part of folderPath, made from its title. Set by the site; a value sent is ignored.

?int

Sometimes sent: null when the site leaves it out. How deep it sits: 0 at the top. Set by the site from _parent; a value sent is ignored.

Errors

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

400

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

401

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

403

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

404

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

500

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

no answer

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

not sent

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

any other

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

setup

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

setup

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

Behavior

Access: an API key with content:files:write (or a master above it: content:files: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/UpdateFileFolderTest.php, then run your tests:

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

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

        $this->actingAs(User::factory()->create())
            ->patchJson('/file-folder/clx8m2k4p0000a1b2c3d4e5f6')
            ->assertOk();

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

Terminal

php artisan test

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

tests/Feature/UpdateFileFolderAnswerTest.php

<?php

declare(strict_types=1);

namespace Tests\Feature;

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

final class UpdateFileFolderAnswerTest extends TestCase
{
    public function test_update_file_folder_answers_your_values(): void
    {
        Attract::fake([
            'fileFolders.updateFileFolder' => FileFolder::factory()->make(['title' => 'Your value']),
        ]);

        $fileFolder = Attract::fileFolders()->updateFileFolder(id: 'clx8m2k4p0000a1b2c3d4e5f6');

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

Get the file folder tree

Attract::fileFolders()->getFileFolderTree()

List file folders

Attract::fileFolders()->listFileFolders()

Create a file folder

Attract::fileFolders()->createFileFolder()

Get a file folder

Attract::fileFolders()->getFileFolder()

Replace a file folder

Attract::fileFolders()->replaceFileFolder()

Delete a file folder

Attract::fileFolders()->deleteFileFolder()

PATCH /file-folder/{_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;

$fileFolder = Attract::fileFolders()->updateFileFolder(id: 'clx8m2k4p0000a1b2c3d4e5f6');

{
  "title": "Example title",
  "_parent": [
    {}
  ],
  "referenceOnly": false,
  "slug": "example-slug",
  "visibility": "public",
  "archived": false,
  "folderPath": "Example folder path",
  "folderParentId": "clx8m2k4p0000a1b2c3d4e5f6",
  "slugSegment": "Example slug segment",
  "level": 0,
  "_id": "clx8m2k4p0000a1b2c3d4e5f6",
  "type": "Example type",
  "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

Get the file folder tree

List file folders

Create a file folder

Get a file folder

Replace a file folder

Delete a file folder

PATCH /file-folder/{_id}

In your app

Call it from the terminal

Find the id

Behavior

Test it

Related

Get the file folder tree

List file folders

Create a file folder

Get a file folder

Replace a file folder

Delete a file folder

PATCH /file-folder/{_id}