# Bulk import webdomains from CSV

Imports webdomains from a CSV file and associates them with a webdomain group.

## Endpoint

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

## Request

### Request URL

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

### 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 group details and CSV file reference

##### application/json

`JSON Object`

Request body for CSV-based bulk webdomain import

- **webdomain_group_name** `string` Optional
  - Name of the webdomain group. Maximum 50 characters.
- **description** `string` Optional
  - Description of the webdomain group. Maximum 100 characters.
- **csv_file_id** `integer` Optional
  - File ID of the uploaded CSV file to import.

### Sample Request

#### Curl

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

### Sample Request Body

#### Initiate CSV import

```json
{
  "csv_file_id": 12345,
  "webdomain_group_name": "Blocked Sites",
  "description": "Bulk imported blocked sites"
}
```

## Response Parameters

### HTTP code 200

#### Response Body — application/json

`JSON Object`

CSV import progress/status response

- **total** `string`
  - Total number of webdomains in the CSV file
- **status** `string`
  - Current import status: in_progress, success, or failed

### HTTP code 400

#### Response Body — application/json

`JSON Object`

Bad request error for CSV import validation failures

- **error_description** `string`
  - Message describing the CSV validation failure
- **error_code** `string`
  - Validation error code for the specific CSV issue

### 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`

Internal server error during CSV import processing

- **error_description** `string`
  - Message describing the server-side failure
- **error_code** `string`
  - Internal server error code

## Sample Responses

### HTTP 200

#### Import started

```json
{
  "total": "2",
  "status": "in_progress"
}
```

### HTTP 400

#### Too many entries

```json
{
  "error_description": "CSV contains more than 1000 entries",
  "error_code": "BSP_COM0023"
}
```

#### Empty file

```json
{
  "error_description": "CSV file is empty",
  "error_code": "BSP_COM0027"
}
```

### 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 Limits

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