Update a photo feed

import app from '@adonisjs/core/services/app'
import { SiteClient } from '@fetchski/attract-cms-sdk'

const site = await app.container.make(SiteClient)
const photoFeed = await site.photoFeeds().updatePhotoFeed({ id: 'clx8m2k4p0000a1b2c3d4e5f6' })

{
  "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"
}

import app from '@adonisjs/core/services/app'
import { SiteClient } from '@fetchski/attract-cms-sdk'

const site = await app.container.make(SiteClient)
const photoFeed = await site.photoFeeds().updatePhotoFeed({ id: 'clx8m2k4p0000a1b2c3d4e5f6' })

{
  "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 updatePhotoFeed() and returns the answer.

Add the controller

app/controllers/update_photo_feed_controller.ts

import { inject } from '@adonisjs/core'
import type { HttpContext } from '@adonisjs/core/http'
import { SiteClient } from '@fetchski/attract-cms-sdk'

@inject()
export default class UpdatePhotoFeedController {
  constructor(protected site: SiteClient) {}

  async handle({ params }: HttpContext) {
    return this.site.photoFeeds().updatePhotoFeed({ id: params.id })
  }
}

Add the route

start/routes.ts

import router from '@adonisjs/core/services/router'

const UpdatePhotoFeedController = () => import('#controllers/update_photo_feed_controller')

router.patch('/photo-feed/:id', [UpdatePhotoFeedController])

Put it behind your auth middleware (.use(middleware.auth())): it acts with your key’s access.

Call it

Your own page’s form or script sends PATCH /photo-feed/clx8m2k4p0000a1b2c3d4e5f6 and gets back its answer as JSON. Test it, below, calls it.

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.

AdonisJS

import app from '@adonisjs/core/services/app'
import { SiteClient } from '@fetchski/attract-cms-sdk'

const site = await app.container.make(SiteClient)
const row = (await site.photoFeeds().listPhotoFeedsPick(['title', 'slug'])).find((each) => each.slug === 'getting-started') // { id, title, slug }, or undefined

Pass row.id as id. See Find an id.

Required parameters

One object, e.g. updatePhotoFeed({ id }); leave out the optional fields.

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 | null | undefined

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.

string | null | undefined

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 | null | undefined

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/…”).

FeedLayout | null | undefined

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 | null | undefined

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

Visibility | null | undefined

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

FeedDateRule | null | undefined

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.

number | null | undefined

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

number | null | undefined

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

Date | string | null | undefined

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

Date | string | null | undefined

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

FeedDistribution | null | undefined

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.

number | null | undefined

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

number | null | undefined

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.

boolean | null | undefined

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.

number | null | undefined

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.

FeedFormat | null | undefined

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.

number | null | undefined

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.

number | null | undefined

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.

FeedAspect | null | undefined

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 | null | undefined

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.

boolean | null | undefined

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.

FeedInterval | null | undefined

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.

number | null | undefined

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.

boolean | null | undefined

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

Visibility

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.

Date

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

Date

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

string | null

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

string | null

Sometimes sent: undefined when the site leaves it out, and it can be null. 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/…”).

FeedLayout | null

Sometimes sent: undefined when the site leaves it out, and it can be null. 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.

FeedDateRule | null

Sometimes sent: undefined when the site leaves it out, and it can be null. 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.

number | null

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

number | null

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

Date | null

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

Date | null

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

FeedDistribution | null

Sometimes sent: undefined when the site leaves it out, and it can be null. 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.

number | null

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

number | null

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

boolean | null

Sometimes sent: undefined when the site leaves it out, and it can be null. 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.

number | null

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

FeedFormat | null

Sometimes sent: undefined when the site leaves it out, and it can be null. 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.

number | null

Sometimes sent: undefined when the site leaves it out, and it can be null. 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.

number | null

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

FeedAspect | null

Sometimes sent: undefined when the site leaves it out, and it can be null. 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 | null

Sometimes sent: undefined when the site leaves it out, and it can be null. 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.

boolean | null

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

FeedInterval | null

Sometimes sent: undefined when the site leaves it out, and it can be null. 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.

