patch https://{app}.{filespin}.{io}/api/v1/user/settings/update?update_key=image
Update image by sending below payload. All keys are mandatory.
REQUEST PAYLOAD
{
"key": "image",
"value": {
"is_on_demand_private": false,
"conversions": [
{
"key": "500x500WEB",
"value": {
"format": "jpg",
"watermark": false,
"enabled": false,
"public": false,
"height": 500,
"width": 500,
"dpi": 72
}
},
{
"key": "deepzoom",
"value": {
"watermark": false,
"enabled": false,
"public": true
}
}
]
}
}
deepzoomis a special key withinconversions. Fordeepzoomonly these keys can be updated:watermark,enabled,public. Other key values will be ignored
- A maximum of 5 conversions is allowed to be added/updated (including
deepzoom)
REQUEST PARAMETERS
| Parameters | Type | Description |
|---|---|---|
key | string | Set to image |
value.is_on_demand_private | boolean | Set to true or false |
value .conversions | JSON | List of standard image conversions objects. A maximum of 5 items can be added/updated (including deepzoom) |
value.conversions.key | string | A unique string name of upto 20 alphanumeric characters such as 500x500WEB.(no spaces) |
value.conversions.value.format | string | Specifies conversion image format. Allowed values :jpg, png |
value.conversions.value.watermark | boolean | Set to true if watermark set in the account settings should be applied to the conversion. false otherwise. |
value.conversions.value.enabled | boolean | Set to true to enable automatic generation of this conversion on asset upload. false otherwise. |
value.conversions.value.public | boolean | Set to trueto make the conversion public when created. When public, a signed URL is not required to access the conversion. false otherwise. |
value.conversions.value.width | integer | Set the maximum width of the conversion in pixels. If this is larger than the image or empty, the original image width will be used. Note:Aspect ratio of generated image will not be altered. Width takes precedence when calculated aspect ratio does not match original image's aspect ratio. |
value.conversions.value.height | integer | Set the maximum height of the conversion in pixels. If this is larger than the image or empty, the original image height will be used |