REST API: GET emailingdocument

Warning: You are viewing the documentation for the old REST API. We recommend using version 2 of the REST API.

A method to request all metadata from an emailingdocument. This method does not support parameters. By sending a GET request to the following URL, you can fetch the emailingdocument metadata:$id?access_token=xxxx

where $id should be replaced by the identifier of the emailingdocument you want to get the metadata of.

Returned fields

  • id: unique numerical identifier

  • template_id: unique numerical identifier of template

  • name: name of document

  • from_address: from address of document

  • subject: subject of document

  • source: source of document

PHP example

The following example demonstrates how to use this method:

// dependencies

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

// do the call, and print result

The example above requires the CopernicaRestApi class.