Replace a photo feed

use Fetchski\AttractCmsLaravel\Facades\Attract;

$photoFeed = Attract::photoFeeds()->replacePhotoFeed(id: 'clx8m2k4p0000a1b2c3d4e5f6', title: 'Example title', visibility: 'public');

{
  "title": "Example title",
  "feedConnectionId": "clx8m2k4p0000a1b2c3d4e5f6",
  "feedPrefix": "Example feed prefix",
  "feedLayout": "ymd",
  "slug": "example-slug",
  "visibility": "public",
  "feedDateRule": "recentDays",
  "feedRecentDays": 5,
  "feedYears": 2,
  "feedRangeStart": "2026-10-24",
  "feedRangeEnd": "2026-10-24",
  "feedDistribution": "total",
  "feedTargetCount": 30,
  "feedPerDayCount": 10,
  "feedAvoidRepeats": true,
  "feedSeenLimit": 2000,
  "feedFormat": "webp",
  "feedMaxDimension": 2000,
  "feedQuality": 82,
  "feedAspect": "original",
  "feedAltText": "Example feed alt text",
  "feedEnabled": false,
  "feedInterval": "6",
  "feedRetainMinutes": 30,
  "feedLastRunAt": "2026-10-24T09:30:00.000Z",
  "feedLastStatus": "Example feed last status",
  "feedPhotoCount": 1,
  "feedLastError": "Example feed last error",
  "archived": false,
  "_id": "clx8m2k4p0000a1b2c3d4e5f6",
  "type": "Example type",
  "createdAt": "2026-10-24T09:30:00.000Z",
  "updatedAt": "2026-10-24T09:30:00.000Z"
}

use Fetchski\AttractCmsLaravel\Facades\Attract;

$photoFeed = Attract::photoFeeds()->replacePhotoFeed(id: 'clx8m2k4p0000a1b2c3d4e5f6', title: 'Example title', visibility: 'public');

