Add webdomains to a webdomain group

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

Associates webdomains to a group. Replaces existing associations with the provided list.

Request URL

https://{serverurl}/bsp/api/v1/bmp/webdomain-groups/{webdomain_group_id}/webdomains

Scope

DesktopCentralCloud.BrowserManager.CREATECopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

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

- Path Parameters

webdomain_group_idstringMandatory

Web domain group ID from List WebDomain Groups or Create WebDomain Group response

- Request Body

JSON body with array of webdomain IDs to associate with the group

application/json
JSON Object
Hide Sub-Attributes
webdomain_idsarrayOptional

Web domain ID from List WebDomains or Add WebDomain response

Sample Request

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

Sample Request Body

Add webdomains to group

Copied!
  {
    "webdomain_ids": [
      107,
      108,
      109
    ]
  }
                
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 404

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

Message indicating the group or webdomain was not found

- 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
Hide Sub-Attributes
error_descriptionstring

Message describing the internal server error

error_codestring

Error code identifying the type of server error

Possible Response Codes

204HTTP code

Returns 204 No content on success

401HTTP code
403HTTP code
404HTTP code
429HTTP code
500HTTP code

Sample Response: HTTP 204

Copied!
204 Returns 204 No content on success
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

Insufficient permissions

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

Sample Response: HTTP 404

Group not found

Copied!
  {
    "error_description": "Group not found"
  }
                
Show full

Webdomain not found

Copied!
  {
    "error_description": "Site not found"
  }
                
Show full

Webdomains not found

Copied!
  {
    "error_description": "Sites not found"
  }
                
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.