REST API v4: GET finalgroup (HTML mailing)

You can retrieve the final group of an HTML mailing by sending an HTTP GET request to the following URL:

https://api.copernica.com/v4/html/emailing/$id/finalgroup

Where the $id should be replaced with the ID of the mailing.

Returned fields

The data field of returned JSON object contains the final group. The following fields are available for each final group:

  • ID: The ID of the final group
  • document: The ID of the document of the mailing.
  • template: The ID of the template of the mailing.
  • name: The name of the mailing snapshot sent to this group.
  • from_address: The 'from address' of the mailing.
  • subject: The subject of the mailing.
  • timestamp: The timestamp of the mailing.
  • destinations: The number of destinations in this group.

JSON example

The JSON for a final group might look something like this:

{  
   "ID":"2481",
   "document":"12",
   "template":"3",
   "name":"Finalgroup",
   "from_address":"\"Mr. Test\" <test@copernica.com>",
   "subject":"Emailing!",
   "timestamp":"2010-10-12 12:37:26",
   "destinations":"1"
}

PHP example

The following script demonstrates how to use this API method:

// dependencies
require_once('CopernicaRestAPI.php');

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

// execute the call
print_r($api->get("html/emailing/{$emailingID}/finalgroup/"));

This example requires the REST API class.

More information