Create a new 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

Creates a new webdomain group with the specified name and description.

Request URL

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

Scope

DesktopCentralCloud.BrowserManager.CREATECopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

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

- Request Body

JSON body with webdomain group name and description

application/json
JSON Object
Hide Sub-Attributes
webdomain_group_namestringOptional

Name for the webdomain group. Required, maximum 50 characters. Must be unique per customer

descriptionstringOptional

Description of the webdomain group purpose. Required, maximum 100 characters

Sample Request

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

Sample Request Body

Create webdomain group

Copied!
  {
    "webdomain_group_name": "Social Media Sites",
    "description": "Group containing social media webdomains"
  }
                
Show full

Response Parameters

- HTTP code 200

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

Unique identifier for the webdomain group

webdomain_group_namestring

Display name of the webdomain group. Maximum 50 characters

descriptionstring

Description of the webdomain group. Maximum 100 characters

created_bystring

Username of the user who originally created this group

created_timelong

Group creation timestamp in milliseconds since epoch

last_modified_bystring

Username of the user who last modified this group

last_modified_timelong

Last modification timestamp in milliseconds since epoch

available_webdomainsJSON Array

Webdomains associated with this group. Empty for newly created groups

Show Sub-Attributes
JSON Object
Show Sub-Attributes
webdomain_idlong

Unique identifier for the webdomain

webdomain_namestring

Webdomain display name

- HTTP code 400

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

Message describing the validation failure, such as name length exceeded or duplicate group name

error_codestring

Error code for the validation failure. Absent for duplicate name errors

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

Message describing the internal server error

error_codestring

Error code identifying the type of server error

Possible Response Codes

200HTTP code
400HTTP code
401HTTP code
403HTTP code
429HTTP code
500HTTP code

Sample Response: HTTP 200

Created group

Copied!
  {
    "created_time": 1741651200000,
    "last_modified_time": 1741651200000,
    "webdomain_group_id": 100,
    "webdomain_group_name": "Social Media Sites",
    "description": "Group containing social media webdomains",
    "last_modified_by": "admin",
    "available_webdomains": [],
    "created_by": "admin"
  }
                
Show full

Sample Response: HTTP 400

Name length exceeded

Copied!
  {
    "error_description": "Name length exceeded",
    "error_code": "BSP_COM0001"
  }
                
Show full

Required parameter below minimum usage

Copied!
  {
    "errorCode": "IAM0021",
    "url": "/bsp/api/v1/bmp/webdomain-groups/{web_domain_id}",
    "errorMsg": "The number of times the parameter webdomain_group_name used is below the minimum requirement."
  }
                
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 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.