POST API v4: 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/v4/events/email/unsubscribe

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.

Geaccepteerde formaten

De API-call accepteert zowel JSON-data als traditionele POST-data (application/x-www-form-urlencoded). Hieronder staan voorbeelden van beide formaten.

Voorbeeld met JSON

POST /v4/events/email/unsubscribe HTTP/1.1
Host: api.copernica.com
Authorization: Bearer your-access-token
Content-Length: 39
Content-Type: application/json

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

Voorbeeld met URL-encoded data

POST /v4/events/email/unsubscribe HTTP/1.1
Host: api.copernica.com
Authorization: Bearer your-access-token
Content-Length: 25
Content-Type: application/x-www-form-urlencoded

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

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

Dit voorbeeld vereist de REST API klasse.

Meer informatie