Skip to content
Permalink
master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Go to file
 
 
Cannot retrieve contributors at this time

REST API: GET snapshot (Publisher mailing)

You can retrieve a snapshot of a Publisher mailing by sending an HTTP GET request to the following URL:

https://api.copernica.com/v3/publisher/emailing/$id/snapshot?access_token=xxxx

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

Returned fields

The data field of returned JSON object contains the snapshot information. The following fields are available:

  • document: The ID of the document used for the mailing.
  • name: The name of the snapshot.
  • from_address: The 'from address' from the mailing.
  • subject: The subject of the mailing.

JSON example

The JSON for the snapshot might look something like this:

{  
   "document":"58",
   "name":"New emailing",
   "from_address":"\"Test\" <test@copernica.com>",
   "subject":"Title!"
}

PHP example

This script demonstrates how to use this API method:

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

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

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

This example requires the REST API class.

More information