Home > Documentatie > REST API v3: POST template

REST API v3: POST template

Methode om een nieuwe template aan te maken. Dit is een HTTP POST-methode naar het volgende adres:

https://api.copernica.com/v3/ms/template?access_token=xxxx

Beschikbare parameters

  • name: naam van de nieuw aan te maken template (verplicht)
  • description: optionele omschrijving van de template
  • from_address: object met de eigenschappen:
    • name: de naam van de afzender
    • email: het e-mailadres van de afzender
  • source: object met de eigenschappen:
    • html: de HTML-broncode van de template
    • css:: de CSS-styling van de template
    • text: de tekstversie van de template
  • language: de taal van de template
  • timezone: de tijdzonde van de template
  • reply to: het reply-to adres van de template
  • bcc: het bcc-adres van de template
  • archived: optionele boolean waarde om de template direct te archiveren
  • unsubscribe_header: geeft aan of een afmeldkoptekst aanwezig moet zijn. Waarden kunnen zijn: both (default), email, link of no.

Voorbeeld in JSON

De volgende JSON demonstreert hoe je de API-methode kunt gebruiken:

{
    "name": "Test template",
    "description": "This is a test template",
    "from_address": {
        "name": "Support",
        "email": "support@yourdomain.com"
    },
    "subject": "This is a test",
    "archived": false,
    "source": {
        "html": "<html><body>This is a test template</body></html>",
        "text": "This is a text version"
    },
    "language": "nl_NL",
    "timezone": "Europe/Amsterdam",
    "unsubscribe_header": "both"
}

Voorbeeld in PHP

Het volgende PHP-script demonstreert hoe je de API methode kunt aanroepen:

// vereiste scripts
require_once('copernica-rest-api.php');

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

// data voor de methode
$data = array(
    'name'                  => 'Test template',
    'description'           => 'This is a test template',
    'from_address'          => array(
        'name'              => 'Support',
        'email'             => 'support@yourdomain.com'
    ),
    'subject'               => 'This is a test',
    'archived'              => false,
    'source'                => array( 
        'html'              => '<html><body>This is a test template</body></html>', 
        'text'              => 'This is a text version' ),
    'language'              => 'nl_NL',
    'timezone'              => 'Europe/Amsterdam',
    'unsubscribe_header'    => 'both'
);

// voer het verzoek uit
$api->post("ms/template", $data);

Dit voorbeeld vereist de REST API-klasse.