POST API v3: POST /events/unsubscribe

Deze methode stelt je in staat om een unsubscribe event te registreren voor een gegeven e-mailadres. Dit is een HTTP POST methode naar het volgende adres:

https://api.copernica.com/v3/events/email/unsubscribe?access_token=xxx

Deze POST call triggert een unsubscribe event. Echter het is afhankelijk van de inrichting van je account hoe dit event verder zal worden verwerkt. Naar aanleiding van deze POST call zal:

  • Het event worden gelogd.
  • De bijbehorede opvolgacties worden uitgevoerd.

Parameters

De volgende parameters moeten verplicht worden meegegeven aan dit endpoint:

  • email: Het e-mailadres dat zich heeft uitgeschreven. (verplicht)

Daarnaast kunnen aan dit evenement extra attributen worden toegevoegd die gebruikt kunnen worden in bijvoorbeeld opvolgacties. Extra attributen kunnen bijvoorbeeld de reden van uitschrijving bevatten of aanvullende gebruikersinformatie.

Voorbeelden

Voorbeeld met JSON

{
    "email": "john.doe@example.com"
}

Voorbeeld met PHP

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

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

// voer het verzoek uit
$api->post("/events/unsubscribe", array(
    'email' =>  'info@example.com'
));

Dit voorbeeld vereist de REST API klasse.

Meer informatie