REST API v4: bijwerken van een document (HTML mailings)
Methode om een document bij te werken. Dit is een HTTP PUT-methode die toegankelijk is via het volgende adres:
https://api.copernica.com/v4/document/$id
De variabele $id
in de URL moet worden vervangen door de numerieke identifier
van het document die je wilt bewerken.
Beschikbare parameters
De volgende variabelen kunnen in de body van het HTTP PUT-commando worden geplaatst:
- name: naam van het bij te werken document
- description: omschrijving van het document
- from_address: array met 'name' en 'email' voor het afzenderadres
- subject: onderwerp van het document
Voorbeeld in JSON
De volgende JSON demonstreert hoe je de API methode kunt gebruiken:
{
"name": "Nieuwe_naam"
}
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(
'name' => 'Nieuwe_naam'
);
// voer verzoek uit
api->put("document/{$documentID}", $data);
Dit voorbeeld vereist de REST API-klasse.