REST API v3: POST collection intentions

Intentions geven aan welke communicatie methoden toegestaan zijn voor deze collectie. De intentions voor email, sms en pdf kunnen allemaal aan of uitgezet worden, om te voorkomen dat er per ongeluk mailings worden verstuurd.

De HTTP POST methode om de intentions van een collectie aan te passen is beschikbaar op het volgende adres:

https://api.copernica.com/v3/collection/$id/intentions?access_token=xxxx

De $id moet hier vervangen worden door de unieke identifier van de collectie.

Parameters

Deze methode ondersteunt de volgende parameters. Al deze parameters zijn optioneel en als deze niet meegegeven worden verandert er niets aan de betreffende intention.

  • email: Boolean die aangeeft of de collectie gebruikt mag worden voor emailen.
  • sms: Boolean die aangeeft of de collectie gebruikt mag worden voor sms berichten.
  • pdf: Boolean die aangeeft of de collectie gebruikt mag worden voor het downloaden van PDF bestanden.

De intentions kunnen alleen ingeschakeld worden als de juiste velden hiervoor aanwezig zijn in de database.

Voorbeeld in JSON

De volgende JSON demonstreert hoe je de API methode kunt gebruiken:

{
  "email": true,
  "sms": false,
  "pdf": true
}

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

// data voor de methode
$data = array(
    'email' =>  true,
    'sms'   =>  true,
    'pdf'   =>  true
);

// voer het verzoek uit
$api->post("collection/{$collectionID}/intentions", $data);

Dit voorbeeld vereist de REST API klasse.

Meer informatie