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

# Restore a photo album’s previous publish

> Puts the previously published version back as the published document.

```php Laravel wrap theme={"dark"}
use Fetchski\AttractCmsLaravel\Facades\Attract;

$photoAlbum = Attract::photoAlbums()->revertPhotoAlbumPublishedToPrevious(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 controller answers a route on your app: it calls `revertPhotoAlbumPublishedToPrevious()` and returns the answer.

**1. Add the controller**

```php app/Http/Controllers/RevertPhotoAlbumPublishedToPreviousController.php theme={"dark"}
<?php

declare(strict_types=1);

namespace App\Http\Controllers;

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

final class RevertPhotoAlbumPublishedToPreviousController
{
    public function __invoke(string $id): PhotoAlbum
    {
        return Attract::photoAlbums()->revertPhotoAlbumPublishedToPrevious(id: $id);
    }
}
```

**2. Add the route**

```php routes/web.php theme={"dark"}
use App\Http\Controllers\RevertPhotoAlbumPublishedToPreviousController;
use Illuminate\Support\Facades\Route;

Route::post('/photo-album/{id}/revert-published-to-previous', RevertPhotoAlbumPublishedToPreviousController::class)->middleware('auth');
```

It acts with your key’s access, so `auth` lets only your signed-in users reach it.

**3. Call it**

Your own page’s form or script sends `POST /photo-album/clx8m2k4p0000a1b2c3d4e5f6/revert-published-to-previous` (a form adds `@csrf`, as every web route checks it), and gets back its answer as JSON. Test it, below, calls it.

> [!TIP]
>
> To keep the call in an Action instead, this writes `app/Actions/Attract/RevertPhotoAlbumPublishedToPrevious.php` (an invokable Action that calls `revertPhotoAlbumPublishedToPrevious()`) and its test under `tests/Feature/Actions/Attract/` (Pest when your app has it):
>
> ```bash Terminal theme={"dark"}
> php artisan make:attract-action photoAlbums.revertPhotoAlbumPublishedToPrevious
> ```

## Call it from the terminal

```bash Terminal theme={"dark"}
php artisan attract:call photoAlbums.revertPhotoAlbumPublishedToPrevious \
  id=clx8m2k4p0000a1b2c3d4e5f6
```

It calls `revertPhotoAlbumPublishedToPrevious()` 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](https://docs.fetchski-attract.com/call-command.md) for every argument type.

Answers it; 400 `invalid` when there is none.

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

```php Laravel wrap theme={"dark"}
use Fetchski\AttractCmsLaravel\Facades\Attract;

$row = Attract::photoAlbums()->listPhotoAlbumsPick(fields: ['title', 'slug'])->firstWhere('slug', 'getting-started'); // ['id' => …, 'title' => …, 'slug' => …], or null
```

```bash Terminal theme={"dark"}
php artisan attract:call photoAlbums.listPhotoAlbumsPick fields=title,slug
```

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
>
> Named arguments, e.g. `revertPhotoAlbumPublishedToPrevious(id: …)`; leave out the optional ones.
>
> **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] Returns
>
> A `PhotoAlbum` (`Fetchski\AttractCmsLaravel\Data\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`
>
> **Sometimes sent:** `null` when the site leaves it out. Optional. A short intro shown with the album on a gallery page.
>
> **photos** `Collection\<int, array\<string, mixed\>\>|null`
>
> **Sometimes sent:** `null` when the site leaves it out. 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** `Enums\\Visibility|string|null`
>
> **Sometimes sent:** `null` when the site leaves it out. Select whether this content is public or private. One of `public`, `loginRequired`; a newer site may send others, so keep a fallback.
>
> **scheduledPublish** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out. An ISO 8601 date and time, e.g. `2026-10-21T14:30:00.000Z`.
>
> **scheduledUnpublish** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out. An ISO 8601 date and time, e.g. `2026-10-21T14:30:00.000Z`.
>
> **albumOrganizeFolder** `?bool`
>
> **Sometimes sent:** `null` when the site leaves it out. 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** `Collection\<int, array\<string, mixed\>\>|null`
>
> **Sometimes sent:** `null` when the site leaves it out. 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** `?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.
>
> **createdAt** `?CarbonImmutable`
>
> **Sometimes sent:** `null` when the site leaves it out. When it was created (ISO 8601). Format: an ISO 8601 date and time.
>
> **updatedAt** `?CarbonImmutable`
>
> **Sometimes sent:** `null` when the site leaves it out. When it last changed (ISO 8601). Format: an ISO 8601 date and time.
>
> **aposShareKey** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out. 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 Laravel logs and renders the rest (see [Errors and testing](https://docs.fetchski-attract.com/laravel/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`
>
> `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`.
>
> **SiteConfigurationError** `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-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` 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/RevertPhotoAlbumPublishedToPreviousTest.php`, then run your tests:

```php tests/Feature/RevertPhotoAlbumPublishedToPreviousTest.php theme={"dark"}
<?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 RevertPhotoAlbumPublishedToPreviousTest extends TestCase
{
    use RefreshDatabase;

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

        $this->actingAs(User::factory()->create())
            ->postJson('/photo-album/clx8m2k4p0000a1b2c3d4e5f6/revert-published-to-previous')
            ->assertOk();

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

```bash Terminal theme={"dark"}
php artisan test
```

**Answer with your own values:** fake `photoAlbums.revertPhotoAlbumPublishedToPrevious` with `PhotoAlbum::factory()->make([...])`, the fields you give over a valid example.

```php tests/Feature/RevertPhotoAlbumPublishedToPreviousAnswerTest.php theme={"dark"}
<?php

declare(strict_types=1);

namespace Tests\Feature;

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

final class RevertPhotoAlbumPublishedToPreviousAnswerTest extends TestCase
{
    public function test_revert_photo_album_published_to_previous_answers_your_values(): void
    {
        Attract::fake([
            'photoAlbums.revertPhotoAlbumPublishedToPrevious' => PhotoAlbum::factory()->make(['title' => 'Your value']),
        ]);

        $photoAlbum = Attract::photoAlbums()->revertPhotoAlbumPublishedToPrevious(id: 'clx8m2k4p0000a1b2c3d4e5f6');

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

## Related

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

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

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

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

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

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

> [card] [POST /photo-album/\{\_id}/revert-published-to-previous](https://docs.fetchski-attract.com/api-reference/photo-albums/restore-a-photo-album’s-previous-publish.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.