Process a web category override request

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

Processes a web category override request by approving or blocking a website. Updates the customized category list and pushes changes to managed devices.

Request URL

https://{serverurl}/bsp/api/v1/bmp/webcategories/override

Scope

DesktopCentralCloud.BrowserManager.CREATECopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

Content-TypestringMandatory
application/jsonapplication/jsonCopied!
AcceptstringMandatory
application/jsonapplication/jsonCopied!

- Request Body

Override request with approve/deny action and optional re-categorization

application/json
JSON Object

Request body for category override

Hide Sub-Attributes
request_idintegerOptional

Override request ID. Required.

is_approvedstringOptional

1 = approve (allow), 0 = deny (block). Required.

suggested_categoryintegerOptional

Category ID to re-assign. 1-News, 2-Technology, 3-Entertainment, 4-Education, 5-Personal and Hobbies, 6-Health and Medicine, 7-Shopping, 8-Business, 9-Social Media, 10-Sports, 11-Finance, 12-Streaming, 13-Blogs, 14-Government and Legal, 15-Gambling, 16-Adult, 17-Pornography, 18-Hacking and Illicit Activities, 19-Job Search and Career Development, 20-Others. Use -1 for no re-assignment. Optional.

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request POST \
  --url https://appdomains/bsp/api/v1/bmp/webcategories/override \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{}'

Sample Request Body

Deny and block website

Copied!
  {
    "is_approved": 0,
    "suggested_category": -1,
    "request_id": 107
  }
                
Show full

Approve, allow and re-categorize to Personal and Hobbies (id=5)

Copied!
  {
    "is_approved": 1,
    "suggested_category": 5,
    "request_id": 108
  }
                
Show full

Response Parameters

- HTTP code 204

Response Body - application/json

- HTTP code 401

Response Body - application/json
JSON Object
Hide Sub-Attributes
errorCodelong

Unauthorized error code: credentials missing, expired, or invalid

errorMsgstring

Authentication failure reason

- HTTP code 403

Response Body - application/json
JSON Object
Hide Sub-Attributes
errorCodelong

Error code indicating insufficient permissions

errorMsgstring

Message indicating insufficient privileges to access this resource

- HTTP code 429

Response Body - application/json
JSON Object
Hide Sub-Attributes
errorCodelong

Rate limit error code returned when the API call reached threshold

errorMsgstring

Rate limit exceeded message with retry guidance

- HTTP code 500

Response Body - application/json
JSON Object

Server error for Update Category Override

Hide Sub-Attributes
error_descriptionstring

Server error message

error_codestring

Server error code

Possible Response Codes

204HTTP code
401HTTP code
403HTTP code
429HTTP code
500HTTP code

Sample Response: HTTP 204

Copied!
204 No Content
Show full

Sample Response: HTTP 401

Unauthorized

Copied!
  {
    "errorCode": "UNAUTHORIZED",
    "errorMsg": "You are not authorized to perform this action"
  }
                
Show full

Sample Response: HTTP 403

Forbidden

Copied!
  {
    "errorCode": "FORBIDDEN",
    "errorMsg": "You do not have permission to access this resource"
  }
                
Show full

Sample Response: HTTP 429

Rate limit exceeded

Copied!
  {
    "errorCode": "RATE_LIMIT_EXCEEDED",
    "errorMsg": "You have exceeded the maximum number of API calls. Please try again later."
  }
                
Show full

Sample Response: HTTP 500

Server error

Copied!
  {
    "error_description": "Internal Server error, Please try again in a moment.",
    "error_code": "COM0004"
  }
                
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.