Skip to content
Permalink
master
Switch branches/tags
Go to file
 
 
Cannot retrieve contributors at this time

REST API: GET collection unsubscribe

Every collection has the option to set unsubscribe behaviour. When Copernica’s servers receive an unsubscription, the unsubscribe behaviour determines what happens with the profile: should it be edited or removed?

You can request your settings using the following URL:

https://api.copernica.com/v2/database/$id/unsubscribe?access_token=xxxx

The $id should be replaced by the numerical identifier or the name of the database.

Returned fields

  • behavior: the setting itself
  • fields: the new profile setting (only applicable if ‘behavior’ is set to ‘update’)

The behavior can be one of three possible values: 'nothing', 'remove' and 'update'. 'nothing' means unsubscriptions are simply ignored (which is very impolite), 'remove' deletes unsubscribers and 'update' makes sure something is changed in the profile so you know it shouldn’t receive email any longer.

JSON example

The JSON for the unsubscribe behaviour might look something like this:

{  
   "behavior":"update",
   "fields":{  
      "newsletter":"no"
   }
}

PHP example

The following example demonstrates how to use the API method:

// dependencies
require_once('copernica_rest_api.php');

// change this into your access token
$api = new CopernicaRestAPI("your-access-token", 2);

// do the call, and print result
print_r($api->get("collection/{$collectionID}/unsubscribe"));

The example above requires the CopernicaRestApi class.

More information