# Add a new Web Clips payload configuration to an existing profile

To create Web Clips policy

## Endpoint

**POST** `/api/v1/mdm/profiles/{profile_id}/payloads/webclipspolicy`

## Request URL

`https://{server-hostname}:8383/api/v1/mdm/profiles/{profile_id}/payloads/webclipspolicy`

## Scope

`MDMDeviceMgmt.CREATE`

## Header

`Authorization: d92d4xxxxxxxxxxxxx15f52`

## Request Parameters

### Request Headers

| Parameter | Type | Required | Value |
|---|---|---|---|
| Content-Type | string | Mandatory | `application/json` |
| Accept | string | Mandatory | `application/json` |

### Path Parameters

| Parameter | Type | Required | Description |
|---|---|---|---|
| profile_id | string | Mandatory | Unique identifier of the profile. Obtain from the [Create Profile](https://www.manageengine.com/products/desktop-central/help/api/onpremise/mdm-profiles-create-profile.html) or [Get Profiles](https://www.manageengine.com/products/desktop-central/help/api/onpremise/mdm-profiles-get-profile.html) response |

### Request Body

`application/json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| webclip_label | string | Mandatory | Webclip Label |
| webclip_name | string | Mandatory | Webclip Name |
| webclip_url | string | Mandatory | Webclip Url |
| is_removal | boolean | Optional | Is Removal. Default: true |
| webclips_file_upload | long | Optional | Webclips File Upload. Use the fileID from the [File Upload API](https://www.manageengine.com/products/desktop-central/help/api/onpremise/files-upload-file-ems.html) response |
| icon_file_name | string | Optional | Icon File Name |
| use_precomp_icon | boolean | Optional | Use Precomp Icon. Default: false |
| allow_full_screen | boolean | Optional | Allow Full Screen. Default: false |
| webclip_policy_id | long | Optional | Webclip Policy Id |
| allow_site_permission | boolean | Optional | Allow Site Permission. Default: false |

## Sample Request

```curl
curl --request POST \
  --url https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/webclipspolicy \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"webclip_url":"https://zylker.com","is_removal":true,"allow_site_permission":false,"webclip_label":"value","webclip_policy_id":1,"webclips_file_upload":"value","webclip_name":"Zylker User","use_precomp_icon":false,"icon_file_name":"value","allow_full_screen":false}'
```

## Sample Request Body

Add Web Clips payload to the profile

```json
{
  "webclip_url": "https://zylker.com",
  "is_removal": true,
  "allow_site_permission": false,
  "webclip_label": "value",
  "webclip_policy_id": 1,
  "webclips_file_upload": "value",
  "webclip_name": "Zylker User",
  "use_precomp_icon": false,
  "icon_file_name": "value",
  "allow_full_screen": false
}
```

## Response Parameters

### HTTP Code 200

Response Body — `application/json`

| Parameter | Type | Description |
|---|---|---|
| payload_id | long | Unique identifier for the created payload item |
| webclip_label | string | Webclip Label |
| webclip_name | string | Webclip Name |
| webclip_url | string | Webclip Url |
| is_removal | boolean | Is Removal. Default: true |
| webclips_file_upload | long | Webclips File Upload. Use the fileID from the [File Upload API](https://www.manageengine.com/products/desktop-central/help/api/onpremise/files-upload-file-ems.html) response |
| icon_file_name | string | Icon File Name |
| use_precomp_icon | boolean | Use Precomp Icon. Default: false |
| allow_full_screen | boolean | Allow Full Screen. Default: false |
| webclip_policy_id | long | Webclip Policy Id |
| allow_site_permission | boolean | Allow Site Permission. Default: false |

## Possible Response Codes

| Code | Type |
|---|---|
| 200 | HTTP code |

## Sample Response: HTTP 200

Web Clips payload successfully added

```json
{
  "webclip_url": "https://zylker.com",
  "payload_id": 9007199254741000,
  "is_removal": true,
  "allow_site_permission": false,
  "webclip_label": "value",
  "webclip_policy_id": 1,
  "webclips_file_upload": "value",
  "webclip_name": "Zylker User",
  "use_precomp_icon": false,
  "icon_file_name": "value",
  "allow_full_screen": false
}
```

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

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