Image Folders

Create an image folder

Creates a folder at the library root, or under parent_folder_id. Requires the images feature.

post/api/v1/image_folders

Request

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

Request body

namestring required

Folder name (max 255 chars)

parent_folder_idstring

Parent folder ID; omit for a root-level folder

Response

Created 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.