PATCH /folder/{folderId} — update folder settings

Use this endpoint to modify an existing folder. You can rename it, change its access level between public and private, add projects to it, or remove projects from it — all in a single request. At least one body field must be provided; all fields are optional individually.

Endpoint

PATCH https://api.bugsmash.io/api/v2/folder/{folderId}

Request

Path parameters

uuid

required

The UUID of the folder to update.

Headers

string

required

Your Bugsmash API key.

string

required

Must be application/json.

Body parameters

All body fields are optional, but at least one must be provided.

string

New display name for the folder.

string

Access level for the folder. Accepted values: public or private.

string[]

Array of project UUIDs to add to the folder.

string[]

Array of project UUIDs to remove from the folder.

Example request

curl --location --request PATCH 'https://api.bugsmash.io/api/v2/folder/{folderId}' \
--header 'X-API-Key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
  "name": "Updated Folder Name",
  "addProjectIds": ["{projectId3}"]
}'

Response

{
  "status": true,
  "message": "Folder updated",
  "data": {
    "id": "e5f6a7b8-c9d0-1234-efab-234567890124",
    "parent_id": null,
    "owner": "b2c3d4e5-f6a7-8901-bcde-f01234567891",
    "workspace_id": "c3d4e5f6-a7b8-9012-cdef-012345678902",
    "name": "Updated Folder Name",
    "created_at": "2026-04-06T15:34:31.000000Z",
    "updated_at": "2026-04-06T15:46:24.000000Z",
    "deleted_at": null,
    "created_by": "b2c3d4e5-f6a7-8901-bcde-f01234567891",
    "updated_by": "b2c3d4e5-f6a7-8901-bcde-f01234567891",
    "deleted_by": null,
    "share_access": "private"
  }
}

Response fields

boolean

true when the folder was updated successfully.

string

Human-readable status message.

object

The updated folder object.

Show properties

string

UUID of the folder.

string

Current display name of the folder.

string

UUID of the workspace this folder belongs to.

string

UUID of the user who owns the folder.

string

UUID of the parent folder. null if this is a top-level folder.

Current access level of the folder: public or private.

string

UUID of the user who originally created the folder.

string

UUID of the user who made the most recent update.

string

UUID of the user who deleted the folder. null when the folder is active.

string

ISO 8601 timestamp of when the folder was created.

string

ISO 8601 timestamp of the most recent update.

string

ISO 8601 timestamp of when the folder was deleted. null when the folder is active.

Folders

Versions

Projects

Comments

Webhooks

PATCH /folder/{folderId} — update folder settings

Endpoint

Request

Path parameters

Headers

Body parameters

Example request

Response

Response fields

​Endpoint

​Request

​Path parameters

​Headers

​Body parameters

​Example request

​Response

​Response fields

Endpoint

Request

Path parameters

Headers

Body parameters

Example request

Response

Response fields