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

To modify Email policy payload item

## Endpoints

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

## Request URL

```
https://{serverurl}/api/v1/mdm/profiles/{profile_id}/payloads/emailpolicy/payloaditems/{payload_id}
```

## Scope

```
MDMOnDemand.MDMDeviceMgmt.UPDATE
```

## Header

```
Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
```

## Request Parameters

### Path Parameters

- **profile_id** (string) — Mandatory  
  Unique identifier of the profile. Obtain from the [Create Profile](https://www.manageengine.com/mobile-device-management/help/api/cloud/profiles-create-profile.html) or [Get Profiles](https://www.manageengine.com/mobile-device-management/help/api/cloud/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/mobile-device-management/help/api/cloud/ios-get-email-payload-ios.html) response.

### Query Parameters

- **t** (long) — Optional
- **ignoreHeader** (boolean) — Optional
- **qlt** (long) — Optional
- **previousTab** (string) — Optional
- **service** (string) — Optional
- **search** (string) — Optional  
  Free-text search string applied to the default searchable fields of the resource.
- **all** (boolean) — Optional
- **dc_customerid** (long) — Optional
- **mdm_instance** (string) — Optional
- **signupsrc** (string) — Optional
- **zaaid** (string) — Optional
- **command** (string) — Optional
- **orderby** (string) — Optional
- **sortorder** (string) — Optional
- **select_all** (boolean) — Optional  
  When true, applies the operation to every record matching the current filter rather than to specific IDs. Default: false.
- **zoho-internal** (boolean) — Optional
- **dc_instance** (string) — Optional
- **SUBREQUEST** (string) — Optional
- **source** (string) — Optional
- **nocache** (long) — Optional  
  Param to avoid being served from cache.
- **wms_csrparam** (string) — Optional  
  CSRF Token

### Request Body

`application/json`

**JSON object**

#### Attributes

- **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/mobile-device-management/help/api/cloud/certificates-get-certificates.html).

- **encryption_cert_id** (long) — Optional  
  Encryption identity certificate ID obtained from the [Certificates API](https://www.manageengine.com/mobile-device-management/help/api/cloud/certificates-get-certificates.html).

## Sample Request

### Curl

```bash
curl --request PUT \
  --url https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/emailpolicy/payloaditems/{payload_id} \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'content-type: application/json' \
  --data '{"incoming_server_username":"user@zylker.com","outgoing_server_username":"user@zylker.com","incoming_server_hostname":"https://zylker.com","incoming_server_auth":"password","outgoing_server_hostname":"smtp.zylker.com","outgoing_server_auth":"password"}'
```

### Java

```java
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.io.IOException;
import java.net.http.HttpTimeoutException;

public class Main {
  public static void main(String[] args) {

    HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create("https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/emailpolicy/payloaditems/{payload_id}"))
        .header("content-type", "application/json")
        .header("Authorization", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
        .method("PUT", HttpRequest.BodyPublishers.ofString("{\"incoming_server_username\":\"user@zylker.com\",\"outgoing_server_username\":\"user@zylker.com\",\"incoming_server_hostname\":\"https://zylker.com\",\"incoming_server_auth\":\"password\",\"outgoing_server_hostname\":\"smtp.zylker.com\",\"outgoing_server_auth\":\"password\"}"))
        .build();
    HttpResponse<String> response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());

  }
}
```

### Python

```python
import http.client

conn = http.client.HTTPSConnection("appdomain")

payload = "{\"incoming_server_username\":\"user@zylker.com\",\"outgoing_server_username\":\"user@zylker.com\",\"incoming_server_hostname\":\"https://zylker.com\",\"incoming_server_auth\":\"password\",\"outgoing_server_hostname\":\"smtp.zylker.com\",\"outgoing_server_auth\":\"password\"}"

headers = {
    'content-type': "application/json",
    'Authorization': "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52"
}

conn.request("PUT", "/api/v1/mdm/profiles/{profile_id}/payloads/emailpolicy/payloaditems/{payload_id}", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
```

### Deluge

```javascript
headersMap = Map();
headersMap.put("Content-Type", "application/json");
headersMap.put("Accept", "application/json");

data=Map();
data.put("incoming_server_username","value");
data.put("outgoing_server_username","value");
data.put("incoming_server_hostname","value");
data.put("incoming_server_auth","value");
data.put("outgoing_server_hostname","value");
data.put("outgoing_server_auth","value");

response = invokeUrl
[
    url: "https://appDomain/api/v1/mdm/profiles/{profile_id}/payloads/emailpolicy/payloaditems/{payload_id}"
    type: PUT
    headers: headersMap
    body: data
    connection: connection_name
]

info response;
```

### PowerShell

```powershell
$headers=@{}
$headers.Add("content-type", "application/json")
$headers.Add("Authorization", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/emailpolicy/payloaditems/{payload_id}' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{"incoming_server_username":"user@zylker.com","outgoing_server_username":"user@zylker.com","incoming_server_hostname":"https://zylker.com","incoming_server_auth":"password","outgoing_server_hostname":"smtp.zylker.com","outgoing_server_auth":"password"}'
```

## Sample Request Body

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

Response Body — `application/json`

**JSON object**

#### Attributes

- **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/mobile-device-management/help/api/cloud/certificates-get-certificates.html).

- **encryption_cert_id** (long)  
  Encryption identity certificate ID obtained from the [Certificates API](https://www.manageengine.com/mobile-device-management/help/api/cloud/certificates-get-certificates.html).

## Sample Response: HTTP 200

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

## Possible Response Codes

- **200** — HTTP code