REST API v4: POST /events/user/remove

Deze methode stelt je in staat om een remove event te registreren voor een gebruiker. Dit is een HTTP POST methode naar het volgende adres:

https://api.copernica.com/v4/events/user/remove

Deze POST call triggert een remove 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 bijbehorende opvolgacties worden uitgevoerd

Dit event heeft geen betrekking op Copernica users. Het is een manier om een activiteit van een user uit een extern systeem te synchroniseren met Copernica door middel van opvolgacties.

Parameters

De volgende parameters moeten verplicht worden meegegeven aan dit endpoint:

  • email: Het e-mailadres van de gebruiker die verwijderd moet worden. (verplicht)

Daarnaast zijn de volgende optionele parameters beschikbaar:

  • firstname: De voornaam van de gebruiker. (optioneel)
  • suffix: Het tussenvoegsel van de naam van de gebruiker. (optioneel)
  • lastname: De achternaam van de gebruiker. (optioneel)

Naast de verplichte en optionele parameters kunnen aan dit evenement extra attributen worden toegevoegd die gebruikt kunnen worden in bijvoorbeeld opvolgacties. Extra attributen kunnen bijvoorbeeld aanvullende gebruikersinformatie bevatten.

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/user/remove HTTP/1.1
Host: api.copernica.com
Authorization: Bearer your-access-token
Content-Length: 52
Content-Type: application/json

{
    "email": "john.doe@example.com",
    "firstname": "John",
    "lastname": "Doe"
}

Voorbeeld met URL-encoded data

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

email=john.doe@example.com&firstname=John&lastname=Doe

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/user/remove", array(
    'email'       => 'john.doe@example.com',
    'firstname'   => 'John',
    'lastname'    => 'Doe'
));

Dit voorbeeld vereist de REST API klasse.

Meer informatie