REST API v4: GET templates (HTML mailings)

Je kunt de REST API gebruiken om een overzicht van alle emailing templates op te vragen door een HTTP GET verzoek te versturen naar de volgende URL:

https://api.copernica.com/v4/html/templates

Beschikbare parameters

De volgende parameters zijn beschikbaar voor deze API call:

  • archived: Boolean die aangeeft of alleen templates uit het archief worden opgehaald (true) of alleen templates die niet gearchiveerd zijn (false). Standaard worden alle templates opgehaald.
  • modifiedfromdate: Datum waarna de template bewerkt moet zijn in YYYY-MM-DD HH:MM:SS formaat
  • modifiedtodate: Datum waarvoor de template bewerkt moet zijn in YYYY-MM-DD HH:MM:SS formaat

Teruggegeven velden

Deze methode geeft een JSON object met een array van emailing templates in het data veld. Elke template bevat de volgende informatie:

  • id: De ID van de template.
  • name: De naam van de template.
  • archived: De archiefstatus van de template.

JSON voorbeeld

De JSON voor een enkele template ziet er bijvoorbeeld zo uit:

{  
   "id":"551",
   "name":"TestTemplate",
   "archived":false
}

PHP voorbeeld

Het onderstaande script demonstreert hoe je deze API methode gebruikt. 

// vereiste scripts
require_once('CopernicaRestAPI.php');

// verander dit naar je access token
$api = new CopernicaRestAPI("your-access-token", 4);

// parameters voor het verzoek (sluit gearchiveerde templates uit)
$params = array(
    'archived'  => false
);

// voer het verzoek uit
print_r($api->get("html/templates", $params));

Dit voorbeeld vereist de REST API klasse

Meer informatie