PATCH /images/{id}

1 min

PATCH

https://api.cmp.optimizely.com/v3/images/{id}

Updates an image

Path Parameters

idstringrequired
Example
5d7f910551b00a722e0418830cee6631
Description
Unique identifier of the image

Body Parameters

bodyLibraryImageUpdateRequestrequired
Description
Payload to update the image
- titlestring
  Example
  cat.jpeg
  Description
  Title of the image
  Min Length
  1
- descriptionstring
  Example
  Image of a cute cat
  Description
  Description of the image. Set an empty string to clear the description.
  Min Length
  0
- alt_textstring
  Example
  Sample alt text
  Description
  Alt text of the image. Set an empty string to clear the alt text.
  Min Length
  0
- attribution_textstring
  Example
  Sample attribution text
  Description
  Attribution text of the image. Set an empty string to clear the attribution text.
  Min Length
  0
- tagsstring[]
  Example
```
[
  "dhaka",
  "new york",
  "london"
]
```
  Description
  Tags of the image. Provided tags will replace the existing ones. Set an empty array to clear the existing tags.
- is_publicboolean
  Example
  true
  Description
  Whether the image URL should be public
- is_archivedboolean
  Example
  true
  Description
  Whether the image should be archived
- allow_se_indexingboolean
  Example
  true
  Description
  Whether the image is allowed to be indexed by search engines
- folder_idstring
  Example
  6bb8db20a5b611ebae319b7c541b1a5a
  Description
  ID of the folder containing the image in the library
- expires_atstring<date-time>
  Example
  2019-10-07T13:15:30Z
  Description
  Date and time when the image expires, in ISO 8601 UTC format
  Format
  date-time
- labelsResourceLabelRequest[]
  Description
  Warning: Deprecated
  Please use PUT /assets/{asset_id}/fields or PUT /assets/{asset_id}/fields/{field_id} API to update label type asset fields
  - groupstringrequired
    Example
    2467e583a60e23fda2b89db81a453cd2
    Description
    Label group
    Min Length
    32
    Max Length
    32
  - valuesstring[]required
    Description
    List of values of the label
- focal_pointobject
  Example
```
{
  "x": 35,
  "y": 75
}
```
  Description
  Focal point of the image, used when cropping renditions. Coordinates are percentages of the image width and height, where {"x": 50, "y": 50} is the center of the image.
  - xintegerrequired
    Example
    35
    Description
    Horizontal position of the focal point as a percentage of the image width
    Minimum
    0
    Maximum
    100
  - yintegerrequired
    Example
    75
    Description
    Vertical position of the focal point as a percentage of the image height
    Minimum
    0
    Maximum
    100

Responses

200Updated Image

LibraryImage
- idstringrequired
  Example
  5d7f910551b00a722e0418830cee6632
  Description
  Unique identifier of the image
- titlestringrequired
  Example
  cat.jpeg
  Description
  Title of the image
- descriptionstringrequired
  Example
  Very important image
  Description
  Description of the image
- mime_typestringrequired
  Example
  image/jpeg
  Description
  MIME type of the image
- file_extensionstringrequired
  Example
  jpg
  Description
  File extension of the image file
- created_atstring<date-time>required
  Example
  2019-10-06T13:15:30Z
  Description
  Date and time on which the image was created, in ISO 8601 UTC format (2020-02-10T10:40
  )
  Format
  date-time
- modified_atstring<date-time>required
  Example
  2019-10-07T13:15:30Z
  Description
  Date and time of the most recent modification of the image, in ISO 8601 UTC format (2020-02-10T10:40
  )
  Format
  date-time
- file_sizeintegerrequired
  Example
  11244
  Description
  Size of the image in bytes
- image_resolutionobjectrequired
  Description
  Width and height of the image in pixels
  - heightintegerrequired
    Example
    800
    Description
    Height of the image in pixels
  - widthintegerrequired
    Example
    700
    Description
    Width of the image in pixels
