Partially update image

Update several fields of a image

PATCH /images/{imageId}

Partially update image

cURL

curl --request PATCH \
  --url https://api.kameleoon.com/images/{imageId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "baseColor": 123,
  "name": "<string>",
  "source": "<string>"
}
'

200

{
  "altText": "<string>",
  "baseColor": 123,
  "colorDepth": 123,
  "createdById": 123,
  "date": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "fileName": "<string>",
  "fileWeight": 123,
  "height": 123,
  "id": 123,
  "keywords": [
    "<string>"
  ],
  "name": "<string>",
  "path": "<string>",
  "shared": true,
  "siteId": 123,
  "size": 123,
  "source": "<string>",
  "sourceUrl": "<string>",
  "tags": [
    "<string>"
  ],
  "width": 123
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

imageId · integer<int64> · required

Body

application/json

baseColor · integer<int32>

name · string

Name of image

source · string

Response

200

*/*

OK

altText · string

baseColor · integer<int32>

Image base color

colorDepth · integer<int32>

createdById · integer<int64> · read-only

Account Id of the image uploader

date · string<date-time>

Date the image was uploaded

description · string

fileName · string

Image file name

fileWeight · integer<int64> · read-only

Image file size in KB

format · enum<string>

Image format (formats accepted: JPG, JPEG, PNG, GIF, WEBP, SVG, MVG)

Available options: PNG, JPEG, GIF, SVG, MVG, WEB

height · integer<int32>

Image height in pixels

id · integer<int64> · read-only

Unique Id of the image

keywords · string[]

Keyword(s) associated with the image

Keyword(s) associated with the image

name · string

Image name

path · string

Image path

shared · boolean

Indicates if the image has been shared

siteId · integer<int64>

Unique Id of the site your project is associated with

size · integer<int64> · read-only

Image size in bytes. Image file size should be maximum 5242880 bytes

source · string

Image source

sourceUrl · string

URL or the image source

tags · string[]

width · integer<int32>

Image width in pixels