REST API: POST database profile

Warning: You are viewing the documentation for the old REST API. We recommend using version 2 of the REST API.

The HTTP POST method to add a profile to an existing database is available at the following address:$id/profiles?access_token=xxxx

In this, $id should be replaced by the numerical identifier, the ID, of the database you want to add an profile to. Profile information needs to be added to the message body of the HTTP request. After a successful call the ID of the created request is returned.

Please note that while POST and PUT are generally the same it is import to distinguish them in this case. This method posts a new profile, while PUT is the method to edit several profiles (see: editing multiple profiles).

Body data

Besides the parameters that you append to the URL, you must also include a request body in the POST request. The body should contain the fields values of the profile. Make sure you include an email address so you can reach the profile with your email campaigns!

PHP example

The following script demonstrates how to use the API method:

// dependencies

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

// field values for the profile
$data = array(
    'firstname' =>  'John',
    'lastname'  =>  'Doe',
    'email'     =>  ''

// do the call
$api->post("database/1234/profiles", $data);

// return id of created request if successful

The example above requires the CopernicaRestApi class.

More information: