REST API v4: PUT profile interests

To overwrite existing interests of a profile or add an interest an HTTP PUT request can be sent to the following URL:

https://api.copernica.com/v4/profile/$id/interests

In this, $id should be replaced by the numerical identifier, the ID, of the database you want to add a selection to. This method adds the given interest to the current interest array.

Body data

There are two ways to send body data to this request, which influences the way the method works.

By sending an array in the body message the interests will be set to this array. It is also possible to add an array along with activation values as the message body. This activation value can then be used to determine whether the interest 'counts' or not in other applications. Both methods will overwrite the current profile interests.

If you wish to keep the existing interests, please see the documentation on adding interests to a profile.

JSON example

The following JSON demonstrates how to use the API method:

{
    "football": 1,
    "tennis": 1,
    "hockey": 0
}

PHP example

The following PHP script demonstrates how to call the API method. In the API call the interests of the first profile are edited to activate "tennis" and "hockey" and to deactivate "football" (second method). This overwrites previous interests. Then we activate the interest "football" for the other profile, overwriting the current interests for this profile (first method).

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

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

// data to pass to the call
$data = array(
    'football'  =>  0,
    'tennis'    =>  1,
    'hockey'    =>  1
);

// do the call
$api->put("profile/{$profileID1}/interests", $data);

// data to pass to a second call
$data = array('football');

// do the call
$api->put("profile/{$profileID2}/interests", $data);

The example above requires the CopernicaRestApi class.

More information