Home > Documentatie > REST API v4: aanpassen template

REST API v4: aanpassen template

Methode om de eigenschappen van een template bij te werken. Dit is een HTTP PUT-methode die toegankelijk is via het volgende adres:

https://api.copernica.com/v3/draganddrop/template/$id

De variabele $id in de URL moet worden vervangen door de numerieke identifier van de template die je wilt bewerken.

Beschikbare parameters

De volgende variabelen kunnen in de body van het HTTP PUT commando worden geplaatst:

  • 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
    • address: het e-mailadres van de afzender
  • source: object met de eigenschappen:
    • html: de HTML-broncode 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:

{
    "subject": "New subject",
    "source": {
        "html": "<html><body>New souce code</body></html>",
        "text": "This is a text version"
    }
}

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", 4);

// data voor de methode
$data = array(
    'subject'               => 'New subject',
    'source'                => array( 
        'html'              => '<html><body>New souce code</body></html>', 
        'text'              => 'This is a text version' 
    )
);

// voer verzoek uit
api->put("draganddrop/template/{$templateID}", $data);

Dit voorbeeld vereist de REST API klasse.