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

A method to edit the properties of an existing rule. It is called using the following URL:$id?access_token=xxxx

The $id needs to be replaced with the ID of the rule you want to edit the properties of.

Available data

The following data can be placed in the message body of the HTTP PUT command:

  • name: name of the rule
  • description: description of the rule
  • view: ID of the selection that the rule belongs to
  • conditions: array of conditions for the rule
  • inversed: boolean value to indicate whether the rule should be inversed. If set to "True" only profiles not conforming to the conditions are selected
  • disabled: boolean value to indicate whether the rule should be disabled or not

PHP example

The following example demonstrates how to use this method:

// dependencies

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

// declare the id of the rule that you want to edit
$id = 1;

// data to be sent to the api
$data = array(
    'description'   =>  'a new description',
    'has_rules'      =>  true

// do the call, and print result
print_r($api->put("rule/{$id}", $data));

The example above requires the CopernicaRestApi class.

More information