Image Folders

Archive an image folder (cosmetic; contents untouched)

post/api/v1/image_folders/{id}/archive

Request

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

Path parameters

idstring required

folder ID

Response

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