REST API: POST rule conditions

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

A method to add conditions for a rule. It is called by sending an HTTP POST request to the following URL:$id/conditions?access_token=xxxx

In this, $id needs to be replaced by the numerical identifier or the name of the rule you wish to edit the conditions of. After a successful call the ID of the created request is returned.

Available parameters

The message body can hold the following properties for a condition:

  • type: type of condition

Based on the condition type, specific properties are set. For an overview of the supported conditions and the properties that they support, check the specific articles:

PHP example

The following example demonstrates how to use this method:

// dependencies

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

// parameters to pass to the call
$data = array(
    'type' = 'date'

// do the call, and print result
$api->post("rule/1234/conditions", array(), $data);

// return id of created request if successful

The example above requires the CopernicaRestApi class.

More information