REST API v4: GET template (HTML)
You can use the REST API to retrieve a summary of an emailing template with an HTTP GET call to the following URL:
https://api.copernica.com/v4/html/template/$id
Where $id
should be replaced with the ID of the emailing template you want summarized.
Returned fields
The method returns a JSON object containing the following information:
- id: The ID of the template.
- name: The name of the template.
- description: The description of the template.
- from_address: The from address of the template.
- subject: The subject of the template.
- archived: The archive status of the template.
To get the HTML source of the template you can add source=true
to the URL:
https://api.copernica.com/v4/html/template/$id?source=true
JSON Example
The JSON for a template will look something like this:
{
"id":"551",
"name":"TestTemplate",
"description":"",
"from_address": "\"Test\" <test@copernica.com>",
"subject": "This is a test template",
"archived": false,
"source": "<html><body>Test</body></html>"
}
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/template/{$templateID}"));
This example requires the REST API class