REST API v4: GET document imageblocks (HTML)
You can use the REST API to retrieve the image blocks of an emailing document with an HTTP GET call to the following URL:
https://api.copernica.com/v4/html/document/$id/imageblocks
Where $id
should be replaced with the ID of the emailing document.
Returned fields
The method returns a JSON object containing the following information:
- ID: The ID of the image block.
- parentID: The ID of the parent of the image block.
- name: The name of the image block.
- iteration: Iteration that the image block is in.
- condition: Conditions of the image block.
JSON example
{
"ID": "1",
"parentID": "",
"name": "imageblock",
"iteration": "0",
"condition": "",
}
PHP example
The script below demonstrates how to use this API method. Don't forget to replace the ID in the URL before executing the call.
// dependencies
require_once('CopernicaRestAPI.php');
// change this into your access token
$api = new CopernicaRestAPI("your-access-token", 4);
// execute the call
print_r($api->get("html/document/{$documentID}/imageblocks"));
This example requires the REST API class