Modify the configuration of a Web Content Filter payload item within a profile

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

Modify Android Webcontent filter payload

Request URL

https://{serverurl}/api/v1/mdm/profiles/{profile_id}/payloads/androidwebcontentfilter/payloaditems/{payload_id}

Scope

MDMOnDemand.MDMDeviceMgmt.UPDATECopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Path Parameters

profile_idstringMandatory

Unique identifier of the profile. Obtain from the Create Profile or Get Profiles response

payload_idstringMandatory

Unique identifier of the payload item. Obtain from the Get Payload Item IDs response

- Request Body

application/json
JSON object
Hide Sub-Attributes
enable_auto_filterbooleanOptional

Whether automatic content filtering is enabled. Default: true

malicious_content_filterbooleanOptional

Whether malicious content filtering is enabled. Default: true

url_filter_typebooleanOptional

URL filter mode. true = Allowlist, false = Blocklist. Default: true

create_bookmarksbooleanOptional

Whether bookmarks are created for filtered URLs. Default: false

upload_typeintegerOptional

URL upload method. 1 = Manual Entry. Default: 1

url_detailsJSON arrayMandatory

List of URL filter entries with bookmark details (required)

Show Sub-Attributes
JSON object
Show Sub-Attributes
bookmark_pathstringOptional
urlstringOptional
bookmark_titlestringOptional

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request PUT \
  --url https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/androidwebcontentfilter/payloaditems/{payload_id} \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'content-type: application/json' \
  --data '{"url_details":[]}'
▼ Show full

Sample Request Body

Modify Web Content Filter payload item

Copied!
  {
    "create_bookmarks": false,
    "url_filter_type": true,
    "upload_type": 1,
    "url_details": [],
    "enable_auto_filter": true,
    "malicious_content_filter": true
  }
                
▼ Show full

Response Parameters

- HTTP code 200

Response Body - application/json
JSON object
Hide Sub-Attributes
payload_idlong

Unique identifier of the payload item

enable_auto_filterboolean

Whether automatic content filtering is enabled. Default: true

malicious_content_filterboolean

Whether malicious content filtering is enabled. Default: true

url_filter_typeboolean

URL filter mode. true = Allowlist, false = Blocklist. Default: true

create_bookmarksboolean

Whether bookmarks are created for filtered URLs. Default: false

upload_typeinteger

URL upload method. 1 = Manual Entry. Default: 1

url_detailsJSON array

List of URL filter entries with bookmark details (required)

Show Sub-Attributes
JSON object
Show Sub-Attributes
bookmark_pathstring
urlstring
bookmark_titlestring

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Web Content Filter payload item successfully modified

Copied!
  {
    "create_bookmarks": false,
    "payload_id": 9007199254741000,
    "url_filter_type": true,
    "upload_type": 1,
    "url_details": [],
    "enable_auto_filter": true,
    "malicious_content_filter": true
  }
                
▼ 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.