REST API: POST documents (Publisher)

This method is used to create a new document with the REST API. It uses an HTTP POST request to the following address:

After a successful call the ID of the created request is returned.

Available parameters

  • template: ID of the template (required)
  • name: name of the new document (required)
  • description: description of the document
  • from_address: array with a 'name' and 'email' for the from address
  • subject: subject of the document

JSON example

The following JSON demonstrates how to use the API method:

    "template": "1234",
    "name": "my_test_document"

PHP example

The following PHP script 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(
    'template'      =>  '1234',
    'name'          =>  'my_test_document'

// do the call
$api->post("documents", $data);

// return id of created request if successful

The example above requires the CopernicaRestApi class.

More information