Creates a new IP scope for the customer. Supports range type (start-end IP) or subnet type (network address + mask).
https://{serverurl}/dcapi/som/ip-scopes
Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
Unique Identifier of the remote office this IP scope will assigned to. Fetch 'resource_id' from Get Remote Offices api
Type of IP scope definition. Allowed values: 'RANGE' (start-to-end IP address range) or 'SUBNET' (network address with subnet mask)
Indicates the subnet class classification. Permitted values: A, B, or C. Required only when ipScopeType is 'SUBNET'
The network address of the subnet (for example, 192.168.1.0). This field is required when ipScopeType is set to 'SUBNET'
Subnet mask for the network (e.g., '255.255.255.0'). Required only when ipScopeType is 'SUBNET'
Specifies the starting IP address of the range (for example, 192.168.1.1). Required only when ipScopeType is 'RANGE'
Specifies the ending IP address of the range (for example, 192.168.1.254). Required only when ipScopeType is 'RANGE'
Optional administrator-provided description for the IP scope (max 250 characters)
curl --request POST \
--url https://appdomains/dcapi/som/ip-scopes \
--header 'Accept: application/ipScopeAddedStatus.v1+json' \
--header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52' \
--header 'Content-Type: application/ipScopeDetail.v1+json' \
--data '{}'Add IP scope with range type
{
"description": "HQ Network Range",
"remoteOfficeID": "101",
"ipScopeType": "RANGE",
"startIPAddress": "192.168.1.1",
"endIPAddress": "192.168.1.254"
}
Add IP scope with subnet type
{
"subnetClass": "C",
"description": "Branch Office Subnet",
"remoteOfficeID": "102",
"ipScopeType": "SUBNET",
"subnetMask": "255.255.255.0",
"networkAddress": "10.0.1.0"
}
Indicates whether the IP scope operation (create, update, or delete) completed successfully
Descriptive message providing details about the operation outcome or the reason for failure
Error code indicating insufficient permissions
Message indicating insufficient privileges to access this resource
HTTP status code (404)
Error code identifying the resource that was not found
Error message describing the missing resource
HTTP status code (412)
Precondition failed error code identifying the business logic violation
Error message describing the precondition failed while processing request
IP scope created
{
"message": "success",
"status": true
}
Branch office not accessible by user
{
"errorCode": "20011",
"message": "Forbidden Access",
"statusCode": 403
}
Remote office not found for given remoteOfficeID
{
"errorCode": "30028",
"message": "Remote office not found",
"statusCode": 404
}
Required IP scope parameters are missing
{
"errorCode": "30022",
"message": "Required IP scope parameters are missing",
"statusCode": 412
}
IP scope with same range already exists
{
"errorCode": "30023",
"message": "An IP scope with the same range already exists",
"statusCode": 412
}
Invalid IP range or subnet mask
{
"errorCode": "30086",
"message": "Invalid IP range or subnet mask parameters",
"statusCode": 412
}
![]()
Duration: 1 minute | Threshold: 30 | 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.