Skip to main content
PATCH
Update a Semantic Layer folder
Changes name, description, icon, or hidden. A new name must still be unique among the folder’s siblings, or the request answers 400.
A personal API token needs what its creator needs: on Growth and Custom, editor on the folder (owners and admins always have it); on Free and Starter, any member may. A service account needs the Write the Semantic Layer capability and the folder in its scope. A folder the key cannot see answers 404, not 403: an id you cannot read is indistinguishable from one that does not exist.
parent is read-only here, so a folder cannot be moved with this endpoint. Moving and reordering folders is done in the app.

Replace a folder

PUT /api/v1/semantic-layer/folders/{id}/ applies the same rules as PATCH, with name required in the body.

Authorizations

x-api-key
string
header
required

API Key authentication. Format: 'x-api-key: api_key'

Path Parameters

id
string<uuid>
required

A UUID string identifying this Semantic Layer Folder.

Body

name
string
Maximum string length: 256
description
string | null
icon
string | null
Maximum string length: 256
hidden
boolean

Frontend-only: hides the folder from the tree, still reachable in the details view. The backend does not filter on it, except in the pins listing.

parent
string<uuid> | null

Parent folder. Omit or send null to create at the root.

Response

200 - application/json
id
string<uuid>
required
read-only
name
string
required
Maximum string length: 256
slug
string
required
read-only
order
integer | null
required
read-only
created_by
integer | null
required
read-only
created_at
string<date-time>
required
read-only
updated_at
string<date-time>
required
read-only
description
string | null
icon
string | null
Maximum string length: 256
hidden
boolean

Frontend-only: hides the folder from the tree, still reachable in the details view. The backend does not filter on it, except in the pins listing.

parent
string<uuid> | null

Parent folder. Omit or send null to create at the root.