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

# Replace a video

> Replaces the whole document: every field left out is reset to its default.

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

const site = createSiteClient();
const video = await site.videos().replaceVideo({ id: 'clx8m2k4p0000a1b2c3d4e5f6', title: 'Example title', video: {}, visibility: 'public' });
```

```json 200 wrap theme={"dark"}
{
  "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": {
            "key": "Example value"
          },
          "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 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/replace-video.ts theme={"dark"}
import type { SiteClient } from '@fetchski/attract-cms-sdk';

export async function replaceVideo(site: SiteClient, id: string) {
  return site.videos().replaceVideo({ id, title: 'Example title', video: {}, visibility: 'public' });
}
```

The other values are the example’s: take yours from the request, a form or your database.

**2. Call it**

A script makes the client once and calls the function:

```ts scripts/replace-video.ts theme={"dark"}
import { createSiteClient } from '@fetchski/attract-cms-sdk';
import { replaceVideo } from '../src/attract/replace-video.ts';

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

```bash Terminal theme={"dark"}
node --env-file=.env scripts/replace-video.ts
```

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

PATCH changes only the fields sent. Update an existing video.

## 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.videos().listVideosPick(['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. `replaceVideo({ 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`).
>
> **title** `string` *required*
>
> **Required.** Its title: the name it goes by in every list, and the heading of its page where it has one.
>
> **video** `Readonly\<Record\<string, unknown\>\>` *required*
>
> **Required.** mp4 or webm. For background loops keep it short, muted, and ideally under \~10 MB.
>
> **visibility** `Visibility` *required*
>
> **Required.** Select whether this content is public or private. One of `public`, `loginRequired`.

> [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).
>
> **poster** `ImageArea | null | undefined`
>
> **Optional.** Leave it out (or pass `null`) and it isn’t sent: the site’s default applies. 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.
>
> **ImageArea**
>
> Widgets, top to bottom: send `{ "items": [ … ] }`, one object per widget with its `type`. Writing it replaces the whole area.
>
> **metaType** `AfterContentAreaMetaType`
>
> Always `area`. One of `area`.
>
> **id** `string`
>
> The area’s id, set by the site: leave it out when you write one.
>
> **items** `readonly ImageWidget[]`
>
> 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.
>
> **ImageWidget**
>
> A `@apostrophecms/image` widget: its `type` and its own fields. A field left out takes its default.
>
> **type** `ImageWidgetType` *required*
>
> **Required.** The widget’s type: always `@apostrophecms/image`. One of `@apostrophecms/image`.
>
> **id** `string`
>
> 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.
>
> **metaType** `MetaType`
>
> Always `widget`. One of `widget`.
>
> **image** `readonly Readonly\<Record\<string, unknown\>\>[]`
>
> 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.
>
> **caption** `string`
>
> Caption.
>
> **linkTo** `LinkTo | null`
>
> Link To... One of `none`, `@apostrophecms/any-page-type`, `_url`.
>
> **apostrophecmsAnyPageType** `readonly Readonly\<Record\<string, unknown\>\>[]`
>
> 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.
>
> **linkHref** `string | null`
>
> apostrophe:linkHrefHelp When set, a URL; empty or null when not.
>
> **linkHrefTitle** `string`
>
> Link Title.
>
> **linkTitle** `string`
>
> If empty, the title of the related document will be used.
>
> **linkTarget** `readonly LinkTarget[] | null`
>
> Link Target. Each one of `_blank`.
>
> **sectionCss** `CustomCSS | null`
>
> 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.
>
> **CustomCSS**
>
> **slots** `Readonly\<Record\<string, string\>\>`
>
> The CSS typed into each part slot, by slot name.
>
> **css** `string`
>
> The compiled CSS (read only: rebuilt from `slots`).
>
> **mark** `string`
>
> The site’s check mark for `css` (read only).
>
> **fields** `Readonly\<Record\<string, unknown\>\>`
>
> Optional: any keys not listed above, by their wire names; they are sent with the rest.
>
> **fields** `Readonly\<Record\<string, unknown\>\>`
>
> Optional: any keys not listed above, by their wire names; they are sent with the rest.
>
> **folder** `readonly Readonly\<Record\<string, unknown\>\>[] | null | undefined`
>
> **Optional.** 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. At most 1 items.
>
> **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). Left out, it’s made from the title.
>
> **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`.
>
> **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 `Video`. 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` …).
>
> **title** `string`
>
> **Always sent.** Its title: the name it goes by in every list, and the heading of its page where it has one.
>
> **video** `Readonly\<Record\<string, unknown\>\>`
>
> **Always sent.** mp4 or webm. For background loops keep it short, muted, and ideally under \~10 MB.
>
> **slug** `string`
>
> **Always sent.** The URL name: lowercase words joined by hyphens (letters outside a–z, even emoji, are kept).
>
> **visibility** `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.
>
> **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.
>
> **createdAt** `Date`
>
> **Always sent.** When it was created (ISO 8601). Format: an ISO 8601 date and time.
>
> **updatedAt** `Date`
>
> **Always sent.** When it last changed (ISO 8601). Format: an ISO 8601 date and time.
>
> **poster** `ImageArea`
>
> **Sometimes sent:** `undefined` 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.
>
> **ImageArea**
>
> Widgets, top to bottom: send `{ "items": [ … ] }`, one object per widget with its `type`. Writing it replaces the whole area.
>
> **metaType** `AfterContentAreaMetaType`
>
> **Sometimes sent:** `undefined` when the site leaves it out. Always `area`. One of `area`; a newer site may send others, so keep a fallback.
>
> **id** `string`
>
> **Sometimes sent:** `undefined` when the site leaves it out. The area’s id, set by the site: leave it out when you write one.
>
> **items** `readonly ImageWidget[]`
>
> **Sometimes sent:** `undefined` 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.
>
> **ImageWidget**
>
> A `@apostrophecms/image` widget: its `type` and its own fields. A field left out takes its default.
>
> **type** `ImageWidgetType`
>
> **Always sent.** The widget’s type: always `@apostrophecms/image`. One of `@apostrophecms/image`; a newer site may send others, so keep a fallback.
>
> **id** `string`
>
> **Sometimes sent:** `undefined` 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.
>
> **metaType** `MetaType`
>
> **Sometimes sent:** `undefined` when the site leaves it out. Always `widget`. One of `widget`; a newer site may send others, so keep a fallback.
>
> **image** `readonly Readonly\<Record\<string, unknown\>\>[]`
>
> **Sometimes sent:** `undefined` 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.
>
> **caption** `string`
>
> **Sometimes sent:** `undefined` when the site leaves it out. Caption.
>
> **linkTo** `LinkTo | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Link To... One of `none`, `@apostrophecms/any-page-type`, `_url`; a newer site may send others, so keep a fallback.
>
> **apostrophecmsAnyPageType** `readonly Readonly\<Record\<string, unknown\>\>[]`
>
> **Sometimes sent:** `undefined` 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.
>
> **linkHref** `string | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. apostrophe:linkHrefHelp When set, a URL; empty or null when not.
>
> **linkHrefTitle** `string`
>
> **Sometimes sent:** `undefined` when the site leaves it out. Link Title.
>
> **linkTitle** `string`
>
> **Sometimes sent:** `undefined` when the site leaves it out. If empty, the title of the related document will be used.
>
> **linkTarget** `readonly LinkTarget[] | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Link Target. Each one of `_blank`.
>
> **sectionCss** `CustomCSS | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. 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.
>
> **CustomCSS**
>
> **slots** `Readonly\<Record\<string, string\>\>`
>
> **Sometimes sent:** `undefined` when the site leaves it out. The CSS typed into each part slot, by slot name.
>
> **css** `string`
>
> **Sometimes sent:** `undefined` when the site leaves it out. The compiled CSS (read only: rebuilt from `slots`).
>
> **mark** `string`
>
> **Sometimes sent:** `undefined` when the site leaves it out. The site’s check mark for `css` (read only).
>
> **fields** `Readonly\<Record\<string, unknown\>\>`
>
> **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.
>
> **fields** `Readonly\<Record\<string, unknown\>\>`
>
> **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.
>
> **folder** `readonly Readonly\<Record\<string, unknown\>\>[] | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. 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. At most 1 items.
>
> **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`.
>
> **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.
>
> **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:videos:write` (or a master above it: `content:videos:all`, `content:all`, `admin:all`). In published mode (the default) it goes live too, so the key also needs `content:videos: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/videos-replaceVideo.test.ts theme={"dark"}
import { test } from 'node:test';
import { fakeSite } from '@fetchski/attract-cms-sdk/testing';
import { replaceVideo } from '../src/attract/replace-video.ts';

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

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

```ts tests/videos-replaceVideo-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('videos.replaceVideo answers your values', async () => {
  const site = fakeSite({
    'videos.replaceVideo': factories.Video({ title: 'Your value' })
  });
  const video = await site.videos().replaceVideo({ id: 'clx8m2k4p0000a1b2c3d4e5f6', title: 'Example title', video: {}, visibility: 'public' });
  assert.equal(video.title, 'Your value');
});
```

## Related

> [card] [List a video’s locales](https://docs.fetchski-attract.com/typescript/reference/videos/get-video-locales.md)
>
> `site.videos().getVideoLocales()`

> [card] [List videos](https://docs.fetchski-attract.com/typescript/reference/videos/list-videos.md)
>
> `site.videos().listVideos()`

> [card] [Create a video](https://docs.fetchski-attract.com/typescript/reference/videos/create-video.md)
>
> `site.videos().createVideo()`

> [card] [Get a video](https://docs.fetchski-attract.com/typescript/reference/videos/get-video.md)
>
> `site.videos().getVideo()`

> [card] [Delete a video](https://docs.fetchski-attract.com/typescript/reference/videos/delete-video.md)
>
> `site.videos().deleteVideo()`

> [card] [Update a video](https://docs.fetchski-attract.com/typescript/reference/videos/update-video.md)
>
> `site.videos().updateVideo()`

> [card] [PUT /video/\{\_id}](https://docs.fetchski-attract.com/api-reference/videos/replace-a-video.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.