REST API v3: PUT document textblock (Publisher)

A method to update a text block. This is an HTTP PUT method, accessible at the following address:

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

Replace the first $id by the identifier of the document and the second $id by the identifier of the text 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 text block
  • content: content of the text block

JSON example

The following JSON demonstrates how to use the API method:

{
    "content": "This is a new text"
}

PHP example

The following example demonstrates how to use the API method:

// dependencies
require_once('copernica-rest-api.php');

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

// data to be sent to the api
$data = array(
     'content'   =>  'This is a new text'
);

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

The example above requires the CopernicaRestApi class.

More information