# Add a new webdomain

Adds a new webdomain and returns the created webdomain details.

## Endpoint

**POST** `/bsp/api/v1/bmp/webdomains`

## Request URL

`https://[{serverurl}](https://www.manageengine.com/products/desktop-central/help/api/cloud/oauth-authentication-endpoint-domain.html)/bsp/api/v1/bmp/webdomains`

## Scope

`DesktopCentralCloud.BrowserManager.CREATE`

## Header

`Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52`

## Request Parameters

### Request Headers

- **Content-Type** `string` — **Mandatory**  
  `application/json`

- **Accept** `string` — **Mandatory**  
  `application/json`

### Request Body

JSON body with webdomain URL and type

`application/json`

**JSON Object**

Request body for adding a new webdomain

- **webDomain** `string` — Optional  
  Website URL to add. Maximum 2048 characters.

- **type** `string` — Optional  
  Webdomain type: 2 = Domain, 4 = Subdomain, 8 = Fully-defined URL.

## Sample Request

```curl
curl --request POST \
  --url https://appdomains/bsp/api/v1/bmp/webdomains \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{}'
```

## Sample Request Body

### Add domain (type=2)

```json
{
  "webDomain": "facebook.com",
  "type": "2"
}
```

### Add subdomain (type=4)

```json
{
  "webDomain": "mail.google.com",
  "type": "4"
}
```

### Add fully-defined URL (type=8)

```json
{
  "webDomain": "https://example.com/path?q=test",
  "type": "8"
}
```

## Response Parameters

### HTTP code 200

Response Body — `application/json`

**JSON Object**

Single webdomain details response

- **webdomain_id** `integer`  
  Unique identifier of the webdomain

- **webdomain_name** `string`  
  Name of the webdomain

- **url** `string`  
  Display URL of the webdomain

### HTTP code 401

Response Body — `application/json`

**JSON Object**

- **errorCode** `long`  
  Unauthorized error code: credentials missing, expired, or invalid

- **errorMsg** `string`  
  Authentication failure reason

### HTTP code 403

Response Body — `application/json`

**JSON Object**

- **errorCode** `long`  
  Error code indicating insufficient permissions

- **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 reached threshold

- **errorMsg** `string`  
  Rate limit exceeded message with retry guidance

### HTTP code 500

Response Body — `application/json`

**JSON Object**

Internal server error when adding a webdomain

- **error_description** `string`  
  Message describing the server-side failure

- **error_code** `string`  
  Internal server error code

## Possible Response Codes

- `200` — HTTP code
- `401` — HTTP code
- `403` — HTTP code
- `429` — HTTP code
- `500` — HTTP code

## Sample Responses

### HTTP 200

#### Domain added

```json
{
  "webdomain_name": "facebook.com",
  "webdomain_id": "19",
  "url": "*.facebook.com"
}
```

#### Subdomain added

```json
{
  "webdomain_name": "mail.google.com",
  "webdomain_id": "21",
  "url": "mail.google.com"
}
```

#### Fully-defined URL added

```json
{
  "webdomain_name": "https://example.com",
  "url_params": "q=test",
  "webdomain_id": "23",
  "url": "https://example.com/path?q=test",
  "url_path": "path"
}
```

### HTTP 401

#### Unauthorized

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

### HTTP 403

#### Forbidden

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

### HTTP 429

#### Rate limit exceeded

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

### HTTP 500

#### Server error

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

## Rate Limit

![](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.