File Folders

Replace a file folder

Replaces the whole document: every field left out is reset to its default. PATCH changes only the fields sent. Update an existing file folder.

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.

PUT

file-folder

{_id}

cURL

curl --request PUT \
  --url https://{host}/api/v1/file-folder/{_id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "",
  "slug": "",
  "visibility": "public"
}
'

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

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

{
  "title": "",
  "slug": "",
  "visibility": "public",
  "_id": "<string>",
  "type": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "_parent": [
    {}
  ],
  "referenceOnly": false,
  "archived": false,
  "folderPath": "",
  "folderParentId": "",
  "slugSegment": "",
  "level": 0
}

{
  "name": "<string>",
  "message": "<string>",
  "data": {}
}

{
  "name": "<string>",
  "message": "<string>",
  "data": {}
}

{
  "name": "<string>",
  "message": "<string>",
  "data": {}
}

{
  "name": "<string>",
  "message": "<string>",
  "data": {}
}

{
  "name": "<string>",
  "message": "<string>",
  "data": {}
}

Authorizations

Authorization

string

header

required

Paste your API key as the CMS showed it: fsk_<site>_<key id>_<secret> (issued under API Keys). ApiKey in front of it works too. Leave it empty to read as the public.

Scopes

content:files:write

Path Parameters

_id

string

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

Body

application/json

FileFolder content type

title

string

default:""

required

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

slug

string

default:""

required

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

visibility

enum<string>

default:public

required

Select whether this content is public or private

Available options:

public,

loginRequired

_parent

Parent folder · object[] | 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.

Maximum array length: 1

referenceOnly

boolean | null

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

archived

boolean | null

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

folderPath

string | null

default:""

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.

folderParentId

string | null

default:""

The parent folder’s id, empty at the top. Set by the site from _parent; a value sent is ignored.

slugSegment

string | null

default:""

Its own part of folderPath, made from its title. Set by the site; a value sent is ignored.

level

integer | null

default:0

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

Response

Success

FileFolder content type

title

string

default:""

required

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

slug

string

default:""

required

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

visibility

enum<string>

default:public

required

Select whether this content is public or private

Available options:

public,

loginRequired

_id

string

required

read-only

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

required

read-only

The document type’s name: always this type’s.

createdAt

string<date-time>

required

read-only

When it was created (ISO 8601).

updatedAt

string<date-time>

required

read-only

When it last changed (ISO 8601).

_parent

Parent folder · object[] | 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.

Maximum array length: 1

referenceOnly

boolean | null

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

archived

boolean | null

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

folderPath

string | null

default:""

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.

folderParentId

string | null

default:""

The parent folder’s id, empty at the top. Set by the site from _parent; a value sent is ignored.

slugSegment

string | null

default:""

Its own part of folderPath, made from its title. Set by the site; a value sent is ignored.

level

integer | null

default:0

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

cURL

curl --request PUT \
  --url https://{host}/api/v1/file-folder/{_id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "",
  "slug": "",
  "visibility": "public"
}
'

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

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

{
  "title": "",
  "slug": "",
  "visibility": "public",
  "_id": "<string>",
  "type": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "_parent": [
    {}
  ],
  "referenceOnly": false,
  "archived": false,
  "folderPath": "",
  "folderParentId": "",
  "slugSegment": "",
  "level": 0
}

{
  "name": "<string>",
  "message": "<string>",
  "data": {}
}

{
  "name": "<string>",
  "message": "<string>",
  "data": {}
}

{
  "name": "<string>",
  "message": "<string>",
  "data": {}
}

{
  "name": "<string>",
  "message": "<string>",
  "data": {}
}

{
  "name": "<string>",
  "message": "<string>",
  "data": {}
}

Get started

How the API works

Pages & Site

Content

Media

Forms

Ads & Conversions

Analytics

Signing in (people)

Replace a file folder

Authorizations

Scopes

Path Parameters

Body

Response