Skip to content
Permalink
master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Go to file
 
 
Cannot retrieve contributors at this time

REST API: GET document textblocks (Publisher)

You can use the REST API to retrieve the text blocks of an emailing document with an HTTP GET call to the following URL:

https://api.copernica.com/v3/publisher/document/$id/textblocks?access_token=xxxx

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 text block.
  • parentID: The ID of the parent of the text block
  • name: The name of the text block.
  • iteration: Iteration that the image block is in.
  • condition: Conditions of the text block.
  • content: Content of the text block.

JSON example

{
    "ID": "1",
    "parentID": "",
    "name": "textlock",
    "iteration": "0",
    "condition": "",
    "content": "This is a test"
}

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('copernica_rest_api.php');

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

// execute the call
print_r($api->get("publisher/document/{$documentID}/textblocks"));

This example requires the REST API class

More information