REST API: POST templates (Publisher)

This method is used to create a new template 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

  • name: name of the new template (required)
  • description: description of the template
  • from_address: array with a 'name' and 'email' for the from address
  • subject: subject of the template
  • source: the HTML source of the template (required)
  • amp: the AMP source of the template
  • text: the text version of the template

JSON example

The following JSON demonstrates how to use the API method:

    "name": "test_template",
    "source": "<html><body>New template</body></html>"

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(
    'name'          =>  'my_test_template',
    'source'        =>  '
        This is a test template.

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

// return id of created request if successful

The example above requires the CopernicaRestApi class.

More information