Create a file folder

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

const site = createSiteClient();
const fileFolder = await site.fileFolders().createFileFolder({ title: 'Example title', visibility: 'public' });

{
  "title": "Example title",
  "_parent": [
    {}
  ],
  "referenceOnly": false,
  "slug": "example-slug",
  "visibility": "public",
  "archived": false,
  "folderPath": "Example folder path",
  "folderParentId": "clx8m2k4p0000a1b2c3d4e5f6",
  "slugSegment": "Example slug segment",
  "level": 0,
  "_id": "clx8m2k4p0000a1b2c3d4e5f6",
  "type": "Example type",
  "createdAt": "2026-10-24T09:30:00.000Z",
  "updatedAt": "2026-10-24T09:30:00.000Z"
}

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

const site = createSiteClient();
const fileFolder = await site.fileFolders().createFileFolder({ title: 'Example title', visibility: 'public' });

{
  "title": "Example title",
  "_parent": [
    {}
  ],
  "referenceOnly": false,
  "slug": "example-slug",
  "visibility": "public",
  "archived": false,
  "folderPath": "Example folder path",
  "folderParentId": "clx8m2k4p0000a1b2c3d4e5f6",
  "slugSegment": "Example slug segment",
  "level": 0,
  "_id": "clx8m2k4p0000a1b2c3d4e5f6",
  "type": "Example type",
  "createdAt": "2026-10-24T09:30:00.000Z",
  "updatedAt": "2026-10-24T09:30:00.000Z"
}

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/create-file-folder.ts

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

export async function createFileFolder(site: SiteClient) {
  return site.fileFolders().createFileFolder({ title: 'Example title', visibility: 'public' });
}

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

Call it

A script makes the client once and calls the function:

scripts/create-file-folder.ts

import { createSiteClient } from '@fetchski/attract-cms-sdk';
import { createFileFolder } from '../src/attract/create-file-folder.ts';

const site = createSiteClient();
console.log(await createFileFolder(site));

Terminal

node --env-file=.env scripts/create-file-folder.ts

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

Required parameters

One object, e.g. createFileFolder({ title }); leave out the optional fields.

string

required

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

Visibility

required

Required. Select whether this content is public or private. One of public, loginRequired.

Optional parameters

readonly Readonly<Record<string, unknown>>[] | null | undefined

Optional. The related file-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 | undefined

Optional. Leave it out and the site uses false. Media in this folder (and every folder inside it) are kept for comparison only: you can browse them here, but they can never be used on the site.

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.

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.

string | null | undefined

Optional. Leave it out and the site uses "". Its place in the tree: each folder’s URL name from the top, joined by / (albums/summer). Set by the site from _parent and title; a value sent is ignored.

string | null | undefined

Optional. Leave it out and the site uses "". The parent folder’s id, empty at the top. Set by the site from _parent; a value sent is ignored.

string | null | undefined

Optional. Leave it out and the site uses "". Its own part of folderPath, made from its title. Set by the site; a value sent is ignored.

number | null | undefined

Optional. Leave it out and the site uses 0. How deep it sits: 0 at the top. Set by the site from _parent; a value sent is ignored.

Returns

A FileFolder. FileFolder content type. Read its properties (fileFolder.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, _parent → parent).

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

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.

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.

Date

Always sent. When it was created (ISO 8601). Format: an ISO 8601 date and time.

Date

Always sent. When it last changed (ISO 8601). Format: an ISO 8601 date and time.

readonly Readonly<Record<string, unknown>>[] | null

Sometimes sent: undefined when the site leaves it out, and it can be null. The related file-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. Media in this folder (and every folder inside it) are kept for comparison only: you can browse them here, but they can never be used on the site.

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.

string | null

Sometimes sent: undefined when the site leaves it out, and it can be null. Its place in the tree: each folder’s URL name from the top, joined by / (albums/summer). Set by the site from _parent and title; a value sent is ignored.

string | null

Sometimes sent: undefined when the site leaves it out, and it can be null. The parent folder’s id, empty at the top. Set by the site from _parent; a value sent is ignored.

string | null

Sometimes sent: undefined when the site leaves it out, and it can be null. Its own part of folderPath, made from its title. Set by the site; a value sent is ignored.

number | null

Sometimes sent: undefined when the site leaves it out, and it can be null. How deep it sits: 0 at the top. Set by the site from _parent; a value sent is ignored.

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:files:write (or a master above it: content:files: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/fileFolders-createFileFolder.test.ts

import { test } from 'node:test';
import { fakeSite } from '@fetchski/attract-cms-sdk/testing';
import { createFileFolder } from '../src/attract/create-file-folder.ts';

test('fileFolders.createFileFolder', async () => {
  const site = fakeSite();
  await createFileFolder(site);
  site.assertCalled('fileFolders.createFileFolder');
});

Answer with your own values: fake fileFolders.createFileFolder with factories.FileFolder({...}), the fields you give over a valid example.

tests/fileFolders-createFileFolder-answer.test.ts

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

test('fileFolders.createFileFolder answers your values', async () => {
  const site = fakeSite({
    'fileFolders.createFileFolder': factories.FileFolder({ title: 'Your value' })
  });
  const fileFolder = await site.fileFolders().createFileFolder({ title: 'Example title', visibility: 'public' });
  assert.equal(fileFolder.title, 'Your value');
});

Get the file folder tree

site.fileFolders().getFileFolderTree()

List file folders

site.fileFolders().listFileFolders()

Get a file folder

site.fileFolders().getFileFolder()

Replace a file folder

site.fileFolders().replaceFileFolder()

Delete a file folder

site.fileFolders().deleteFileFolder()

Update a file folder

site.fileFolders().updateFileFolder()

POST /file-folder

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 fileFolder = await site.fileFolders().createFileFolder({ title: 'Example title', visibility: 'public' });

{
  "title": "Example title",
  "_parent": [
    {}
  ],
  "referenceOnly": false,
  "slug": "example-slug",
  "visibility": "public",
  "archived": false,
  "folderPath": "Example folder path",
  "folderParentId": "clx8m2k4p0000a1b2c3d4e5f6",
  "slugSegment": "Example slug segment",
  "level": 0,
  "_id": "clx8m2k4p0000a1b2c3d4e5f6",
  "type": "Example type",
  "createdAt": "2026-10-24T09:30:00.000Z",
  "updatedAt": "2026-10-24T09:30:00.000Z"
}

Get started

Using the SDK

Going further

Pages & Site

Content

Media

Forms

Ads & Conversions

Analytics

In your app

Behavior

Test it

Get the file folder tree

List file folders

Get a file folder

Replace a file folder

Delete a file folder

Update a file folder

POST /file-folder

In your app

Behavior

Test it

Related

Get the file folder tree

List file folders

Get a file folder

Replace a file folder

Delete a file folder

Update a file folder

POST /file-folder