REST API: PUT document imageblock (Publisher)

A method to update an image block. This is an HTTP PUT method, accessible at the following address:$id/imageblock/$id

Replace the first $id by the identifier of the document and the second $id by the identifier of the image block you want to edit.

Available data

The following variables can be used in the body of the HTTP PUT request:

  • condition: condition of the image block

JSON example

The following JSON demonstrates how to use the API method:

    "condition": "if (profile.gender == 'men'){ return true; }else{ return false; }"

PHP example

The following example demonstrates how to use the API method:

// dependencies

// change this into your access token
$api = new CopernicaRestAPI("your-access-token", 4);

// data to be sent to the api
$data = array(
    'condition'   =>  '
        if (profile.gender == "men"){ 
            return true;
            return false;

// do the call
$api->put("publisher/document/{$documentID}/imageblock/{$imageblockID}", $data);

The example above requires the CopernicaRestApi class.

More information