Update folder
curl --request PATCH \
--url https://your-syteca-host/SytecaACB/api/folders/{id} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"parent_folder_id": 1,
"parent_folder_name": "<string>",
"permissions": {
"inherit_users_and_roles": false,
"inherit_features": false,
"users": [
{
"name": "<string>",
"features": []
}
],
"user_groups": [
{
"name": "<string>",
"features": []
}
]
}
}
'import requests
url = "https://your-syteca-host/SytecaACB/api/folders/{id}"
payload = {
"name": "<string>",
"description": "<string>",
"parent_folder_id": 1,
"parent_folder_name": "<string>",
"permissions": {
"inherit_users_and_roles": False,
"inherit_features": False,
"users": [
{
"name": "<string>",
"features": []
}
],
"user_groups": [
{
"name": "<string>",
"features": []
}
]
}
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
parent_folder_id: 1,
parent_folder_name: '<string>',
permissions: {
inherit_users_and_roles: false,
inherit_features: false,
users: [{name: '<string>', features: []}],
user_groups: [{name: '<string>', features: []}]
}
})
};
fetch('https://your-syteca-host/SytecaACB/api/folders/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://your-syteca-host/SytecaACB/api/folders/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'description' => '<string>',
'parent_folder_id' => 1,
'parent_folder_name' => '<string>',
'permissions' => [
'inherit_users_and_roles' => false,
'inherit_features' => false,
'users' => [
[
'name' => '<string>',
'features' => [
]
]
],
'user_groups' => [
[
'name' => '<string>',
'features' => [
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://your-syteca-host/SytecaACB/api/folders/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"parent_folder_id\": 1,\n \"parent_folder_name\": \"<string>\",\n \"permissions\": {\n \"inherit_users_and_roles\": false,\n \"inherit_features\": false,\n \"users\": [\n {\n \"name\": \"<string>\",\n \"features\": []\n }\n ],\n \"user_groups\": [\n {\n \"name\": \"<string>\",\n \"features\": []\n }\n ]\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://your-syteca-host/SytecaACB/api/folders/{id}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"parent_folder_id\": 1,\n \"parent_folder_name\": \"<string>\",\n \"permissions\": {\n \"inherit_users_and_roles\": false,\n \"inherit_features\": false,\n \"users\": [\n {\n \"name\": \"<string>\",\n \"features\": []\n }\n ],\n \"user_groups\": [\n {\n \"name\": \"<string>\",\n \"features\": []\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://your-syteca-host/SytecaACB/api/folders/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"parent_folder_id\": 1,\n \"parent_folder_name\": \"<string>\",\n \"permissions\": {\n \"inherit_users_and_roles\": false,\n \"inherit_features\": false,\n \"users\": [\n {\n \"name\": \"<string>\",\n \"features\": []\n }\n ],\n \"user_groups\": [\n {\n \"name\": \"<string>\",\n \"features\": []\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"name": "<string>",
"description": "<string>",
"parent_folder_id": 123,
"permissions": {
"inherit_users_and_roles": false,
"inherit_features": false,
"users": [
{
"name": "<string>",
"features": []
}
],
"user_groups": [
{
"name": "<string>",
"features": []
}
]
}
}{
"status": 123,
"message": "<string>"
}{
"status": 123,
"message": "<string>"
}{
"status": 123,
"message": "<string>"
}Endpoints
Update Folder
Syteca ACB REST API endpoint to update a folder’s name, description, parent, or permissions. Partial update — only the fields provided are changed.
PATCH
/
api
/
folders
/
{id}
Update folder
curl --request PATCH \
--url https://your-syteca-host/SytecaACB/api/folders/{id} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"parent_folder_id": 1,
"parent_folder_name": "<string>",
"permissions": {
"inherit_users_and_roles": false,
"inherit_features": false,
"users": [
{
"name": "<string>",
"features": []
}
],
"user_groups": [
{
"name": "<string>",
"features": []
}
]
}
}
'import requests
url = "https://your-syteca-host/SytecaACB/api/folders/{id}"
payload = {
"name": "<string>",
"description": "<string>",
"parent_folder_id": 1,
"parent_folder_name": "<string>",
"permissions": {
"inherit_users_and_roles": False,
"inherit_features": False,
"users": [
{
"name": "<string>",
"features": []
}
],
"user_groups": [
{
"name": "<string>",
"features": []
}
]
}
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
parent_folder_id: 1,
parent_folder_name: '<string>',
permissions: {
inherit_users_and_roles: false,
inherit_features: false,
users: [{name: '<string>', features: []}],
user_groups: [{name: '<string>', features: []}]
}
})
};
fetch('https://your-syteca-host/SytecaACB/api/folders/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://your-syteca-host/SytecaACB/api/folders/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'description' => '<string>',
'parent_folder_id' => 1,
'parent_folder_name' => '<string>',
'permissions' => [
'inherit_users_and_roles' => false,
'inherit_features' => false,
'users' => [
[
'name' => '<string>',
'features' => [
]
]
],
'user_groups' => [
[
'name' => '<string>',
'features' => [
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://your-syteca-host/SytecaACB/api/folders/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"parent_folder_id\": 1,\n \"parent_folder_name\": \"<string>\",\n \"permissions\": {\n \"inherit_users_and_roles\": false,\n \"inherit_features\": false,\n \"users\": [\n {\n \"name\": \"<string>\",\n \"features\": []\n }\n ],\n \"user_groups\": [\n {\n \"name\": \"<string>\",\n \"features\": []\n }\n ]\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://your-syteca-host/SytecaACB/api/folders/{id}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"parent_folder_id\": 1,\n \"parent_folder_name\": \"<string>\",\n \"permissions\": {\n \"inherit_users_and_roles\": false,\n \"inherit_features\": false,\n \"users\": [\n {\n \"name\": \"<string>\",\n \"features\": []\n }\n ],\n \"user_groups\": [\n {\n \"name\": \"<string>\",\n \"features\": []\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://your-syteca-host/SytecaACB/api/folders/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"parent_folder_id\": 1,\n \"parent_folder_name\": \"<string>\",\n \"permissions\": {\n \"inherit_users_and_roles\": false,\n \"inherit_features\": false,\n \"users\": [\n {\n \"name\": \"<string>\",\n \"features\": []\n }\n ],\n \"user_groups\": [\n {\n \"name\": \"<string>\",\n \"features\": []\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"name": "<string>",
"description": "<string>",
"parent_folder_id": 123,
"permissions": {
"inherit_users_and_roles": false,
"inherit_features": false,
"users": [
{
"name": "<string>",
"features": []
}
],
"user_groups": [
{
"name": "<string>",
"features": []
}
]
}
}{
"status": 123,
"message": "<string>"
}{
"status": 123,
"message": "<string>"
}{
"status": 123,
"message": "<string>"
}Updates a folder. This is a partial update (PATCH semantics) — only fields included in the request body are changed; omitted fields are left unchanged.
For ACB deployments updated from a version prior to 1.2, switch to the
https://{hostname}/EkranACB server in the Playground.Permissions required
- Editor or Owner role on the folder for most field changes.
- Owner role required to modify the
permissionsfield.
Errors
See Status codes. Common errors:- 403 Forbidden — user lacks Editor/Owner role (or lacks Owner when modifying permissions).
- 404 Not Found — folder doesn’t exist.
- 409 Conflict — renaming to a name that already exists in the parent.
Related
Get folder
Read current folder state.
Add folder
Create a new folder.
Delete folder
Remove a folder.
Data models
FolderResponseDto schema.
Authorizations
Access token for authentication
Path Parameters
The ID of the folder to update
Required range:
x >= 1Body
application/json
Name of the folder
Maximum string length:
512Description of the folder
Maximum string length:
2000ID of the parent folder
Required range:
x >= 0Name of the parent folder
Maximum string length:
512Show child attributes
Show child attributes
⌘I