- folder_idstringrequired
  Example
  6bb8db20a5b611ebae319b7c541b1a5a
  Description
  ID of the folder containing the image in the library
- file_locationstringrequired
  Example
  /images/
  Description
  Location of the folder containing the image in the library
- is_archivedbooleanrequired
  Example
  true
  Description
  Whether the image is archived or not
- is_publicbooleanrequired
  Example
  true
  Description
  Whether the image URL is public or not
- allow_se_indexingbooleanrequired
  Example
  true
  Description
  Whether the image is allowed to be indexed by search engines
- urlstringrequired
  Example
  http://images.cmp.optimizely.com/Zz0xODQ3NDU3Y2Y2YmYzOTlmNjkyOTgyZDY3Y2I3YWM2OA==
  Description
  Download the URL of the image
- labelsResourceLabelResponse[]required
  Description
  Labels associated with the image
  - groupobjectrequired
    Description
    Label group
    - idstringrequired
      Example
      2467e583a60e23fda2b89db81a453cd2
      Description
      Identifier of the label group
    - namestringrequired
      Example
      Content Format
      Description
      Name of the label group
  - valuesobject[]required
    Description
    List of values of the label
    - idstringrequired
      Example
      71c378f3fee3d822759d1bdc2aab628c
      Description
      Identifier of the label value
    - namestringrequired
      Example
      Photos
      Description
      Name of the label value
- owner_organization_idstringrequired
  Example
  5108c3a9becac35915111191
  Description
  ID of owner organization of the image
- expires_atstring<date-time>required
  Example
  2019-10-07T13:15:30Z
  Description
  Date and time for the expiration of the image, in ISO 8601 UTC format (2020-02-10T10:40
  )
  Format
  date-time
- thumbnail_urlstringrequired
  Example
  http://images.cmp.optimizely.com/Zz0xODQ3NDU3Y2Y2YmYzOTlmNjkyOTgyZDY3Y2I3YWM2OA==
  Description
  URL of the thumbnail of the image
- version_numberintegerrequired
  Example
  2
  Description
  Version number of image
- version_idstringrequired
  Example
  5d7f910551b00a722e0418830cee6631
  Description
  Version id of image
- alt_textstringrequired
  Example
  image title
  Description
  Alternative text for image
- tagsTag[]required
  Description
  Tags for the image
  - guidstringrequired
    Example
    5d7f910551b00a722e0418830cee6633
    Description
    Unique identifier of the tag
  - namestringrequired
    Example
    Sample Tag
    Description
    Name of the tag
- attribution_textstringrequired
  Example
  Nature
  Description
  Attribution of Image
- owner_idstringrequired
  Example
  5108c3a9becac35915111191
  Description
  ID of the image owner
- focal_pointobjectrequired
  Description
  Focal point of the image
  - xintegerrequired
    Example
    35
    Description
    X coordinate of the focal point
  - yintegerrequired
    Example
    75
    Description
    Y coordinate of the focal point

400Client error

Error
Example
```
{
  "message": "Unsupported arguments: a,b,c"
}
```
Description
Error payload
- messagestringrequired
  Example
  Not found
  Description
  Message describing the error
- errorsmap<string, string>
  Description
  Additional information

401Authorization error

Error
Example
```
{
  "message": "Unauthorized"
}
```
Description
Error payload
- messagestringrequired
  Example
  Not found
  Description
  Message describing the error
- errorsmap<string, string>
  Description
  Additional information

403Permission error

Error
Example
```
{
  "message": "You do not have the permission to perform this operation"
}
```
Description
Error payload
- messagestringrequired
  Example
  Not found
  Description
  Message describing the error
- errorsmap<string, string>
  Description
  Additional information

404Not found error

Error
Example
```
{
  "message": "Resource not found"
}
```
Description
Error payload
- messagestringrequired
  Example
  Not found
  Description
  Message describing the error
