REST API v4: POST rule conditions
A method to add a condition for a rule. It is called by sending an HTTP POST request to the following URL:
https://api.copernica.com/v4/rule/$id/conditions
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
- 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:
- Change conditions
- Date conditions
- DoubleField conditions
- Email conditions
- Export conditions
- Field conditions
- Interest conditions
- LastContact conditions
- Miniview conditions
- SMS conditions
- Todo conditions
- Survey conditions
- Part conditions
- ReferView conditions
JSON example
The following JSON demonstrates how to use the API method:
{
"type": "field",
"comparison": "equals",
"field": 12,
"value": "test"
}
PHP example
The following example demonstrates how to use this method:
// dependencies
require_once('CopernicaRestAPI.php');
// change this into your access token
$api = new CopernicaRestAPI("your-access-token", 4);
// parameters to pass to the call
$data = array(
'type' => 'field',
'comparison' => 'equals',
'field' => 12,
'value' => 'test'
);
// do the call, and print result
$api->post("rule/{$rule}/conditions", array(), $data);
// return id of created request if successful
The example above requires the CopernicaRestApi class.