Publish a photo album

import { createSiteClient } from '@fetchski/attract-cms-sdk';

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

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

import { createSiteClient } from '@fetchski/attract-cms-sdk';

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

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

Add the function

src/attract/publish-photo-album.ts

import type { SiteClient } from '@fetchski/attract-cms-sdk';

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

Call it

A script makes the client once and calls the function:

scripts/publish-photo-album.ts

import { createSiteClient } from '@fetchski/attract-cms-sdk';
import { publishPhotoAlbum } from '../src/attract/publish-photo-album.ts';

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

Terminal

node --env-file=.env scripts/publish-photo-album.ts

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

Answers the draft.

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.

TypeScript

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

Required parameters

One object, e.g. publishPhotoAlbum({ 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).

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

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

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

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.

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.

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.

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.

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.

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.

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.

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.

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

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 your sites (createSiteClients()) don’t have.Retried first: No: nothing was sent. Read: message, slug.

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:publish (or a master above it: content:photo-albums: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) 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.

tests/photoAlbums-publishPhotoAlbum.test.ts

import { test } from 'node:test';
import { fakeSite } from '@fetchski/attract-cms-sdk/testing';
import { publishPhotoAlbum } from '../src/attract/publish-photo-album.ts';

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

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

tests/photoAlbums-publishPhotoAlbum-answer.test.ts

import assert from 'node:assert/strict';
import { test } from 'node:test';
import { factories, fakeSite } from '@fetchski/attract-cms-sdk/testing';

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

List a photo album’s locales

site.photoAlbums().getPhotoAlbumLocales()

List photo albums

site.photoAlbums().listPhotoAlbums()

Create a photo album

site.photoAlbums().createPhotoAlbum()

Get a photo album

site.photoAlbums().getPhotoAlbum()

Replace a photo album

site.photoAlbums().replacePhotoAlbum()

Delete a photo album

site.photoAlbums().deletePhotoAlbum()

POST /photo-album/{_id}/publish

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

import { createSiteClient } from '@fetchski/attract-cms-sdk';

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

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

Find the id

Behavior

Test it

List a photo album’s locales

List photo albums

Create a photo album

Get a photo album

Replace a photo album

Delete a photo album

POST /photo-album/{_id}/publish

In your app

Find the id

Behavior

Test it

Related

List a photo album’s locales

List photo albums

Create a photo album

Get a photo album

Replace a photo album

Delete a photo album

POST /photo-album/{_id}/publish