Update an image
https://email.growthdept.ai/api/images/{id}Renames an image or hides it from the library (hidden images keep working in emails that use them).
The request body can be up to 5 MB.
Rate limits
Scopes
images:write
Operation id
update_image The same operation as in Klaviyo's API. OpenAPI document
Path parameters
stringrequired
Query parameters
Pick values to add them to the request:
Body
Send application/vnd.api+json or application/json.
object
dataobjectrequired
data: 5 fields
typestringrequired
imageidstringrequired
attributesobjectrequired
attributes: 2 fields
namestringcan be null
hiddenbooleancan be null
relationshipsobject
metaobject
Edit the example. The code samples use what you type here.
Headers
stringrequireddefault 2026-10-15
API revision, YYYY-MM-DD. This server implements 2026-10-15.
Responses
200Success
Response body
object
dataobjectrequired
data: 4 fields
typestringrequired
imageidstringrequired
attributesobjectrequired
attributes: 6 fields
namestringrequired
image_urlstringrequired
formatstringrequired
sizeintegerrequired
hiddenbooleanrequired
updated_atstring (date-time)required
linksobjectrequired
links: 1 field
selfstring (uri)required
linksobject
links: 1 field
selfstring (uri)required
metaobject
4XXClient error
Response body
object
errorsarray of objectsrequired
errors: 8 fields
idstringrequired
statusintegerrequired
codestringrequired
titlestringrequired
detailstringrequired
sourceobject
source: 2 fields
pointerstring
parameterstring
linksobject
metaobject
See status codes for each code.
5XXServer error
Response body
object
errorsarray of objectsrequired
errors: 8 fields
idstringrequired
statusintegerrequired
codestringrequired
titlestringrequired
detailstringrequired
sourceobject
source: 2 fields
pointerstring
parameterstring
linksobject
metaobject