Replace a photo album

use Fetchski\AttractCmsLaravel\Facades\Attract;

$photoAlbum = Attract::photoAlbums()->replacePhotoAlbum(id: 'clx8m2k4p0000a1b2c3d4e5f6', title: 'Example title');

{
  "title": "Example title",
  "description": "Example description",
  "_photos": [
    {}
  ],
  "slug": "example-slug",
  "visibility": "public",
  "scheduledPublish": "Example scheduled publish",
  "scheduledUnpublish": "Example scheduled unpublish",
  "albumOrganizeFolder": true,
  "_albumFolder": [
    {}
  ],
  "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;

$photoAlbum = Attract::photoAlbums()->replacePhotoAlbum(id: 'clx8m2k4p0000a1b2c3d4e5f6', title: 'Example title');

{
  "title": "Example title",
  "description": "Example description",
  "_photos": [
    {}
  ],
  "slug": "example-slug",
  "visibility": "public",
  "scheduledPublish": "Example scheduled publish",
  "scheduledUnpublish": "Example scheduled unpublish",
  "albumOrganizeFolder": true,
  "_albumFolder": [
    {}
  ],
  "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 replacePhotoAlbum() and returns the answer.

Add the controller

app/Http/Controllers/ReplacePhotoAlbumController.php

<?php

declare(strict_types=1);

namespace App\Http\Controllers;

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

final class ReplacePhotoAlbumController
{
    public function __invoke(string $id): PhotoAlbum
    {
        return Attract::photoAlbums()->replacePhotoAlbum(id: $id, title: 'Example title');
    }
}

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

Route::put('/photo-album/{id}', ReplacePhotoAlbumController::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 /photo-album/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/ReplacePhotoAlbum.php (an invokable Action that calls replacePhotoAlbum()) and its test under tests/Feature/Actions/Attract/ (Pest when your app has it):

Terminal

php artisan make:attract-action photoAlbums.replacePhotoAlbum

Call it from the terminal

Terminal

php artisan attract:call photoAlbums.replacePhotoAlbum \
  id=clx8m2k4p0000a1b2c3d4e5f6 \
  'title=Example title'

It calls replacePhotoAlbum() 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. Update an existing photo album.

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

Terminal

php artisan attract:call photoAlbums.listPhotoAlbumsPick 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. replacePhotoAlbum(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. Its title: the name it goes by in every list, and the heading of its page where it has one.

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 and the site uses "". Optional. A short intro shown with the album on a gallery page.

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

Optional. Pick the photos in this album — drag to reorder. Each photo’s alt text and focal point come from the media library. The related @apostrophecms/image documents, in order (empty when none). To set it, send a list of { "_id": "…" }, one per document; a document the site can’t find is left out.

?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). Left out, it’s made from the title.

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.

?string

Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. An ISO 8601 date and time, e.g. 2026-10-21T14:30:00.000Z.

?string

Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. An ISO 8601 date and time, e.g. 2026-10-21T14:30:00.000Z.

?bool

Optional. Leave it out and the site uses true. When on, this album has a media-library folder, and photos added here that aren’t already filed in a folder are moved into it on publish. Photos you’ve already filed elsewhere stay where they are; removing a photo from the album doesn’t move it back.

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

Optional. The folder this album files its photos into. Leave empty to get a dedicated folder under “Albums” automatically, or choose any existing folder. Changing it later only affects photos filed from then on — nothing is moved retroactively. The related image-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. In the archive: kept, but out of every list and off the site until it is restored. false (or null) for a live document.

Returns

A PhotoAlbum (Fetchski\AttractCmsLaravel\Data\PhotoAlbum). PhotoAlbum content type. Read its properties ($photoAlbum->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, _photos → photos, _albumFolder → albumFolder).

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

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.

?string

Sometimes sent: null when the site leaves it out. Optional. A short intro shown with the album on a gallery page.

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

Sometimes sent: null when the site leaves it out. Pick the photos in this album — drag to reorder. Each photo’s alt text and focal point come from the media library. The related @apostrophecms/image documents, in order (empty when none). To set it, send a list of { "_id": "…" }, one per document; a document the site can’t find is left out.

Enums\Visibility|string|null

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

?string

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

?string

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

?bool

Sometimes sent: null when the site leaves it out. When on, this album has a media-library folder, and photos added here that aren’t already filed in a folder are moved into it on publish. Photos you’ve already filed elsewhere stay where they are; removing a photo from the album doesn’t move it back.

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

Sometimes sent: null when the site leaves it out. The folder this album files its photos into. Leave empty to get a dedicated folder under “Albums” automatically, or choose any existing folder. Changing it later only affects photos filed from then on — nothing is moved retroactively. The related image-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. In the archive: kept, but out of every list and off the site until it is restored. false (or null) for a live document.

?CarbonImmutable

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

?CarbonImmutable

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

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

Errors

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

400

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

401

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

403

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

404

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

500

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

no answer

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

not sent

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

any other

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

setup

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

setup

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

Behavior

Access: an API key with content:photo-albums:write (or a master above it: content:photo-albums:all, content:all, admin:all). In published mode (the default) it goes live too, so the key also needs content:photo-albums:publish (or a master above it); send aposMode=draft (or a draft _id and no aposMode) to change only the draft. 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/ReplacePhotoAlbumTest.php, then run your tests:

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

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

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

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

Terminal

php artisan test

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

tests/Feature/ReplacePhotoAlbumAnswerTest.php

<?php

declare(strict_types=1);

namespace Tests\Feature;

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

final class ReplacePhotoAlbumAnswerTest extends TestCase
{
    public function test_replace_photo_album_answers_your_values(): void
    {
        Attract::fake([
            'photoAlbums.replacePhotoAlbum' => PhotoAlbum::factory()->make(['title' => 'Your value']),
        ]);

        $photoAlbum = Attract::photoAlbums()->replacePhotoAlbum(id: 'clx8m2k4p0000a1b2c3d4e5f6', title: 'Example title');

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

List a photo album’s locales

Attract::photoAlbums()->getPhotoAlbumLocales()

List photo albums

Attract::photoAlbums()->listPhotoAlbums()

Create a photo album

Attract::photoAlbums()->createPhotoAlbum()

Get a photo album

Attract::photoAlbums()->getPhotoAlbum()

Delete a photo album

Attract::photoAlbums()->deletePhotoAlbum()

Update a photo album

Attract::photoAlbums()->updatePhotoAlbum()

PUT /photo-album/{_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;

$photoAlbum = Attract::photoAlbums()->replacePhotoAlbum(id: 'clx8m2k4p0000a1b2c3d4e5f6', title: 'Example title');

{
  "title": "Example title",
  "description": "Example description",
  "_photos": [
    {}
  ],
  "slug": "example-slug",
  "visibility": "public",
  "scheduledPublish": "Example scheduled publish",
  "scheduledUnpublish": "Example scheduled unpublish",
  "albumOrganizeFolder": true,
  "_albumFolder": [
    {}
  ],
  "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 photo album’s locales

List photo albums

Create a photo album

Get a photo album

Delete a photo album

Update a photo album

PUT /photo-album/{_id}

In your app

Call it from the terminal

Find the id

Behavior

Test it

Related

List a photo album’s locales

List photo albums

Create a photo album

Get a photo album

Delete a photo album

Update a photo album

PUT /photo-album/{_id}