# Create a new webdomain group

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

## Endpoints

**POST** `/bsp/api/v1/bmp/webdomain-groups`

## Request URL

```text
https://{server-hostname}:8383/bsp/api/v1/bmp/webdomain-groups
```

## Scope

```text
BrowserManager.CREATE
```

## Header

```text
Authorization: d92d4xxxxxxxxxxxxx15f52
```

## Request Parameters

### Request Headers

- **Content-Type** `string` **Mandatory**: `application/json`
- **Accept** `string` **Mandatory**: `application/json`

### Request Body

JSON body with webdomain group name and description.

`application/json`

- `JSON Object`
  - **webdomain_group_name** `string` Optional: Name for the webdomain group. Required, maximum 50 characters. Must be unique per customer
  - **description** `string` Optional: Description of the webdomain group purpose. Required, maximum 100 characters

## Sample Request

```curl
curl --request POST \
  --url https://appdomain/bsp/api/v1/bmp/webdomain-groups \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"webdomain_group_name":"Social Media Sites","description":"Group containing social media webdomains"}'
```

### Sample Request Body

Create webdomain group

```json
{
  "webdomain_group_name": "Social Media Sites",
  "description": "Group containing social media webdomains"
}
```

## Response Parameters

### HTTP Code 200

Response Body — `application/json`

- `JSON Object`
  - **webdomain_group_id** `long`: Unique identifier for the webdomain group
  - **webdomain_group_name** `string`: Display name of the webdomain group. Maximum 50 characters
  - **description** `string`: Description of the webdomain group. Maximum 100 characters
  - **created_by** `string`: Username of the user who originally created this group
  - **created_time** `long`: Group creation timestamp in milliseconds since epoch
  - **last_modified_by** `string`: Username of the user who last modified this group
  - **last_modified_time** `long`: Last modification timestamp in milliseconds since epoch
  - **available_webdomains** `JSON Array`: Webdomains associated with this group. Empty for newly created groups

### HTTP Code 400

Response Body — `application/json`

- `JSON Object`
  - **error_description** `string`: Message describing the validation failure, such as name length exceeded or duplicate group name
  - **error_code** `string`: Error code for the validation failure. Absent for duplicate name errors

### HTTP Code 401

Response Body — `application/json`

- `JSON Object`
  - **errorCode** `long`: Unauthorized error code returned when authentication credentials are missing, expired, or invalid (authentication=required)
  - **errorMsg** `string`: Authentication failure reason

### HTTP Code 403

Response Body — `application/json`

- `JSON Object`
  - **errorCode** `long`: Forbidden error code returned when the authenticated user does not have the required uem-roles (e.g., DataEncryption_Admin or DataEncryptionRecoveryKey_Admin)
  - **errorMsg** `string`: Message indicating insufficient privileges to access this resource

### HTTP Code 429

Response Body — `application/json`

- `JSON Object`
  - **errorCode** `long`: Rate limit error code returned when the API call threshold (configured via threshold/duration in security XML) is exceeded; client is locked out for lock-period minutes
  - **errorMsg** `string`: Rate limit exceeded message with retry guidance

### HTTP Code 500

Response Body — `application/json`

- `JSON Object`
  - **error_description** `string`: Message describing the internal server error
  - **error_code** `string`: Error code identifying the type of server error

## Possible Response Codes

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

## Sample Response: HTTP 200

Created group

```json
{
  "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"
}
```

## Sample Response: HTTP 400

### Name length exceeded

```json
{
  "error_description": "Name length exceeded",
  "error_code": "BSP_COM0001"
}
```

### Required parameter below minimum usage

```json
{
  "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."
}
```

## Sample Response: HTTP 401

Unauthorized

```json
{
  "errorCode": "UNAUTHORIZED",
  "errorMsg": "You are not authorized to perform this action"
}
```

## Sample Response: HTTP 403

Insufficient permissions

```json
{
  "errorCode": "FORBIDDEN",
  "errorMsg": "You do not have permission to access this resource"
}
```

## Sample Response: HTTP 429

Rate limit exceeded

```json
{
  "errorCode": "RATE_LIMIT_EXCEEDED",
  "errorMsg": "You have exceeded the maximum number of API calls. Please try again later."
}
```

## Sample Response: HTTP 500

Server error

```json
{
  "error_description": "Internal Server error, Please try again in a moment.",
  "error_code": "COM0004"
}
```

![ ](https://www.zohowebstatic.com/sites/zweb/images/people/ico-help.png)

**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.