Replace an image folder

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

const site = await app.container.make(SiteClient)
const imageFolder = await site.imageFolders().replaceImageFolder({ id: 'clx8m2k4p0000a1b2c3d4e5f6', title: 'Example title', visibility: 'public' })

{
  "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,
  "linkedAlbumId": "clx8m2k4p0000a1b2c3d4e5f6",
  "linkedFeedId": "clx8m2k4p0000a1b2c3d4e5f6",
  "linkedDocId": "clx8m2k4p0000a1b2c3d4e5f6",
  "_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 imageFolder = await site.imageFolders().replaceImageFolder({ id: 'clx8m2k4p0000a1b2c3d4e5f6', title: 'Example title', visibility: 'public' })

{
  "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,
  "linkedAlbumId": "clx8m2k4p0000a1b2c3d4e5f6",
  "linkedFeedId": "clx8m2k4p0000a1b2c3d4e5f6",
  "linkedDocId": "clx8m2k4p0000a1b2c3d4e5f6",
  "_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 replaceImageFolder() and returns the answer.

Add the controller

app/controllers/replace_image_folder_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 ReplaceImageFolderController {
  constructor(protected site: SiteClient) {}

  async handle({ params }: HttpContext) {
    return this.site.imageFolders().replaceImageFolder({ id: params.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

start/routes.ts

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

const ReplaceImageFolderController = () => import('#controllers/replace_image_folder_controller')

router.put('/image-folder/:id', [ReplaceImageFolderController])

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 PUT /image-folder/clx8m2k4p0000a1b2c3d4e5f6 and gets back its answer as JSON. Test it, below, calls it.

PATCH changes only the fields sent. Update an existing image folder.

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.imageFolders().listImageFoldersPick(['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. replaceImageFolder({ 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).

string

required

Required. Its title: the name it goes by in every list, and the heading of its page where it has one.

Visibility

required

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

Optional parameters

readonly Readonly<Record<string, unknown>>[] | null | undefined

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

boolean | null | undefined

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

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.

string | null | undefined

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

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

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.

number | null | undefined

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.

string | null | undefined

Optional. Leave it out and the site uses "". On a folder the site made for a Photo Album, that one’s id; empty otherwise. Owned by the site: an update keeps the stored value whatever it sends.

string | null | undefined

Optional. Leave it out and the site uses "". On a folder the site made for a Photo Feed, that one’s id; empty otherwise. Owned by the site: an update keeps the stored value whatever it sends.

string | null | undefined

Optional. Leave it out and the site uses "". On a folder the site made for a page’s or post’s feed photos, that one’s id; empty otherwise. Owned by the site: an update keeps the stored value whatever it sends.

Returns

An ImageFolder. ImageFolder content type. Read its properties (imageFolder.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).

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.

readonly Readonly<Record<string, unknown>>[] | null

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

boolean | null

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

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.

string | null

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

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

string | null

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

number | null

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

string | null

Sometimes sent: undefined when the site leaves it out, and it can be null. On a folder the site made for a Photo Album, that one’s id; empty otherwise. Owned by the site: an update keeps the stored value whatever it sends.

string | null

Sometimes sent: undefined when the site leaves it out, and it can be null. On a folder the site made for a Photo Feed, that one’s id; empty otherwise. Owned by the site: an update keeps the stored value whatever it sends.

string | null

Sometimes sent: undefined when the site leaves it out, and it can be null. On a folder the site made for a page’s or post’s feed photos, that one’s id; empty otherwise. Owned by the site: an update keeps the stored value whatever it sends.

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:images:write (or a master above it: content:images: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/image_folders_replace_image_folder.spec.ts, then run your tests:

tests/unit/image_folders_replace_image_folder.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 ReplaceImageFolderController from '#controllers/replace_image_folder_controller'

test('imageFolders.replaceImageFolder', async () => {
  const site = fakeAttract()

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

  site.assertCalled('imageFolders.replaceImageFolder', (args) => args.id === 'clx8m2k4p0000a1b2c3d4e5f6')
})

Terminal

node ace test

Answer with your own values: fake imageFolders.replaceImageFolder with factories.ImageFolder({...}), the fields you give over a valid example.

tests/unit/image_folders_replace_image_folder_answers.spec.ts

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

test('imageFolders.replaceImageFolder answers your values', async ({ assert }) => {
  const site = fakeAttract({
    'imageFolders.replaceImageFolder': factories.ImageFolder({ title: 'Your value' }),
  })

  const imageFolder = await site.imageFolders().replaceImageFolder({ id: 'clx8m2k4p0000a1b2c3d4e5f6', title: 'Example title', visibility: 'public' })
  assert.containSubset(imageFolder, { title: 'Your value' })
})

Get the image folder tree

site.imageFolders().getImageFolderTree()

List a folder’s photos

site.imageFolders().listImageFolderPhotos()

List image folders

site.imageFolders().listImageFolders()

Create an image folder

site.imageFolders().createImageFolder()

Get an image folder

site.imageFolders().getImageFolder()

Delete an image folder

site.imageFolders().deleteImageFolder()

PUT /image-folder/{_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 imageFolder = await site.imageFolders().replaceImageFolder({ id: 'clx8m2k4p0000a1b2c3d4e5f6', title: 'Example title', visibility: 'public' })

{
  "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,
  "linkedAlbumId": "clx8m2k4p0000a1b2c3d4e5f6",
  "linkedFeedId": "clx8m2k4p0000a1b2c3d4e5f6",
  "linkedDocId": "clx8m2k4p0000a1b2c3d4e5f6",
  "_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

Get the image folder tree

List a folder’s photos

List image folders

Create an image folder

Get an image folder

Delete an image folder

PUT /image-folder/{_id}

In your app

Find the id

Behavior

Test it

Related

Get the image folder tree

List a folder’s photos

List image folders

Create an image folder

Get an image folder

Delete an image folder

PUT /image-folder/{_id}