- errorsmap<string, string>
  Description
  Additional information

422Unprocessable entity error

Error
Example
```
{
  "message": "Resource cannot be processed"
}
```
Description
Error payload
- messagestringrequired
  Example
  Not found
  Description
  Message describing the error
- errorsmap<string, string>
  Description
  Additional information

curl

curl --request PATCH \
     --url https://api.cmp.optimizely.com/v3/images/{id} \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "labels": [
     {
     "group": "2467e583a60e23fda2b89db81a453cd2",
     "values": []
     }
     ],
     "focal_point": {
     "x": 35,
     "y": 75
     }
     }'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var raw = JSON.stringify({
   "labels": [
      {
         "group": "2467e583a60e23fda2b89db81a453cd2",
         "values": []
      }
   ],
   "focal_point": {
      "x": 35,
      "y": 75
   }
});

var requestOptions = {
   method: 'PATCH',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("https://api.cmp.optimizely.com/v3/images/{id}", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.cmp.optimizely.com/v3/images/{id}")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request.body = JSON.dump({
   "labels": [
      {
         "group": "2467e583a60e23fda2b89db81a453cd2",
         "values": []
      }
   ],
   "focal_point": {
      "x": 35,
      "y": 75
   }
})

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://api.cmp.optimizely.com/v3/images/{id}"

payload = json.dumps({
   "labels": [
      {
         "group": "2467e583a60e23fda2b89db81a453cd2",
         "values": []
      }
   ],
   "focal_point": {
      "x": 35,
      "y": 75
   }
})
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("PATCH", url, headers=headers, data=payload)

print(response.text)

200

// Updated Image
{
  "id": "5d7f910551b00a722e0418830cee6632",
  "title": "cat.jpeg",
  "description": "Very important image",
  "mime_type": "image/jpeg",
  "file_extension": "jpg",
  "created_at": "2019-10-06T13:15:30Z",
  "modified_at": "2019-10-07T13:15:30Z",
  "file_size": 11244,
  "image_resolution": {
    "height": 800,
    "width": 700
  },
  "folder_id": "6bb8db20a5b611ebae319b7c541b1a5a",
  "file_location": "/images/",
  "is_archived": true,
  "is_public": true,
  "allow_se_indexing": true,
  "url": "http://images.cmp.optimizely.com/Zz0xODQ3NDU3Y2Y2YmYzOTlmNjkyOTgyZDY3Y2I3YWM2OA==",
  "labels": [
    {
      "group": {
        "id": "2467e583a60e23fda2b89db81a453cd2",
        "name": "Content Format"
      },
      "values": [
        {
          "id": "71c378f3fee3d822759d1bdc2aab628c",
          "name": "Photos"
        }
      ]
    }
  ],
  "owner_organization_id": "5108c3a9becac35915111191",
  "expires_at": "2019-10-07T13:15:30Z",
  "thumbnail_url": "http://images.cmp.optimizely.com/Zz0xODQ3NDU3Y2Y2YmYzOTlmNjkyOTgyZDY3Y2I3YWM2OA==",
  "version_number": 2,
  "version_id": "5d7f910551b00a722e0418830cee6631",
  "alt_text": "image title",
  "tags": [
    {
      "guid": "5d7f910551b00a722e0418830cee6633",
      "name": "Sample Tag"
    }
  ],
  "attribution_text": "Nature",
  "owner_id": "5108c3a9becac35915111191",
  "focal_point": {
    "x": 35,
    "y": 75
  }
}

400

// Client error
{
  "message": "Not found",
  "errors": ""
}

401

// Authorization error
{
  "message": "Not found",
  "errors": ""
}

403

// Permission error
{
  "message": "Not found",
  "errors": ""
}

404

// Not found error
{
  "message": "Not found",
  "errors": ""
}

422

// Unprocessable entity error
{
  "message": "Not found",
  "errors": ""
}