number | null

Sometimes sent: undefined when the site leaves it out, and it can be null. 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 | null

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

string | null

Sometimes sent: undefined when the site leaves it out, and it can be null. Last result.

number | null

Sometimes sent: undefined when the site leaves it out, and it can be null. Photos showing.

string | null

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

boolean | null

Sometimes sent: undefined when the site leaves it out, and it can be null. 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 throws the rest as the classes below. Your exception handler turns them into your app’s own answers, once for every call (see Map SDK errors to responses); catch only what you want to react to here.

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

sites.forSite('acme') named a slug config/attract.ts doesn’t list (with the keys in the database: no row in attract_api_keys).Retried first: No: nothing was sent. Read: message, slug.

setup

The site’s entry is wrong: a malformed baseUrl or key, a key filed under another slug, or no default site. node ace attract:check names the fix.Retried first: No: nothing was sent. Read: message (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 (milliseconds) in config/attract.ts for longer.

Test it

It calls the controller above with the SDK faked: fakeAttract() puts the fake in the container for this one test, and it answers every call with a valid example, so nothing leaves your machine and no key is read. Save it as tests/unit/photo_feeds_update_photo_feed.spec.ts, then run your tests:

tests/unit/photo_feeds_update_photo_feed.spec.ts

import { test } from '@japa/runner'
import app from '@adonisjs/core/services/app'
import testUtils from '@adonisjs/core/services/test_utils'
import { fakeAttract } from '@fetchski/attract-cms-adonis/testing'
import UpdatePhotoFeedController from '#controllers/update_photo_feed_controller'

test('photoFeeds.updatePhotoFeed', async () => {
  const site = fakeAttract()

  const ctx = await testUtils.createHttpContext()
  ctx.params = { id: 'clx8m2k4p0000a1b2c3d4e5f6' }
  const controller = await app.container.make(UpdatePhotoFeedController)
  await controller.handle(ctx)

  site.assertCalled('photoFeeds.updatePhotoFeed', (args) => args.id === 'clx8m2k4p0000a1b2c3d4e5f6')
})

Terminal

node ace test

Answer with your own values: fake photoFeeds.updatePhotoFeed with factories.PhotoFeed({...}), the fields you give over a valid example.

tests/unit/photo_feeds_update_photo_feed_answers.spec.ts

import { test } from '@japa/runner'
import { factories, fakeAttract } from '@fetchski/attract-cms-adonis/testing'

test('photoFeeds.updatePhotoFeed answers your values', async ({ assert }) => {
  const site = fakeAttract({
    'photoFeeds.updatePhotoFeed': factories.PhotoFeed({ title: 'Your value' }),
  })

  const photoFeed = await site.photoFeeds().updatePhotoFeed({ id: 'clx8m2k4p0000a1b2c3d4e5f6' })
  assert.containSubset(photoFeed, { title: 'Your value' })
})

List a feed’s photos

site.photoFeeds().listPhotoFeedPhotos()

List photo feeds

site.photoFeeds().listPhotoFeeds()

Create a photo feed

site.photoFeeds().createPhotoFeed()

Get a photo feed

site.photoFeeds().getPhotoFeed()

Replace a photo feed

site.photoFeeds().replacePhotoFeed()

Delete a photo feed

site.photoFeeds().deletePhotoFeed()

PATCH /photo-feed/{_id}

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

import app from '@adonisjs/core/services/app'
import { SiteClient } from '@fetchski/attract-cms-sdk'

const site = await app.container.make(SiteClient)
const photoFeed = await site.photoFeeds().updatePhotoFeed({ id: 'clx8m2k4p0000a1b2c3d4e5f6' })

{
  "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

Find the id

Behavior

Test it

List a feed’s photos

List photo feeds

Create a photo feed

Get a photo feed

Replace a photo feed

Delete a photo feed

PATCH /photo-feed/{_id}

In your app

Find the id

Behavior

Test it

Related

List a feed’s photos

List photo feeds

Create a photo feed

Get a photo feed

Replace a photo feed

Delete a photo feed

PATCH /photo-feed/{_id}