Discard a video’s draft changes

use Fetchski\AttractCmsLaravel\Facades\Attract;

$video = Attract::videos()->revertVideoDraftToPublished(id: 'clx8m2k4p0000a1b2c3d4e5f6');

{
  "title": "Example title",
  "video": {},
  "poster": {
    "metaType": "area",
    "_id": "clx8m2k4p0000a1b2c3d4e5f6",
    "items": [
      {
        "type": "@apostrophecms/image",
        "_id": "clx8m2k4p0000a1b2c3d4e5f6",
        "metaType": "widget",
        "_image": [
          {}
        ],
        "caption": "Example caption",
        "linkTo": "none",
        "_apostrophecms-any-page-type": [
          {}
        ],
        "linkHref": "https://acme.example/example",
        "linkHrefTitle": "Example link href title",
        "linkTitle": "Example link title",
        "linkTarget": [
          "_blank"
        ],
        "sectionCss": {
          "slots": {},
          "css": "Example css",
          "mark": "Example mark"
        }
      }
    ]
  },
  "_folder": [
    {}
  ],
  "slug": "example-slug",
  "visibility": "public",
  "scheduledPublish": "Example scheduled publish",
  "scheduledUnpublish": "Example scheduled unpublish",
  "archived": false,
  "_id": "clx8m2k4p0000a1b2c3d4e5f6",
  "type": "Example type",
  "createdAt": "2026-10-24T09:30:00.000Z",
  "updatedAt": "2026-10-24T09:30:00.000Z",
  "aposShareKey": "k3v9x2m7q1z8w4p6"
}

use Fetchski\AttractCmsLaravel\Facades\Attract;

$video = Attract::videos()->revertVideoDraftToPublished(id: 'clx8m2k4p0000a1b2c3d4e5f6');