{
  "title": "Example title",
  "feedConnectionId": "clx8m2k4p0000a1b2c3d4e5f6",
  "feedPrefix": "Example feed prefix",
  "feedLayout": "ymd",
  "slug": "example-slug",
  "visibility": "public",
  "feedDateRule": "recentDays",
  "feedRecentDays": 5,
  "feedYears": 2,
  "feedRangeStart": "2026-10-24",
  "feedRangeEnd": "2026-10-24",
  "feedDistribution": "total",
  "feedTargetCount": 30,
  "feedPerDayCount": 10,
  "feedAvoidRepeats": true,
  "feedSeenLimit": 2000,
  "feedFormat": "webp",
  "feedMaxDimension": 2000,
  "feedQuality": 82,
  "feedAspect": "original",
  "feedAltText": "Example feed alt text",
  "feedEnabled": false,
  "feedInterval": "6",
  "feedRetainMinutes": 30,
  "feedLastRunAt": "2026-10-24T09:30:00.000Z",
  "feedLastStatus": "Example feed last status",
  "feedPhotoCount": 1,
  "feedLastError": "Example feed last error",
  "archived": false,
  "_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 replacePhotoFeed() and returns the answer.

Add the controller

app/Http/Controllers/ReplacePhotoFeedController.php

<?php

declare(strict_types=1);

namespace App\Http\Controllers;

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

final class ReplacePhotoFeedController
{
    public function __invoke(string $id): PhotoFeed
    {
        return Attract::photoFeeds()->replacePhotoFeed(id: $id, title: 'Example title', visibility: 'public');
    }
}

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

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

Terminal

php artisan make:attract-action photoFeeds.replacePhotoFeed

Call it from the terminal

Terminal

php artisan attract:call photoFeeds.replacePhotoFeed \
  id=clx8m2k4p0000a1b2c3d4e5f6 \
  'title=Example title' \
  visibility=public

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

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

Terminal

php artisan attract:call photoFeeds.listPhotoFeedsPick fields=title,slug

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

Required parameters

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

Enums\Visibility|string

required

Required. Select whether this content is public or private. One of public, loginRequired.

Optional parameters

?string

Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. Which external photo store to draw from. Connections (bucket, region, keys) are set up once in Connections → Photo storage.

?string

Optional. Leave it out and the site uses "". Optional. The folder inside the bucket the dated folders live under — leave empty when they sit at the top level (e.g. “2026/May/31/…”).

Enums\FeedLayout|string|null

Optional. Leave it out and the site uses "ymd". How deep the dated folders go. The month and day folder NAMES don’t matter — “May”, “05” and “5” are all understood — only the depth. One of ymd, ym, y, flat.

?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\FeedDateRule|string|null

Optional. Leave it out and the site uses "recentDays". Which dates this feed is allowed to pull from. Only the folders inside this window are ever listed, so a huge library stays cheap to sample. One of recentDays, thisYear, lastYears, range, all.

?int

Optional. Leave it out and the site uses 5. Counting today. 5 means today and the four days before it. 1 to 365.

?int

Optional. Leave it out and the site uses 2. Counting this one. 2 means this calendar year and last. 1 to 25.

\DateTimeInterface|string|null

Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. From. Format: an ISO 8601 date (YYYY-MM-DD).

\DateTimeInterface|string|null

Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. To. Format: an ISO 8601 date (YYYY-MM-DD).

Enums\FeedDistribution|string|null

Optional. Leave it out and the site uses "total". Spread samples one target count across as many different days as possible (best for a wide window). Every day takes the same number from each day in the window (best for a daily-update wall). One of total, perDay.

?int

Optional. Leave it out and the site uses 30. How many photos this feed shows. Each refresh replaces the whole set. 1 to 500.

?int

Optional. Leave it out and the site uses 10. Taken from every day in the window — 10 from each of the last 5 days is 50 photos. 1 to 200.

?bool

Optional. Leave it out and the site uses true. Remember which photos were used and prefer ones that haven’t been shown lately, so a big library keeps producing new sets. When a date window runs out of unseen photos it reuses the oldest ones rather than showing fewer.

?int

Optional. Leave it out and the site uses 2000. The size of that memory. Bigger means longer before a photo can repeat; 0 turns the memory off. 0 to 20000.

Enums\FeedFormat|string|null

Optional. Leave it out and the site uses "webp". Every photo is re-encoded on the way in — which also strips camera metadata (location, device) from what the site serves. One of webp, jpeg.

?int

Optional. Leave it out and the site uses 2000. Photos larger than this are scaled down. 2000 is plenty for a full-screen lightbox; the gallery tiles use much smaller generated sizes. 320 to 6000.

?int

Optional. Leave it out and the site uses 82. Encoder quality, 40–100. 82 is a good balance; above 90 grows files fast with little visible gain.

Enums\FeedAspect|string|null

Optional. Leave it out and the site uses "original". Keep each photo’s own proportions (best for the Mosaic and Masonry layouts), or crop everything to one shape for a perfectly uniform wall. Crops are centered on the busiest part of the photo. One of original, 1:1, 4:3, 3:2, 16:9, 4:5.

?string

Optional. Leave it out and the site uses "". Optional. Describes what these photos generally show, for screen readers and the lightbox caption. Applied to each photo as it is imported — leave empty to import them without alt text.

?bool

Optional. Leave it out and the site uses false. Master switch. When off, the feed keeps showing its current photos and only refreshes when you run it by hand.

Enums\FeedInterval|string|null

Optional. Leave it out and the site uses "6". How often to fetch a fresh set. Change it anytime — no restart. One of 1, 2, 3, 4, 6, 12, 24, 48.

?int

Optional. Leave it out and the site uses 30. After a refresh the old photos stop being shown immediately, but their files are kept this long before being deleted — a safety margin for pages already sent to a browser and for CDN caches. 0 deletes them right away. 0 to 10080.

?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 PhotoFeed (Fetchski\AttractCmsLaravel\Data\PhotoFeed). PhotoFeed content type. Read its properties ($photoFeed->title): 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. 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.

?string

Sometimes sent: null when the site leaves it out. Which external photo store to draw from. Connections (bucket, region, keys) are set up once in Connections → Photo storage.

?string

Sometimes sent: null when the site leaves it out. Optional. The folder inside the bucket the dated folders live under — leave empty when they sit at the top level (e.g. “2026/May/31/…”).

Enums\FeedLayout|string|null

Sometimes sent: null when the site leaves it out. How deep the dated folders go. The month and day folder NAMES don’t matter — “May”, “05” and “5” are all understood — only the depth. One of ymd, ym, y, flat; a newer site may send others, so keep a fallback.

Enums\FeedDateRule|string|null

Sometimes sent: null when the site leaves it out. Which dates this feed is allowed to pull from. Only the folders inside this window are ever listed, so a huge library stays cheap to sample. One of recentDays, thisYear, lastYears, range, all; a newer site may send others, so keep a fallback.

?int

Sometimes sent: null when the site leaves it out. Counting today. 5 means today and the four days before it. 1 to 365.

?int

Sometimes sent: null when the site leaves it out. Counting this one. 2 means this calendar year and last. 1 to 25.

?CarbonImmutable

Sometimes sent: null when the site leaves it out. From. Format: an ISO 8601 date (YYYY-MM-DD).

?CarbonImmutable

Sometimes sent: null when the site leaves it out. To. Format: an ISO 8601 date (YYYY-MM-DD).

Enums\FeedDistribution|string|null

Sometimes sent: null when the site leaves it out. Spread samples one target count across as many different days as possible (best for a wide window). Every day takes the same number from each day in the window (best for a daily-update wall). One of total, perDay; a newer site may send others, so keep a fallback.

?int

Sometimes sent: null when the site leaves it out. How many photos this feed shows. Each refresh replaces the whole set. 1 to 500.

?int

Sometimes sent: null when the site leaves it out. Taken from every day in the window — 10 from each of the last 5 days is 50 photos. 1 to 200.

?bool

Sometimes sent: null when the site leaves it out. Remember which photos were used and prefer ones that haven’t been shown lately, so a big library keeps producing new sets. When a date window runs out of unseen photos it reuses the oldest ones rather than showing fewer.

?int

Sometimes sent: null when the site leaves it out. The size of that memory. Bigger means longer before a photo can repeat; 0 turns the memory off. 0 to 20000.

Enums\FeedFormat|string|null

Sometimes sent: null when the site leaves it out. Every photo is re-encoded on the way in — which also strips camera metadata (location, device) from what the site serves. One of webp, jpeg; a newer site may send others, so keep a fallback.

?int

Sometimes sent: null when the site leaves it out. Photos larger than this are scaled down. 2000 is plenty for a full-screen lightbox; the gallery tiles use much smaller generated sizes. 320 to 6000.

?int

Sometimes sent: null when the site leaves it out. Encoder quality, 40–100. 82 is a good balance; above 90 grows files fast with little visible gain.

Enums\FeedAspect|string|null

Sometimes sent: null when the site leaves it out. Keep each photo’s own proportions (best for the Mosaic and Masonry layouts), or crop everything to one shape for a perfectly uniform wall. Crops are centered on the busiest part of the photo. One of original, 1:1, 4:3, 3:2, 16:9, 4:5; a newer site may send others, so keep a fallback.

?string

Sometimes sent: null when the site leaves it out. Optional. Describes what these photos generally show, for screen readers and the lightbox caption. Applied to each photo as it is imported — leave empty to import them without alt text.

?bool

Sometimes sent: null when the site leaves it out. Master switch. When off, the feed keeps showing its current photos and only refreshes when you run it by hand.

Enums\FeedInterval|string|null

Sometimes sent: null when the site leaves it out. How often to fetch a fresh set. Change it anytime — no restart. One of 1, 2, 3, 4, 6, 12, 24, 48; a newer site may send others, so keep a fallback.

?int

Sometimes sent: null when the site leaves it out. After a refresh the old photos stop being shown immediately, but their files are kept this long before being deleted — a safety margin for pages already sent to a browser and for CDN caches. 0 deletes them right away. 0 to 10080.

?string

Sometimes sent: null when the site leaves it out. Set automatically. The schedule paces the next refresh off this.

?string

Sometimes sent: null when the site leaves it out. Last result.

?int

Sometimes sent: null when the site leaves it out. Photos showing.

?string

Sometimes sent: null when the site leaves it out. Why the last refresh failed, when it did. A failed refresh never empties the gallery — the previous photos keep showing.

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

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

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

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

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

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

Terminal

php artisan test

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

tests/Feature/ReplacePhotoFeedAnswerTest.php

<?php

declare(strict_types=1);

namespace Tests\Feature;

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

final class ReplacePhotoFeedAnswerTest extends TestCase
{
    public function test_replace_photo_feed_answers_your_values(): void
    {
        Attract::fake([
            'photoFeeds.replacePhotoFeed' => PhotoFeed::factory()->make(['title' => 'Your value']),
        ]);

        $photoFeed = Attract::photoFeeds()->replacePhotoFeed(id: 'clx8m2k4p0000a1b2c3d4e5f6', title: 'Example title', visibility: 'public');

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

List a feed’s photos

Attract::photoFeeds()->listPhotoFeedPhotos()

List photo feeds

Attract::photoFeeds()->listPhotoFeeds()

Create a photo feed

Attract::photoFeeds()->createPhotoFeed()

Get a photo feed

Attract::photoFeeds()->getPhotoFeed()

Delete a photo feed

Attract::photoFeeds()->deletePhotoFeed()

Update a photo feed

Attract::photoFeeds()->updatePhotoFeed()

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

$photoFeed = Attract::photoFeeds()->replacePhotoFeed(id: 'clx8m2k4p0000a1b2c3d4e5f6', title: 'Example title', visibility: 'public');

{
  "title": "Example title",
  "feedConnectionId": "clx8m2k4p0000a1b2c3d4e5f6",
  "feedPrefix": "Example feed prefix",
  "feedLayout": "ymd",
  "slug": "example-slug",
  "visibility": "public",
  "feedDateRule": "recentDays",
  "feedRecentDays": 5,
  "feedYears": 2,
  "feedRangeStart": "2026-10-24",
  "feedRangeEnd": "2026-10-24",
  "feedDistribution": "total",
  "feedTargetCount": 30,
  "feedPerDayCount": 10,
  "feedAvoidRepeats": true,
  "feedSeenLimit": 2000,
  "feedFormat": "webp",
  "feedMaxDimension": 2000,
  "feedQuality": 82,
  "feedAspect": "original",
  "feedAltText": "Example feed alt text",
  "feedEnabled": false,
  "feedInterval": "6",
  "feedRetainMinutes": 30,
  "feedLastRunAt": "2026-10-24T09:30:00.000Z",
  "feedLastStatus": "Example feed last status",
  "feedPhotoCount": 1,
  "feedLastError": "Example feed last error",
  "archived": false,
  "_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

List a feed’s photos

List photo feeds

Create a photo feed

Get a photo feed

Delete a photo feed

Update a photo feed

PUT /photo-feed/{_id}

In your app

Call it from the terminal

Find the id

Behavior

Test it

Related

List a feed’s photos

List photo feeds

Create a photo feed

Get a photo feed

Delete a photo feed

Update a photo feed

PUT /photo-feed/{_id}