Update an existing fence (compliance) profile

modifies the fence policy

Endpoints

put /api/v1/mdm/compliance/{compliance_id}

Copy full URL

Request URL

https://{serverurl}/api/v1/mdm/compliance/{compliance_id}

Scope

MDMOnDemand.MDMInventory.UPDATECopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Path Parameters

compliance_idstringMandatory

Unique identifier of the compliance policy. Obtain from the Add Fence Policy or Get Fence Policies response

- Request Body

application/json

JSON object

Hide Sub-Attributes

compliance_namestringMandatory

Updated name of the compliance (fence) profile

descriptionstringOptional

Updated description of the compliance profile

policiesJSON arrayMandatory

Updated collection of policy objects with rules and actions

Show Sub-Attributes

JSON object

Show Sub-Attributes

ruleJSON objectOptional

Rule details defining the geofence conditions

Show Sub-Attributes

rule_namestringOptional

Name of the compliance rule

evaluation_orderintegerOptional

Order in which this rule is evaluated

rule_idintegerOptional

Rule ID of the policy

rule_criterionsJSON arrayOptional

Collection of criteria determining rule satisfaction/violation

Show Sub-Attributes

JSON object

Show Sub-Attributes

rule_criteria_typeintegerOptional

Type of rule criterion (e.g., 2 = Geofence)

geo_fence_idintegerOptional

Fence ID of the geofence boundary

rule_criteria_stateintegerOptional

State determining satisfaction or violation (e.g., 2 = outside fence)

actionJSON objectOptional

Action details defining responses to rule satisfaction/violation

Show Sub-Attributes

action_idlongOptional

Action ID of the action

action_attributesJSON arrayOptional

Collection of actions performed on rule satisfaction/violation

Show Sub-Attributes

JSON object

Show Sub-Attributes

execution_orderintegerOptional

Order of execution of the action

time_to_executionintegerOptional

Time delay in seconds before executing the action

action_attribute_typeintegerOptional

Type of action (e.g., 1 = Lock device)

phone_numberlongOptional

Phone number to display on the lost device screen

lock_messagestringOptional

Message shown on the locked/lost device

unlock_pinstringOptional

PIN to unlock the device after locking

is_remote_alarmbooleanOptional

Whether remote alarm is initiated on the device

is_mark_as_non_compliantbooleanOptional

Whether the device is marked as non-compliant

alert_email_idsJSON arrayOptional

Array of email recipients notified on rule violation

Show Sub-Attributes

JSON object

Show Sub-Attributes

emailstringOptional

Email address of the user to alert

user_namestringOptional

Name of the user associated with the email address

subjectstringOptional

Subject line of the alert email/notification

body_messagestringOptional

Body of the alert describing the reason for the action

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request PUT \
  --url https://appdomain/api/v1/mdm/compliance/{compliance_id} \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'content-type: application/json' \
  --data '{"policies":[{}],"compliance_name":"GeoFencePolicyUpdated"}'

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.io.IOException;
import java.net.http.HttpTimeoutException;

public class Main {
  public static void main(String[] args) {

    HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create("https://appdomain/api/v1/mdm/compliance/{compliance_id}"))
        .header("content-type", "application/json")
        .header("Authorization", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
        .method("PUT", HttpRequest.BodyPublishers.ofString("{\"policies\":[{}],\"compliance_name\":\"GeoFencePolicyUpdated\"}"))
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

conn = http.client.HTTPSConnection("appdomain")

payload = "{\"policies\":[{}],\"compliance_name\":\"GeoFencePolicyUpdated\"}"

headers = {
    'content-type': "application/json",
    'Authorization': "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52"
    }

conn.request("PUT", "/api/v1/mdm/compliance/{compliance_id}", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))


    headersMap = Map();
    headersMap.put("Content-Type", "application/json");
    headersMap.put("Accept", "application/json");

    data=Map();
    data_policies=List();
    data_policies_item1=Map();
    data_policies.add(data_policies_item1);
    data.put("policies",data_policies);
    data.put("compliance_name","value");

    response = invokeUrl
    [
        url: "https://appDomain/api/v1/mdm/compliance/{compliance_id}"
        type: PUT
        headers: headersMap
        body: data
        connection: connection_name
    ]

    info response;

$headers=@{}
$headers.Add("content-type", "application/json")
$headers.Add("Authorization", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomain/api/v1/mdm/compliance/{compliance_id}' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{"policies":[{}],"compliance_name":"GeoFencePolicyUpdated"}'

▼ Show full

Sample Request Body

Update fence policy with modified rule and action configuration

Copied!

  {
    "policies": [
      {
        "rule": {
          "rule_id": 9007199254741084,
          "rule_name": "Tower",
          "evaluation_order": 1,
          "rule_criterions": [
            {
              "geo_fence_id": 1,
              "rule_criteria_state": 2,
              "rule_criteria_type": 2
            }
          ]
        },
        "action": {
          "action_id": 9007199254741084,
          "action_attributes": [
            {
              "lock_message": "Device is lost",
              "body_message": "The device is outside its permitted fence.",
              "subject": "Warning",
              "is_remote_alarm": false,
              "is_mark_as_non_compliant": true,
              "alert_email_ids": [
                {
                  "user_name": "admin",
                  "email": "admin@zylker.com"
                }
              ],
              "action_attribute_type": 1,
              "time_to_execution": 0,
              "execution_order": 1
            }
          ]
        }
      }
    ],
    "description": "Updated Compliance Profile",
    "compliance_name": "GeoFencePolicyUpdated"
  }

▼ Show full

Response Parameters

- HTTP code 200

Response Body - application/json

JSON object

Hide Sub-Attributes

compliance_idstring

Profile ID of the modified compliance profile

compliance_namestring

Updated name of the compliance profile

collection_idstring

Collection ID of the compliance

user_idstring

ID of the user who modified the policy

customer_idstring

Customer ID

compliance_file_name_pathstring

Server-side file path of the compliance profile JSON

remove_compliance_file_name_pathstring

Server-side file path for the remove compliance profile JSON

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Fence policy successfully modified with updated metadata

Copied!

  {
    "collection_id": "9007199254741048",
    "user_id": "1",
    "compliance_file_name_path": "<server_home>/<customer_id>/compliance_profile.json",
    "remove_compliance_file_name_path": "<server_home>/<customer_id>/remove_compliance_profile.json",
    "customer_id": "1",
    "compliance_id": "9007199254741047",
    "compliance_name": "GeoFencePolicyUpdated"
  }

▼ Show full

Duration: 1 minute | Threshold: 60 | Lock period: 5 minutes

Duration - Time window for the threshold.
Threshold - Number of API calls allowed within the specified duration.
Lock Period - Wait time before consecutive API requests.