REST API v4: POST events email subscribe
Methode om een email subscribe event te triggeren. Dit is een HTTP POST methode naar het volgende adres:
https://api.copernica.com/v4/events/email/subscribe
Beschikbare parameters
De volgende parameters moeten verplicht worden meegegeven aan dit endpoint.
- email: Het e-mailadres wat zich geabonneerd heeft. (verplicht)
Daarnaast zijn er de volgende optionele parameters beschikbaar.
- firstname: De voornaam van de persoon die zich heeft geabonneerd. (optioneel)
- suffix: Het tussenvoegsel van de naam van de persoon die zich heeft geabonneerd. (optioneel)
- lastname: De achternaam van de persoon die zich heeft geabonneerd. (optioneel)
Voorbeeld in JSON
De volgende JSON demonstreert hoe je de API methode kunt gebruiken:
{
"email": "john.doe@example.com",
"firstname": "John",
"lastname": "Doe"
}
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(
'email' => 'john.doe@example.com',
'fistname' => 'John',
'lastname' => 'Doe'
);
// voer de methode uit
$api->post("events/email/subscribe", $data);
Dit voorbeeld vereist de REST API klasse.