# Add a new Wi-Fi payload configuration to an existing profile

Create Windows Wifi policy payload

## Endpoint

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

## Request

### Request URL

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

### Scope

```text
MDMDeviceMgmt.CREATE
```

### Header

```text
Authorization: d92d4xxxxxxxxxxxxx15f52
```

### Request Parameters

#### Request Headers

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

#### Path Parameters

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

- `JSON Object`
  - **sub_config** `string` — Optional  
    Sub Config. Default: WIFI_NON_ENTERPRISE
  - **service_set_identifier** `string` — **Mandatory**  
    Service Set Identifier
  - **auto_join** `boolean` — Optional  
    Auto Join. Default: true
  - **security_type** `integer` — **Mandatory**  
    Security Type. Default: 0
  - **wifi_non_enterprise** `JSON Object` — Optional  
    Wifi Non Enterprise
  - **wifi_enterprise** `JSON Object` — Optional  
    Wifi Enterprise
  - **proxy_type** `integer` — Optional  
    Proxy Type. Default: 0
  - **proxy_server** `string` — Optional  
    Proxy Server
  - **proxy_server_port** `integer` — Optional  
    Proxy Server Port. Default: 0
  - **hidden_network** `boolean` — **Mandatory**  
    Hidden Network. Default: false
  - **proxy_user_name** `string` — Optional  
    Proxy User Name
  - **proxy_password** `string` — Optional  
    Proxy Password (sensitive - write-only)
  - **proxy_password_id** `long` — Optional  
    Proxy Password Id
  - **proxy_pac_url** `string` — Optional  
    Proxy Pac Url
  - **bypass_proxy_url** `string` — Optional  
    Bypass Proxy Url

### Sample Request

```curl
curl --request POST \
  --url https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/windowswifipolicy \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"wifi_non_enterprise":{},"sub_config":"WIFI_NON_ENTERPRISE","wifi_enterprise":{},"proxy_server":"value","auto_join":true,"proxy_server_port":0,"hidden_network":false,"service_set_identifier":"value","security_type":0,"proxy_type":0}'
```

### Sample Request Body

#### Add Wi-Fi payload to the profile (Open / no authentication, security_type=0)

```json
{
  "wifi_non_enterprise": {},
  "sub_config": "WIFI_NON_ENTERPRISE",
  "wifi_enterprise": {},
  "proxy_server": "value",
  "auto_join": true,
  "proxy_server_port": 0,
  "hidden_network": false,
  "service_set_identifier": "value",
  "security_type": 0,
  "proxy_type": 0
}
```

#### Add Wi-Fi payload with WPA/WPA2-Personal authentication

```json
{
  "wifi_non_enterprise": {
    "password": "value"
  },
  "sub_config": "WIFI_NON_ENTERPRISE",
  "wifi_enterprise": {},
  "proxy_server": "value",
  "auto_join": true,
  "proxy_server_port": 0,
  "hidden_network": false,
  "service_set_identifier": "value",
  "security_type": 1,
  "proxy_type": 0
}
```

#### Add Wi-Fi payload with WPA/WPA2-Enterprise using EAP-PEAP with inner MSCHAPv2

```json
{
  "wifi_non_enterprise": {},
  "sub_config": "WIFI_ENTERPRISE",
  "wifi_enterprise": {
    "peap": true,
    "certificate_id": 9007199254741100,
    "inner_identity": 3,
    "password": "value",
    "outer_identity": "",
    "user_name": "value",
    "tls": false,
    "dont_validate": false,
    "use_per_connection_pwd": false,
    "identity_certificate_id": -1
  },
  "proxy_server": "value",
  "auto_join": true,
  "proxy_server_port": 0,
  "hidden_network": false,
  "service_set_identifier": "value",
  "security_type": 2,
  "proxy_type": 0
}
```

#### Add Wi-Fi payload with WPA/WPA2-Enterprise using EAP-TLS

```json
{
  "wifi_non_enterprise": {},
  "sub_config": "WIFI_ENTERPRISE",
  "wifi_enterprise": {
    "peap": false,
    "certificate_id": 9007199254741100,
    "outer_identity": "",
    "user_name": "value",
    "tls": true,
    "dont_validate": false,
    "identity_certificate_id": 9007199254741102
  },
  "proxy_server": "value",
  "auto_join": true,
  "proxy_server_port": 0,
  "hidden_network": false,
  "service_set_identifier": "value",
  "security_type": 2,
  "proxy_type": 0
}
```

## Response

### HTTP Code 200

#### Response Body

`application/json`

- `JSON Object`
  - **payload_id** `long`  
    Unique identifier for the created payload item
  - **sub_config** `string`  
    Sub Config. Default: WIFI_NON_ENTERPRISE
  - **service_set_identifier** `string`  
    Service Set Identifier
  - **auto_join** `boolean`  
    Auto Join. Default: true
  - **security_type** `integer`  
    Security Type. Default: 0
  - **wifi_non_enterprise** `JSON Object`  
    Wifi Non Enterprise
  - **wifi_enterprise** `JSON Object`  
    Wifi Enterprise
  - **proxy_type** `integer`  
    Proxy Type. Default: 0
  - **proxy_server** `string`  
    Proxy Server
  - **proxy_server_port** `integer`  
    Proxy Server Port. Default: 0
  - **hidden_network** `boolean`  
    Hidden Network. Default: false
  - **proxy_user_name** `string`  
    Proxy User Name
  - **proxy_password** `string`  
    Proxy Password (sensitive - write-only)
  - **proxy_password_id** `long`  
    Proxy Password Id
  - **proxy_pac_url** `string`  
    Proxy Pac Url
  - **bypass_proxy_url** `string`  
    Bypass Proxy Url

### Possible Response Codes

- **200** — HTTP code

### Sample Response: HTTP 200

#### Wi-Fi payload successfully added

```json
{
  "payload_id": 9007199254741000,
  "wifi_non_enterprise": {},
  "sub_config": "WIFI_NON_ENTERPRISE",
  "wifi_enterprise": {},
  "proxy_server": "value",
  "auto_join": true,
  "proxy_server_port": 0,
  "hidden_network": false,
  "service_set_identifier": "value",
  "security_type": 0,
  "proxy_type": 0
}
```

## Rate Limit

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