Skip to content

Latest commit



53 lines (38 loc) · 1.65 KB

File metadata and controls

53 lines (38 loc) · 1.65 KB

REST API: PUT subprofile fields

To update existing fields of a subprofile, you need to do an HTTP PUT request to the following URL:$id/fields

In this, $id should be replaced by the numerical identifier, the ID, of the subprofile you want to edit the fields of. The name of the field and other variables need to be added to the message body of the HTTP request.

Available data

The new field values need to be added to the body of the message. This data simply consists of the existing field names on the profile you want to change and their new values. If you send your data in JSON format, you’ll need to create an object with field names as keys and field values as values.

If, however, you’re using a traditional x-www-form-urlencoded format, the variables should contain the names of the fields you want to change, and the values should be the new field values.

PHP example

The following example illustrates how to use the API method:

// dependencies

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

// data to pass to the call
$data = array(
    'firstname' =>  'John',
    'lastname'  =>  'Doe',
    'email'     =>  ''

// do the call
$api->put("subprofile/{$subprofileID}/fields", $data);

The example above requires the CopernicaRestApi class.

More information