Images

Update a library image

Updates image metadata. Passing products replaces the image's product listings wholesale (an empty array clears them); omit it to leave them untouched.

patch/api/v1/images/{id}

Request

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

Path parameters

idstring required

image ID

Request body

access'public' | 'private' | 'unlisted'

Visibility; defaults to "public"

descriptionstring nullable
titlestring

Image title (max 255 chars); required on create

source'social_media' | 'aigc' | 'api'

Where the image came from; defaults to "api"

localestring
hashtagsstring[]
published_atstring date-time nullable

ISO 8601 publish time. A future time schedules the image (capped at 28 days). Pass null (or omit) to create an unpublished draft.

badge'ad' nullable
folder_idstring

Folder to place the image in (null/omit = unfiled)

Response

Updated image

accessstring

Visibility: "public", "private" or "unlisted"

idstring
formatstring
descriptionstring nullable
titlestring
widthinteger nullable
sourcestring

social_media, aigc or api

urlstring nullable

Full-resolution CDN URL of the original file.

localestring nullable
hashtagsstring[]
published_atstring date-time nullable

When the image is/was published; null for a draft. A future value is scheduled.

file_sizeinteger nullable
updated_atstring date-time
created_atstring date-time
heightinteger nullable
badgestring nullable

e.g. "ad"

archived_atstring date-time nullable
is_publishedboolean

Whether the image is currently published (published_at set and not in the future); evaluated at request time.

blur_hashstring nullable
folder_idstring nullable

Changes

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