# Modify the configuration of a Hello payload item within a profile

Modify Windows Hello policy payload

## Endpoint

`PUT /api/v1/mdm/profiles/{profile_id}/payloads/windowshellopolicy/payloaditems/{payload_id}`

## Request

### Request URL

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

### Scope

```text
MDMDeviceMgmt.UPDATE
```

### Header

```text
Authorization: d92d4xxxxxxxxxxxxx15f52
```

### Request Parameters

#### Request Headers

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

#### Path Parameters

| Name | 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 |
| payload_id | string | Mandatory | Unique identifier of the payload item. Obtain from the [Get Payload Item IDs](https://www.manageengine.com/products/desktop-central/help/api/onpremise/windows-get-hello-payload.html) response |

#### Request Body

`application/json`

| Attribute | Type | Required | Description |
|---|---|---|---|
| tenant_id | string | Optional | Tenant Id. Default: -1 |
| enable_pfw | boolean | Optional | Enable Pfw |
| allow_digits | integer | Optional | Allow Digits |
| allow_uppercase_letter | integer | Optional | Allow Uppercase Letter |
| allow_lowercase_letter | integer | Optional | Allow Lowercase Letter |
| allow_special_chars | integer | Optional | Allow Special Chars |
| min_pin_length | integer | Optional | Min Pin Length |
| max_pin_length | integer | Optional | Max Pin Length |
| enable_pin_recovery | boolean | Optional | Enable Pin Recovery |
| pin_history | integer | Optional | Pin History |
| pin_expiry | integer | Optional | Pin Expiry |
| enable_biometrics | boolean | Optional | Enable Biometrics |
| allow_security_key | integer | Optional | Allow Security Key |
| enable_device_unlock | boolean | Optional | Enable Device Unlock |
| enable_device_lock | boolean | Optional | Enable Device Lock |
| allow_companion_device | boolean | Optional | Allow Companion Device |
| allow_tpm | boolean | Optional | Allow Tpm |
| enable_anti_spoof | string | Optional | Enable Anti Spoof |
| device_unlock_config | JSON Array | Optional | Device Unlock Config |
| tfa_bluetooth | JSON Object | Optional | Tfa Bluetooth |
| tfa_wifi | JSON Array | Optional | Tfa Wifi |

### Sample Request

```bash
curl --request PUT \
  --url https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/windowshellopolicy/payloaditems/{payload_id} \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"tenant_id":"-1","allow_security_key":"0","enable_biometrics":false,"enable_anti_spoof":false,"enable_pfw":false,"enable_device_unlock":false,"enable_device_lock":false}'
```

### Sample Request Body

#### Modify Hello payload item (PIN Policy Disabled)

```json
{
  "tenant_id": "-1",
  "allow_security_key": "0",
  "enable_biometrics": false,
  "enable_anti_spoof": false,
  "enable_pfw": false,
  "enable_device_unlock": false,
  "enable_device_lock": false
}
```

#### Modify Hello payload item (PIN Policy Enabled)

```json
{
  "tenant_id": "749fd9b3-b71e-4210-a8ff-ea830c4c5135",
  "max_pin_length": "127",
  "allow_companion_device": false,
  "allow_uppercase_letter": "0",
  "enable_anti_spoof": false,
  "allow_special_chars": "0",
  "enable_device_unlock": false,
  "allow_lowercase_letter": "0",
  "allow_tpm": false,
  "pin_history": "0",
  "min_pin_length": "6",
  "pin_expiry": "0",
  "allow_security_key": "0",
  "enable_biometrics": false,
  "allow_digits": "0",
  "enable_pfw": true,
  "enable_device_lock": false,
  "enable_pin_recovery": false
}
```

#### Modify Hello payload item (TFA Configured)

```json
{
  "tenant_id": "-1",
  "allow_security_key": "0",
  "device_unlock_config": [
    {
      "factor_type": "1",
      "credential_provider_id": "1"
    },
    {
      "factor_type": "1",
      "credential_provider_id": "0"
    },
    {
      "factor_type": "2",
      "credential_provider_id": "2"
    },
    {
      "factor_type": "2",
      "credential_provider_id": "3"
    }
  ],
  "tfa_bluetooth": {
    "auth_scenario": 0,
    "class_of_device": 3
  },
  "enable_biometrics": false,
  "enable_anti_spoof": false,
  "enable_pfw": false,
  "enable_device_unlock": true,
  "tfa_wifi": [
    {
      "wifi_ssid": "Dummy WiFI",
      "wifi_security_type": "5"
    }
  ],
  "enable_device_lock": false
}
```

## Response

### HTTP 200

#### Response Body

`application/json`

| Attribute | Type | Description |
|---|---|---|
| payload_id | long | Unique identifier of the payload item |
| tenant_id | string | Tenant Id. Default: -1 |
| enable_pfw | boolean | Enable Pfw |
| allow_digits | integer | Allow Digits |
| allow_uppercase_letter | integer | Allow Uppercase Letter |
| allow_lowercase_letter | integer | Allow Lowercase Letter |
| allow_special_chars | integer | Allow Special Chars |
| min_pin_length | integer | Min Pin Length |
| max_pin_length | integer | Max Pin Length |
| enable_pin_recovery | boolean | Enable Pin Recovery |
| pin_history | integer | Pin History |
| pin_expiry | integer | Pin Expiry |
| enable_biometrics | boolean | Enable Biometrics |
| allow_security_key | integer | Allow Security Key |
| enable_device_unlock | boolean | Enable Device Unlock |
| enable_device_lock | boolean | Enable Device Lock |
| allow_companion_device | boolean | Allow Companion Device |
| allow_tpm | boolean | Allow Tpm |
| enable_anti_spoof | string | Enable Anti Spoof |
| device_unlock_config | JSON Array | Device Unlock Config |
| tfa_bluetooth | JSON Object | Tfa Bluetooth |
| tfa_wifi | JSON Array | Tfa Wifi |

### Possible Response Codes

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

### Sample Response: HTTP 200

#### Hello payload item successfully modified

```json
{
  "tenant_id": "-1",
  "max_pin_length": 1,
  "payload_id": 9007199254741000,
  "allow_uppercase_letter": 1,
  "allow_digits": 1,
  "enable_pfw": true,
  "allow_special_chars": 1,
  "allow_lowercase_letter": 1,
  "pin_history": 1,
  "min_pin_length": 1,
  "enable_pin_recovery": true
}
```

#### Hello payload item successfully modified (PIN Policy Enabled)

```json
{
  "tenant_id": "749fd9b3-b71e-4210-a8ff-ea830c4c5135",
  "max_pin_length": "127",
  "payload_id": "9007199254741295",
  "allow_companion_device": false,
  "allow_uppercase_letter": "0",
  "enable_anti_spoof": false,
  "allow_special_chars": "0",
  "enable_device_unlock": false,
  "allow_lowercase_letter": "0",
  "allow_tpm": false,
  "pin_history": "0",
  "min_pin_length": "6",
  "pin_expiry": "0",
  "allow_security_key": "0",
  "enable_biometrics": false,
  "allow_digits": "0",
  "enable_pfw": true,
  "enable_device_lock": false,
  "enable_pin_recovery": false
}
```

#### Hello payload item successfully modified (PIN Policy Disabled)

```json
{
  "tenant_id": "-1",
  "max_pin_length": "4",
  "payload_id": "9007199254741295",
  "allow_companion_device": false,
  "allow_uppercase_letter": "2",
  "enable_anti_spoof": false,
  "allow_special_chars": "2",
  "enable_device_unlock": false,
  "allow_lowercase_letter": "2",
  "allow_tpm": false,
  "pin_history": "0",
  "min_pin_length": "4",
  "pin_expiry": "0",
  "allow_security_key": "0",
  "enable_biometrics": false,
  "allow_digits": "1",
  "enable_pfw": false,
  "enable_device_lock": false,
  "enable_pin_recovery": false
}
```

#### Hello payload item with TFA successfully modified

```json
{
  "tenant_id": "-1",
  "max_pin_length": "4",
  "payload_id": "9007199254741295",
  "allow_companion_device": false,
  "device_unlock_config": [
    {
      "factor_type": "1",
      "credential_provider_id": "1"
    },
    {
      "factor_type": "1",
      "credential_provider_id": "0"
    },
    {
      "factor_type": "2",
      "credential_provider_id": "2"
    },
    {
      "factor_type": "2",
      "credential_provider_id": "3"
    }
  ],
  "allow_uppercase_letter": "2",
  "enable_anti_spoof": false,
  "allow_special_chars": "2",
  "enable_device_unlock": true,
  "allow_lowercase_letter": "2",
  "allow_tpm": false,
  "pin_history": "0",
  "min_pin_length": "4",
  "pin_expiry": "0",
  "allow_security_key": "0",
  "tfa_bluetooth": {
    "auth_scenario": "0",
    "class_of_device": "3"
  },
  "enable_biometrics": false,
  "allow_digits": "1",
  "enable_pfw": false,
  "tfa_wifi": [
    {
      "wifi_ssid": "Dummy WiFI",
      "wifi_security_type": "5"
    }
  ],
  "enable_device_lock": false,
  "enable_pin_recovery": false
}
```

## Rate Limits

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