---
title: "Sync Folder"
method: POST
path: "/folders/sync-folder"
tags: ["Folders"]
---

# Sync Folder

`POST /folders/sync-folder`

Sync a folder by comparing filesystem folders with database entries and removing extra DB entries.

## Request body

- SyncFolderRequest
  - `folder_path` string, required
  - `folder_id` string, required

## Response `200`

Successful Response

- SyncFolderResponse
  - `success` boolean, required
  - `message` string, nullable
  - `error` string, nullable
  - `data` SyncFolderData
    - `deleted_count` integer, required
    - `deleted_folders` string[], required
    - `added_count` integer, required
    - `added_folders` string[], required
    - `folder_id` string, required
    - `folder_path` string, required

## Other responses

- `400` — Bad Request
- `404` — Not Found
- `422` — Validation Error
- `500` — Internal Server Error

## Changes

- **2025-08-26** `2e78324b9970` — 18 breaking, 2 info
  - the response property `error` became optional for the status `400`
  - the response property `error` became optional for the status `404`
  - the response property `error` became optional for the status `500`
  - the response property `message` became optional for the status `200`
  - …16 more
- **2025-08-05** `0f7598fc167b` — 1 info
  - endpoint added
- **2025-08-05** `14c08755eaeb` — 1 breaking
  - api path removed without deprecation

[Change history](https://skmtc.dev/aossie-org/apis/pictopy/changes/folders/sync-folder/post.md)

---

[API](https://skmtc.dev/aossie-org/apis/pictopy.md) · [All operations](https://skmtc.dev/aossie-org/apis/pictopy/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/aossie-org/pictopy/revisions/a6c11e6b42e4/schema)