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

To modify Email policy payload item

## Endpoint

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

## Request URL

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

## Scope

`MDMDeviceMgmt.UPDATE`

## 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 |
| 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/ios-get-email-payload-ios.html) response |

### Request Body

`application/json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| account_name | string | Optional | Account Name |
| account_type | string | Optional | Account Type. Default: IMAP |
| account_path_prefix | string | Optional | Account Path Prefix |
| account_user_name | string | Optional | Account User Name |
| mail_address | string | Optional | Mail Address |
| allow_move | boolean | Optional | Allow Move. Default: true |
| prevent_move | boolean | Optional | Prevent Move. Default: false |
| disable_mail_recents_syncing | boolean | Optional | Disable Mail Recents Syncing. Default: false |
| incoming_server_hostname | string | Mandatory | Incoming Server Hostname |
| incoming_server_port | integer | Optional | Incoming Server Port. Default: 143 |
| incoming_server_username | string | Mandatory | Incoming Server Username |
| incoming_server_auth | string | Mandatory | Incoming Server Auth. Allowed values: none, password, md5, ntlm, httpmd5. Default: password |
| incoming_password | string | Optional | Incoming Password (sensitive - write-only) |
| incoming_password_id | long | Optional | Incoming Password Id |
| incoming_server_use_ssl | boolean | Optional | Incoming Server Use Ssl. Default: false |
| outgoing_server_hostname | string | Mandatory | Outgoing Server Hostname |
| outgoing_server_port | integer | Optional | Outgoing Server Port. Default: 587 |
| outgoing_server_username | string | Mandatory | Outgoing Server Username |
| outgoing_server_auth | string | Mandatory | Outgoing Server Auth. Allowed values: none, password, md5, ntlm, httpmd5. Default: password |
| outgoing_password | string | Optional | Outgoing Password (sensitive - write-only) |
| outgoing_password_id | long | Optional | Outgoing Password Id |
| outgoing_pwd_as_income_pwd | boolean | Optional | Outgoing Pwd As Income Pwd. Default: false |
| use_only_mail_app | boolean | Optional | Use Only Mail App. Default: false |
| outgoing_server_use_ssl | boolean | Optional | Outgoing Server Use Ssl. Default: false |
| use_mime_encrypt | boolean | Optional | Use Mime Encrypt. Default: false |
| signing_cert_id | long | Optional | Signing identity certificate ID obtained from the [Certificates API](https://www.manageengine.com/products/desktop-central/help/api/onpremise/certificates-get-certificates.html). |
| encryption_cert_id | long | Optional | Encryption identity certificate ID obtained from the [Certificates API](https://www.manageengine.com/products/desktop-central/help/api/onpremise/certificates-get-certificates.html). |

## Sample Request

```curl
curl --request PUT \
  --url https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/emailpolicy/payloaditems/{payload_id} \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"prevent_move":false,"account_type":"IMAP","disable_mail_recents_syncing":false,"incoming_server_username":"user@zylker.com","outgoing_server_username":"user@zylker.com","allow_move":true,"incoming_server_hostname":"https://zylker.com","outgoing_server_hostname":"smtp.zylker.com","account_user_name":"Zylker User","account_path_prefix":"value","account_name":"Zylker User","incoming_server_auth":"password","mail_address":"user@zylker.com","outgoing_server_auth":"password","incoming_server_port":143}'
```

## Sample Request Body

Modify Email payload item

```json
{
  "prevent_move": false,
  "account_type": "IMAP",
  "disable_mail_recents_syncing": false,
  "incoming_server_username": "user@zylker.com",
  "outgoing_server_username": "user@zylker.com",
  "allow_move": true,
  "incoming_server_hostname": "https://zylker.com",
  "outgoing_server_hostname": "smtp.zylker.com",
  "account_user_name": "Zylker User",
  "account_path_prefix": "value",
  "account_name": "Zylker User",
  "incoming_server_auth": "password",
  "mail_address": "user@zylker.com",
  "outgoing_server_auth": "password",
  "incoming_server_port": 143
}
```

## Response Parameters

### HTTP Code 200

Response Body — `application/json`

| Parameter | Type | Description |
|---|---|---|
| payload_id | long | Unique identifier of the payload item |
| account_name | string | Account Name |
| account_type | string | Account Type. Default: IMAP |
| account_path_prefix | string | Account Path Prefix |
| account_user_name | string | Account User Name |
| mail_address | string | Mail Address |
| allow_move | boolean | Allow Move. Default: true |
| prevent_move | boolean | Prevent Move. Default: false |
| disable_mail_recents_syncing | boolean | Disable Mail Recents Syncing. Default: false |
| incoming_server_hostname | string | Incoming Server Hostname |
| incoming_server_port | integer | Incoming Server Port. Default: 143 |
| incoming_server_username | string | Incoming Server Username |
| incoming_server_auth | string | Incoming Server Auth. Allowed values: none, password, md5, ntlm, httpmd5. Default: password |
| incoming_password | string | Incoming Password (sensitive - write-only) |
| incoming_password_id | long | Incoming Password Id |
| incoming_server_use_ssl | boolean | Incoming Server Use Ssl. Default: false |
| outgoing_server_hostname | string | Outgoing Server Hostname |
| outgoing_server_port | integer | Outgoing Server Port. Default: 587 |
| outgoing_server_username | string | Outgoing Server Username |
| outgoing_server_auth | string | Outgoing Server Auth. Allowed values: none, password, md5, ntlm, httpmd5. Default: password |
| outgoing_password | string | Outgoing Password (sensitive - write-only) |
| outgoing_password_id | long | Outgoing Password Id |
| outgoing_pwd_as_income_pwd | boolean | Outgoing Pwd As Income Pwd. Default: false |
| use_only_mail_app | boolean | Use Only Mail App. Default: false |
| outgoing_server_use_ssl | boolean | Outgoing Server Use Ssl. Default: false |
| use_mime_encrypt | boolean | Use Mime Encrypt. Default: false |
| signing_cert_id | long | Signing identity certificate ID obtained from the [Certificates API](https://www.manageengine.com/products/desktop-central/help/api/onpremise/certificates-get-certificates.html). |
| encryption_cert_id | long | Encryption identity certificate ID obtained from the [Certificates API](https://www.manageengine.com/products/desktop-central/help/api/onpremise/certificates-get-certificates.html). |

### Possible Response Codes

| Code | Description |
|---|---|
| 200 | HTTP code |

## Sample Response: HTTP 200

Email payload item successfully modified

```json
{
  "prevent_move": false,
  "payload_id": 9007199254741000,
  "account_type": "IMAP",
  "disable_mail_recents_syncing": false,
  "incoming_server_username": "user@zylker.com",
  "outgoing_server_username": "user@zylker.com",
  "allow_move": true,
  "incoming_server_hostname": "https://zylker.com",
  "outgoing_server_hostname": "smtp.zylker.com",
  "account_user_name": "Zylker User",
  "account_path_prefix": "value",
  "account_name": "Zylker User",
  "incoming_server_auth": "password",
  "mail_address": "user@zylker.com",
  "outgoing_server_auth": "password",
  "incoming_server_port": 143
}
```

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