{
  "title": "Example title",
  "video": {},
  "poster": {
    "metaType": "area",
    "_id": "clx8m2k4p0000a1b2c3d4e5f6",
    "items": [
      {
        "type": "@apostrophecms/image",
        "_id": "clx8m2k4p0000a1b2c3d4e5f6",
        "metaType": "widget",
        "_image": [
          {}
        ],
        "caption": "Example caption",
        "linkTo": "none",
        "_apostrophecms-any-page-type": [
          {}
        ],
        "linkHref": "https://acme.example/example",
        "linkHrefTitle": "Example link href title",
        "linkTitle": "Example link title",
        "linkTarget": [
          "_blank"
        ],
        "sectionCss": {
          "slots": {},
          "css": "Example css",
          "mark": "Example mark"
        }
      }
    ]
  },
  "_folder": [
    {}
  ],
  "slug": "example-slug",
  "visibility": "public",
  "scheduledPublish": "Example scheduled publish",
  "scheduledUnpublish": "Example scheduled unpublish",
  "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 revertVideoDraftToPublished() and returns the answer.

Add the controller

app/Http/Controllers/RevertVideoDraftToPublishedController.php

<?php

declare(strict_types=1);

namespace App\Http\Controllers;

use Fetchski\AttractCmsLaravel\Facades\Attract;
use Illuminate\Http\JsonResponse;

final class RevertVideoDraftToPublishedController
{
    public function __invoke(string $id): JsonResponse
    {
        return response()->json(Attract::videos()->revertVideoDraftToPublished(id: $id));
    }
}

Add the route

routes/web.php

use App\Http\Controllers\RevertVideoDraftToPublishedController;
use Illuminate\Support\Facades\Route;

Route::post('/video/{id}/revert-draft-to-published', RevertVideoDraftToPublishedController::class)->middleware('auth');

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

Call it

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

To keep the call in an Action instead, this writes app/Actions/Attract/RevertVideoDraftToPublished.php (an invokable Action that calls revertVideoDraftToPublished()) and its test under tests/Feature/Actions/Attract/ (Pest when your app has it):

Terminal

php artisan make:attract-action videos.revertVideoDraftToPublished

Call it from the terminal

Terminal

php artisan attract:call videos.revertVideoDraftToPublished id=clx8m2k4p0000a1b2c3d4e5f6

It calls revertVideoDraftToPublished() 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 for every argument type. Answers the draft (false when it had no changes to discard).

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.

Laravel

use Fetchski\AttractCmsLaravel\Facades\Attract;

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

Terminal

php artisan attract:call videos.listVideosPick fields=title,slug

Pass $row['id'] as id. Drafts: list with aposMode: 'draft' to get the draft’s id (Find an id).

Required parameters

Named arguments, e.g. revertVideoDraftToPublished(id: …); leave out the optional ones.

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

Video|false: the Video, or false. Video content type. Read its properties ($video->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, _folder → folder, _image → image …).

string

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

array<string, mixed>

Always sent. mp4 or webm. For background loops keep it short, muted, and ideally under ~10 MB.

string

Always sent. The URL name: lowercase words joined by hyphens (letters outside a–z, even emoji, are kept).

Enums\Visibility|string

Always sent. Select whether this content is public or private.

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.

CarbonImmutable

Always sent. When it was created (ISO 8601).

CarbonImmutable

Always sent. When it last changed (ISO 8601).

?ImageArea

Sometimes sent: null when the site leaves it out. An ImageArea. Shown while the video loads, and instead of it for reduced-motion visitors. Widgets, top to bottom: send { "items": [ … ] }, one object per widget with its type. Writing it replaces the whole area.

Show ImageArea (Fetchski\AttractCmsLaravel\Data\ImageArea)

Widgets, top to bottom: send { "items": [ … ] }, one object per widget with its type. Writing it replaces the whole area.

Enums\AfterContentAreaMetaType|string|null

Sometimes sent: null when the site leaves it out. Always area. One of area; a newer site may send others, so keep a fallback.

?string

Sometimes sent: null when the site leaves it out. The area’s id, set by the site: leave it out when you write one.

Collection<int, ImageWidget>|null

Sometimes sent: null when the site leaves it out. A list of ImageWidget. The widgets, top to bottom. Each is an object with its type and that widget’s own fields; _id and metaType may be left out (the site sets them). At most 1 items.

Show ImageWidget (Fetchski\AttractCmsLaravel\Data\ImageWidget)

A @apostrophecms/image widget: its type and its own fields. A field left out takes its default.

Enums\ImageWidgetType|string

Always sent. The widget’s type: always @apostrophecms/image. One of @apostrophecms/image; a newer site may send others, so keep a fallback.

?string

Sometimes sent: null when the site leaves it out. The widget’s id, unique on the page. Leave it out for a new widget (the site sets one); keep it to change a widget that is there.

Enums\MetaType|string|null

Sometimes sent: null when the site leaves it out. Always widget. One of widget; a newer site may send others, so keep a fallback.

Collection<int, array<string, mixed>>|null

Sometimes sent: null when the site leaves it out. The related @apostrophecms/image 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.

?string

Sometimes sent: null when the site leaves it out. Caption.

Enums\LinkTo|string|null

Sometimes sent: null when the site leaves it out. Link To… One of none, @apostrophecms/any-page-type, _url; a newer site may send others, so keep a fallback.

Collection<int, array<string, mixed>>|null

Sometimes sent: null when the site leaves it out. The related @apostrophecms/any-page-type 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.

?string

Sometimes sent: null when the site leaves it out. apostrophe:linkHrefHelp When set, a URL; empty or null when not.

?string

Sometimes sent: null when the site leaves it out. Link Title.

?string

Sometimes sent: null when the site leaves it out. If empty, the title of the related document will be used.

Collection<int, Enums\LinkTarget|string>|null

Sometimes sent: null when the site leaves it out. Link Target. Each one of _blank.

?CustomCSS

Sometimes sent: null when the site leaves it out. A CustomCSS. CSS for this one section, typed into the slot of the part it styles. It wins over Site design → Custom CSS. Nested rules like &:hover, @media (width >= 48rem) and [data-theme=“light”] & work inside a slot.

Show CustomCSS (Fetchski\AttractCmsLaravel\Data\CustomCSS)

array<string, string>|null

Sometimes sent: null when the site leaves it out. The CSS typed into each part slot, by slot name.

?string

Sometimes sent: null when the site leaves it out. The compiled CSS (read only: rebuilt from slots).

?string

Sometimes sent: null when the site leaves it out. The site’s check mark for css (read only).

array<string, mixed>

Always there: [] when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too. An object in it that a PHP array would read as a list ({}, {"0": …}) is a stdClass, so it is sent back as an object.

array<string, mixed>

Collection<int, array<string, mixed>>|null

Sometimes sent: null when the site leaves it out. Optional. File this item in a media folder — the stored file physically moves to the matching location in storage. The related video-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.

?string

Sometimes sent: null when the site leaves it out. An ISO 8601 date and time, e.g. 2026-10-21T14:30:00.000Z.

?string

Sometimes sent: null when the site leaves it out. An ISO 8601 date and time, e.g. 2026-10-21T14:30:00.000Z.

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

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.

Errors

Nothing to catch: the SDK retries what is safe, and Laravel logs and renders the rest (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

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.

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:videos:write (or a master above it: content:videos: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/RevertVideoDraftToPublishedTest.php, then run your tests:

tests/Feature/RevertVideoDraftToPublishedTest.php

<?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 RevertVideoDraftToPublishedTest extends TestCase
{
    use RefreshDatabase;

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

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

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

Terminal

php artisan test

Answer with your own values: fake videos.revertVideoDraftToPublished with Video::factory()->make([...]), the fields you give over a valid example.

tests/Feature/RevertVideoDraftToPublishedAnswerTest.php

<?php

declare(strict_types=1);

namespace Tests\Feature;

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

final class RevertVideoDraftToPublishedAnswerTest extends TestCase
{
    public function test_revert_video_draft_to_published_answers_your_values(): void
    {
        Attract::fake([
            'videos.revertVideoDraftToPublished' => Video::factory()->make(['title' => 'Your value']),
        ]);

        $video = Attract::videos()->revertVideoDraftToPublished(id: 'clx8m2k4p0000a1b2c3d4e5f6');

        $this->assertInstanceOf(Video::class, $video);
        $this->assertSame('Your value', $video->title);
    }
}

List a video’s locales

Attract::videos()->getVideoLocales()

List videos

Attract::videos()->listVideos()

Create a video

Attract::videos()->createVideo()

Get a video

Attract::videos()->getVideo()

Replace a video

Attract::videos()->replaceVideo()

Delete a video

Attract::videos()->deleteVideo()

POST /video/{_id}/revert-draft-to-published

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

use Fetchski\AttractCmsLaravel\Facades\Attract;

$video = Attract::videos()->revertVideoDraftToPublished(id: 'clx8m2k4p0000a1b2c3d4e5f6');

{
  "title": "Example title",
  "video": {},
  "poster": {
    "metaType": "area",
    "_id": "clx8m2k4p0000a1b2c3d4e5f6",
    "items": [
      {
        "type": "@apostrophecms/image",
        "_id": "clx8m2k4p0000a1b2c3d4e5f6",
        "metaType": "widget",
        "_image": [
          {}
        ],
        "caption": "Example caption",
        "linkTo": "none",
        "_apostrophecms-any-page-type": [
          {}
        ],
        "linkHref": "https://acme.example/example",
        "linkHrefTitle": "Example link href title",
        "linkTitle": "Example link title",
        "linkTarget": [
          "_blank"
        ],
        "sectionCss": {
          "slots": {},
          "css": "Example css",
          "mark": "Example mark"
        }
      }
    ]
  },
  "_folder": [
    {}
  ],
  "slug": "example-slug",
  "visibility": "public",
  "scheduledPublish": "Example scheduled publish",
  "scheduledUnpublish": "Example scheduled unpublish",
  "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

Call it from the terminal

Find the id

Behavior

Test it

List a video’s locales

List videos

Create a video

Get a video

Replace a video

Delete a video

POST /video/{_id}/revert-draft-to-published

In your app

Call it from the terminal

Find the id

Behavior

Test it

Related

List a video’s locales

List videos

Create a video

Get a video

Replace a video

Delete a video

POST /video/{_id}/revert-draft-to-published