> ## Documentation Index
> Fetch the complete documentation index at: https://docs.fetchski-attract.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Update a photo album

> Update an existing photo album.

```ts TypeScript wrap theme={"dark"}
import { createSiteClient } from '@fetchski/attract-cms-sdk';

const site = createSiteClient();
const photoAlbum = await site.photoAlbums().updatePhotoAlbum({ id: 'clx8m2k4p0000a1b2c3d4e5f6' });
```

```json 200 wrap theme={"dark"}
{
  "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 function makes the call on the client it is given, so your code passes the real one and a test passes a fake.

**1. Add the function**

```ts src/attract/update-photo-album.ts theme={"dark"}
import type { SiteClient } from '@fetchski/attract-cms-sdk';

export async function updatePhotoAlbum(site: SiteClient, id: string) {
  return site.photoAlbums().updatePhotoAlbum({ id });
}
```

**2. Call it**

A script makes the client once and calls the function:

```ts scripts/update-photo-album.ts theme={"dark"}
import { createSiteClient } from '@fetchski/attract-cms-sdk';
import { updatePhotoAlbum } from '../src/attract/update-photo-album.ts';

const site = createSiteClient();
console.log(await updatePhotoAlbum(site, 'clx8m2k4p0000a1b2c3d4e5f6'));
```

```bash Terminal theme={"dark"}
node --env-file=.env scripts/update-photo-album.ts
```

A route handler, a job or a queue worker calls it the same way.

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

```ts TypeScript wrap theme={"dark"}
import { createSiteClient } from '@fetchski/attract-cms-sdk';

