Update Image Files
Uri: https://api.finerworks.com/v3/update_images
Method: PUT

Updates a list of image files based on their unique id. Note if the image is assigned to the inventory library, this will also remove any virtual inventory products assigned to those images.


Body

NameDescriptionTypeAdditional information
images

Array of images to update

array (update_image_details)

Required

account_key

Optional - account unique identifier. Note if it does not match the account unique identifier the app key is assigned to then this will not be utlized. Only app keys with proper permissions can use this.

text

None.

Example JSON Body

application/json, text/json

{
  "images": [
    {
      "guid": "eaedbfbc-aee8-408f-9a80-43bda4e94de7",
      "title": "My Cool Image",
      "description": "This is a very cool image."
    }
  ],
  "account_key": null
}

Sample Code Library


                        
curl --location --request sample_method 'https://api.finerworks.comsample_endpoint' \
--header 'Content-Type: application/json' \
--header 'web_api_key: my-web-api-key-goes-here' \
--header 'app_key: my-app-key-goes-here' \
--data-raw '{
  "images": [
    {
      "guid": "eaedbfbc-aee8-408f-9a80-43bda4e94de7",
      "title": "My Cool Image",
      "description": "This is a very cool image."
    }
  ],
  "account_key": null
}'
                            
                        


require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('https://api.finerworks.comsample_endpoint');
$request->setMethod(HTTP_Request2::METHOD_sample_method);
$request->setConfig(array(
'follow_redirects' => TRUE
));
$request->setHeader(array(
'Content-Type' => 'application/json',
'web_api_key' => 'my-web-api-key-goes-here',
'app_key' => 'my-app-key-goes-here'
));
$request->setBody('{
  'images': [
    {
      'guid': 'eaedbfbc-aee8-408f-9a80-43bda4e94de7',
      'title': 'My Cool Image',
      'description': 'This is a very cool image.'
    }
  ],
  'account_key': null
}');
try {
$response = $request->send();
if ($response->getStatus() == 200) {
echo $response->getBody();
}
else {
echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
$response->getReasonPhrase();
}
}
catch(HTTP_Request2_Exception $e) {
echo 'Error: ' . $e->getMessage();
}

                        


var client = new RestClient("https://api.finerworks.comsample_endpoint");
client.Timeout = -1;
var request = new RestRequest(Method.sample_method);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("web_api_key", "my-web-api-key-goes-here");
request.AddHeader("app_key", "my-app-key-goes-here");
request.AddParameter("application/json", "{
  'images': [
    {
      'guid': 'eaedbfbc-aee8-408f-9a80-43bda4e94de7',
      'title': 'My Cool Image',
      'description': 'This is a very cool image.'
    }
  ],
  'account_key': null
},  ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

                        


var settings = {
"url": "https://api.finerworks.comsample_endpoint",
"method": "sample_method",
"timeout": 0,
"headers": {
"Content-Type": "application/json",
"web_api_key": "my-web-api-key-goes-here",
"app_key": "my-app-key-goes-here"
},
"data": JSON.stringify({
  'images': [
    {
      'guid': 'eaedbfbc-aee8-408f-9a80-43bda4e94de7',
      'title': 'My Cool Image',
      'description': 'This is a very cool image.'
    }
  ],
  'account_key': null
}),
};

$.ajax(settings).done(function (response) {
console.log(response);
});

                        

                        
var https = require('follow-redirects').https;
var fs = require('fs');

var options = {
'method': 'sample_method',
'hostname': 'api.finerworks.com',
'path': 'sample_endpoint',
'headers': {
'Content-Type': 'application/json',
'web_api_key': 'my-web-api-key-goes-here',
'app_key': 'my-app-key-goes-here'
},
'maxRedirects': 20
};

var req = https.request(options, function (res) {
var chunks = [];

res.on("data", function (chunk) {
chunks.push(chunk);
});

res.on("end", function (chunk) {
var body = Buffer.concat(chunks);
console.log(body.toString());
});

res.on("error", function (error) {
console.error(error);
});
});

var postData = JSON.stringify({
  "images": [
    {
      "guid": "eaedbfbc-aee8-408f-9a80-43bda4e94de7",
      "title": "My Cool Image",
      "description": "This is a very cool image."
    }
  ],
  "account_key": null
});

req.write(postData);

req.end();
                            
                        

                        
    require "uri"
    require "net/http"

    url = URI("https://api.finerworks.comsample_endpoint")

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

    request = Net::HTTP::sample_method.new(url)
    request["Content-Type"] = "application/json"
    request["web_api_key"] = "my-web-api-key-goes-here"
    request["app_key"] = "my-app-key-goes-here"
    request.body = "{
  'images': [
    {
      'guid': 'eaedbfbc-aee8-408f-9a80-43bda4e94de7',
      'title': 'My Cool Image',
      'description': 'This is a very cool image.'
    }
  ],
  'account_key': null
}"

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


                        

NameDescriptionTypeAdditional information
status

Response status details

response_status

None.

Example JSON Response

application/json, text/json

{
  "status": {
    "success": true,
    "status_code": 200,
    "message": "",
    "debug": null
  }
}