Image Folders

Rename or move an image folder

Renames the folder and/or moves it under a new parent_folder_id (pass null to move it to the root). Cycles and depth-limit violations return 422.

patch/api/v1/image_folders/{id}

Request

  • Base URL: https://api.firework.com
  • URL: https://api.firework.com/api/v1/image_folders/{id}
  • Auth: OAuth 2 (client credentials, token URL /oauth/token, scopes: images:write)

Path parameters

idstring required

folder ID

Request body

namestring
parent_folder_idstring nullable

New parent folder ID; null moves the folder to the root

Response

Updated folder

idstring
namestring
updated_atstring date-time
created_atstring date-time
archived_atstring date-time nullable
parent_folder_idstring nullable
has_subfoldersboolean

Whether the folder has any child folders (derived per-request in listings)

has_imagesboolean

Whether the folder holds any images (derived per-request in listings)

Changes

No recorded changes to this operation across all 1 revision of this API.