const site = createSiteClient();
const row = (await site.photoAlbums().listPhotoAlbumsPick(['title', 'slug'])).find((each) => each.slug === 'getting-started'); // { id, title, slug }, or undefined
```

Pass `row.id` as `id`. Drafts: list with `{ aposMode: 'draft' }` to get the draft’s id ([Find an id](https://docs.fetchski-attract.com/find-an-id.md)).

> [accordion] Required parameters
>
> One object, e.g. `updatePhotoAlbum({ id })`; leave out the optional fields.
>
> **id** `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`).

> [accordion] Optional parameters
>
> **aposMode** `AposMode | null | undefined`
>
> **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`.
>
> **aposLocale** `string | null | undefined`
>
> **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).
>
> **title** `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.
>
> **description** `string | null | undefined`
>
> **Optional.** Leave it out and the site uses `""`. Optional. A short intro shown with the album on a gallery page.
>
> **photos** `readonly Readonly\<Record\<string, unknown\>\>[] | null | undefined`
>
> **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.
>
> **slug** `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** `Visibility | null | undefined`
>
> **Optional.** Leave it out and the site uses `"public"`. Select whether this content is public or private. One of `public`, `loginRequired`.
>
> **scheduledPublish** `string | null | undefined`
>
> **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`.
>
> **scheduledUnpublish** `string | null | undefined`
>
> **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`.
>
> **albumOrganizeFolder** `boolean | null | undefined`
>
> **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.
>
> **albumFolder** `readonly Readonly\<Record\<string, unknown\>\>[] | null | undefined`
>
> **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.
>
> **archived** `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.

> [accordion] Returns
>
> A `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`).
>
> **title** `string`
>
> **Always sent.** Its title: the name it goes by in every list, and the heading of its page where it has one.
>
> **slug** `string`
>
> **Always sent.** The URL name: lowercase words joined by hyphens (letters outside a–z, even emoji, are kept).
>
> **id** `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.
>
> **type** `string`
>
> **Always sent.** The document type’s name: always this type’s.
>
> **description** `string | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional. A short intro shown with the album on a gallery page.
>
> **photos** `readonly Readonly\<Record\<string, unknown\>\>[] | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. 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.
>
> **visibility** `Visibility | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Select whether this content is public or private. One of `public`, `loginRequired`; a newer site may send others, so keep a fallback.
>
> **scheduledPublish** `string | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. An ISO 8601 date and time, e.g. `2026-10-21T14:30:00.000Z`.
>
> **scheduledUnpublish** `string | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. An ISO 8601 date and time, e.g. `2026-10-21T14:30:00.000Z`.
>
> **albumOrganizeFolder** `boolean | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. 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.
>
> **albumFolder** `readonly Readonly\<Record\<string, unknown\>\>[] | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. 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.
>
> **archived** `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.
>
> **createdAt** `Date | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. When it was created (ISO 8601). Format: an ISO 8601 date and time.
>
> **updatedAt** `Date | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. When it last changed (ISO 8601). Format: an ISO 8601 date and time.
>
> **aposShareKey** `string | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. 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.

> [accordion] Errors
>
> Nothing to catch: the SDK retries what is safe, and throws the rest as the classes below; catch only what you want to react to (see [Errors and testing](https://docs.fetchski-attract.com/typescript/errors.md)).
>
> **ValidationFailed** `400`
>
> The site refused what was sent: `errors` lists each field’s problem, `siteMessage` the first.
>
> **Retried first:** No. **Read:** `errors` (field → messages), `siteMessage`.
>
> **AuthenticationFailed** `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`.
>
> **Forbidden** `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`.
>
> **NotFound** `404`
>
> Nothing matches, or the caller may not see it.
>
> **Retried first:** No. **Read:** `siteMessage`, `errorName`, `data`.
>
> **SiteError** `500`
>
> The site failed. Its logs say why.
>
> **Retried first:** No: a write may have landed. **Read:** `siteMessage`, `errorName`, `data`.
>
> **SiteUnreachable** `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`.
>
> **RequestNotSent** `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).
>
> **SiteRequestFailed** `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`.
>
> **UnknownSite** `setup`
>
> `sites.forSite('acme')` named a slug your sites (`createSiteClients()`) don’t have.
>
> **Retried first:** No: nothing was sent. **Read:** `message`, `slug`.
>
> **SiteConfigurationError** `setup`
>
> The client’s settings are wrong: no `FETCHSKI_ATTRACT_URL` (or `baseUrl`), or a malformed API key.
>
> **Retried first:** No: nothing was sent. **Read:** `message` (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` (milliseconds) on the client for longer.

## Test it

It calls the function above with a fake client: the fake answers every call with a valid example, so nothing leaves your machine and no settings or key are needed. Run it with `node --test`.

```ts tests/photoAlbums-updatePhotoAlbum.test.ts theme={"dark"}
import { test } from 'node:test';
import { fakeSite } from '@fetchski/attract-cms-sdk/testing';
import { updatePhotoAlbum } from '../src/attract/update-photo-album.ts';

test('photoAlbums.updatePhotoAlbum', async () => {
  const site = fakeSite();
  await updatePhotoAlbum(site, 'clx8m2k4p0000a1b2c3d4e5f6');
  site.assertCalled('photoAlbums.updatePhotoAlbum', (args) => args.id === 'clx8m2k4p0000a1b2c3d4e5f6');
});
```

**Answer with your own values:** fake `photoAlbums.updatePhotoAlbum` with `factories.PhotoAlbum({...})`, the fields you give over a valid example.

```ts tests/photoAlbums-updatePhotoAlbum-answer.test.ts theme={"dark"}
import assert from 'node:assert/strict';
import { test } from 'node:test';
import { factories, fakeSite } from '@fetchski/attract-cms-sdk/testing';

test('photoAlbums.updatePhotoAlbum answers your values', async () => {
  const site = fakeSite({
    'photoAlbums.updatePhotoAlbum': factories.PhotoAlbum({ title: 'Your value' })
  });
  const photoAlbum = await site.photoAlbums().updatePhotoAlbum({ id: 'clx8m2k4p0000a1b2c3d4e5f6' });
  assert.equal(photoAlbum.title, 'Your value');
});
```

## Related

> [card] [List a photo album’s locales](https://docs.fetchski-attract.com/typescript/reference/photo-albums/get-photo-album-locales.md)
>
> `site.photoAlbums().getPhotoAlbumLocales()`

> [card] [List photo albums](https://docs.fetchski-attract.com/typescript/reference/photo-albums/list-photo-albums.md)
>
> `site.photoAlbums().listPhotoAlbums()`

> [card] [Create a photo album](https://docs.fetchski-attract.com/typescript/reference/photo-albums/create-photo-album.md)
>
> `site.photoAlbums().createPhotoAlbum()`

> [card] [Get a photo album](https://docs.fetchski-attract.com/typescript/reference/photo-albums/get-photo-album.md)
>
> `site.photoAlbums().getPhotoAlbum()`

> [card] [Replace a photo album](https://docs.fetchski-attract.com/typescript/reference/photo-albums/replace-photo-album.md)
>
> `site.photoAlbums().replacePhotoAlbum()`

> [card] [Delete a photo album](https://docs.fetchski-attract.com/typescript/reference/photo-albums/delete-photo-album.md)
>
> `site.photoAlbums().deletePhotoAlbum()`

> [card] [PATCH /photo-album/\{\_id}](https://docs.fetchski-attract.com/api-reference/photo-albums/update-a-photo-album.md)
>
> The endpoint this calls, in the API reference: the HTTP request and answer, and every rule the site checks.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.