Adds a new webdomain and returns the created webdomain details.
post /bsp/api/v1/bmp/webdomains
https://{server-hostname}:8383/bsp/api/v1/bmp/webdomains Copied!
Authorization: d92d4xxxxxxxxxxxxx15f52
JSON body with webdomain URL and type
Request body for adding a new webdomain
Website URL to add. Maximum 2048 characters.
Webdomain type: 2 = Domain, 4 = Subdomain, 8 = Fully-defined URL.
curl --request POST \
--url https://appdomain/bsp/api/v1/bmp/webdomains \
--header 'Accept: application/json' \
--header 'Authorization: d92d4xxxxxxxxxxxxx15f52' \
--header 'Content-Type: application/json' \
--data '{"webDomain":"facebook.com","type":"2"}'Add domain (type=2)
{
"webDomain": "facebook.com",
"type": "2"
}
Add subdomain (type=4)
{
"webDomain": "mail.google.com",
"type": "4"
}
Add fully-defined URL (type=8)
{
"webDomain": "https://example.com/path?q=test",
"type": "8"
}
Single webdomain details response
Unique identifier of the webdomain
Name of the webdomain
Display URL of the webdomain
Unauthorized error code: API key or OAuth token missing, expired or invalid
Authentication failure reason
Forbidden error code: the user lacks the required MDM_OSUpdateMgmt UEM role
Message indicating insufficient privileges
Rate limit error code: API call threshold exceeded for this endpoint group
Rate limit exceeded message with retry guidance
Internal server error when adding a webdomain
Message describing the server-side failure
Internal server error code
Domain added
{
"webdomain_name": "facebook.com",
"webdomain_id": "19",
"url": "*.facebook.com"
}
Subdomain added
{
"webdomain_name": "mail.google.com",
"webdomain_id": "21",
"url": "mail.google.com"
}
Fully-defined URL added
{
"webdomain_name": "https://example.com",
"url_params": "q=test",
"webdomain_id": "23",
"url": "https://example.com/path?q=test",
"url_path": "path"
}
Unauthorized
{
"errorCode": "UNAUTHORIZED",
"errorMsg": "You are not authorized to perform this action"
}
Forbidden
{
"errorCode": "FORBIDDEN",
"errorMsg": "You do not have permission to access this resource"
}
Rate limit exceeded
{
"errorCode": "RATE_LIMIT_EXCEEDED",
"errorMsg": "You have exceeded the maximum number of API calls. Please try again later."
}
Server error
{
"error_description": "Internal Server error, Please try again in a moment.",
"error_code": "COM0004"
}
![]()
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.
© 2026, Zoho Corporation Pvt. Ltd. All Rights Reserved.