REST API v3: GET templates (Marketing Suite)

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/v3/ms/templates?access_token=xxxx

Beschikbare parameters

De volgende parameters zijn beschikbaar voor deze API call, je kunt deze gebruiken om templates met bepaalde eigenschappen op te vragen:

  • name: Naam die de template moet hebben.
  • keyword: Kernwoorden die de template moet hebben.
  • type: Type van de template ('json' of 'html').
  • created_before: Datum waarvoor de template aangemaakt moet zijn in YYYY-MM-DD HH:MM:SS formaat.
  • created_after: Datum waarna de template aangemaakt 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 het template.
  • from_address: Adres van de afzender. Array met een 'name' (naam) en 'email' veld.
  • subject: Het onderwerp van de template
  • type: Het type van de template ('json' of 'html').
  • archived: Of de template wel of niet gearchiveerd is.
  • directory: De map waarin de template zich bevindt (indien aanwezig).

JSON voorbeeld

Een enkele template ziet er bijvoorbeeld zo uit:

{  
   "id":"2820",
   "name":"Theme: conference",
   "from_address":{  
      "name":"Infinity",
      "email":"info@valtaf.nl"
   },
   "subject":"Infinity conference",
   "type":"json",
   "archived":false,
   "directory":"78"
}

PHP voorbeeld

Het onderstaande script demonstreert hoe je deze API methode gebruikt. 

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

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

// parameters voor het verzoek (vraag alleen json templates op)
$params = array(
    type    = 'json'
);

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

Dit voorbeeld vereist de REST API klasse

Meer informatie