# Modify the configuration of a Exchange ActiveSync payload item within a profile

To modify Exchange Active Sync policy payload item

## Endpoint

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

## Request URL

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

## Scope

`MDMDeviceMgmt.UPDATE`

## Header

`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/ios-get-exchange-activesync-payload-ios.html) response |

### Request Body

`application/json`

| Name | Type | Required | Description |
|---|---|---|---|
| account_name | string | Optional | Account Name. Default: Exchange ActiveSync |
| active_sync_host | string | Mandatory | Active Sync Host |
| 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 |
| use_only_mail_app | boolean | Optional | Use Only Mail App. Default: false |
| use_ssl | boolean | Optional | Use Ssl. Default: true |
| 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). |
| domain | string | Optional | Domain. Default: %domainname% |
| user_name | string | Optional | User Name. Default: %upn% |
| email_address | string | Optional | Email Address. Default: %email% |
| password | string | Optional | Password (sensitive - write-only) |
| password_id | long | Optional | Password Id |
| past_days_mail_to_sync | integer | Optional | Past Days Mail To Sync. Default: 0 |
| identity_cert_id | long | Optional | Identity certificate ID obtained from the [Certificates API](https://www.manageengine.com/products/desktop-central/help/api/onpremise/certificates-get-certificates.html). Must be an identity certificate (`is_identity` = true) |
| cert_compatible_ios4 | boolean | Optional | Cert Compatible Ios4. Default: false |
| oauth | boolean | Optional | Oauth. Default: false |
| sync_calender | integer | Optional | Calendar sync setting. Allowed values: 0=Default, 1=Restrict modification, 2=Disable sync, 3=Disable and restrict, 4=Enable sync, 5=Enable and restrict |
| sync_contacts | integer | Optional | Contacts sync setting. Allowed values: 0=Default, 1=Restrict modification, 2=Disable sync, 3=Disable and restrict, 4=Enable sync, 5=Enable and restrict |
| sync_notes | integer | Optional | Notes sync setting. Allowed values: 0=Default, 1=Restrict modification, 2=Disable sync, 3=Disable and restrict, 4=Enable sync, 5=Enable and restrict |
| sync_mail | integer | Optional | Mail sync setting. Allowed values: 0=Default, 1=Restrict modification, 2=Disable sync, 3=Disable and restrict, 4=Enable sync, 5=Enable and restrict |
| sync_reminder | integer | Optional | Reminders sync setting. Allowed values: 0=Default, 1=Restrict modification, 2=Disable sync, 3=Disable and restrict, 4=Enable sync, 5=Enable and restrict |
| oauth_signin_url | string | Optional | Oauth Signin Url |
| oauth_token_request_url | string | Optional | Oauth Token Request Url |

## Sample Request

```curl
curl --request PUT \
  --url https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/exchangeactivesyncpolicy/payloaditems/{payload_id} \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"prevent_move":false,"use_mime_encrypt":false,"encryption_cert_id":-1,"disable_mail_recents_syncing":false,"allow_move":true,"signing_cert_id":-1,"use_ssl":true,"account_name":"Exchange ActiveSync","active_sync_host":"https://zylker.com","use_only_mail_app":false}'
```

## Sample Request Body

Modify Exchange ActiveSync payload item

```json
{
  "prevent_move": false,
  "use_mime_encrypt": false,
  "encryption_cert_id": -1,
  "disable_mail_recents_syncing": false,
  "allow_move": true,
  "signing_cert_id": -1,
  "use_ssl": true,
  "account_name": "Exchange ActiveSync",
  "active_sync_host": "https://zylker.com",
  "use_only_mail_app": false
}
```

## Response Parameters

### HTTP Code 200

Response Body: `application/json`

| Name | Type | Description |
|---|---|---|
| payload_id | long | Unique identifier of the payload item |
| account_name | string | Account Name. Default: Exchange ActiveSync |
| active_sync_host | string | Active Sync Host |
| 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 |
| use_only_mail_app | boolean | Use Only Mail App. Default: false |
| use_ssl | boolean | Use Ssl. Default: true |
| 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). |
| domain | string | Domain. Default: %domainname% |
| user_name | string | User Name. Default: %upn% |
| email_address | string | Email Address. Default: %email% |
| password | string | Password (sensitive - write-only) |
| password_id | long | Password Id |
| past_days_mail_to_sync | integer | Past Days Mail To Sync. Default: 0 |
| identity_cert_id | long | Identity certificate ID obtained from the [Certificates API](https://www.manageengine.com/products/desktop-central/help/api/onpremise/certificates-get-certificates.html). Must be an identity certificate (`is_identity` = true) |
| cert_compatible_ios4 | boolean | Cert Compatible Ios4. Default: false |
| oauth | boolean | Oauth. Default: false |
| sync_calender | integer | Calendar sync setting. Allowed values: 0=Default, 1=Restrict modification, 2=Disable sync, 3=Disable and restrict, 4=Enable sync, 5=Enable and restrict |
| sync_contacts | integer | Contacts sync setting. Allowed values: 0=Default, 1=Restrict modification, 2=Disable sync, 3=Disable and restrict, 4=Enable sync, 5=Enable and restrict |
| sync_notes | integer | Notes sync setting. Allowed values: 0=Default, 1=Restrict modification, 2=Disable sync, 3=Disable and restrict, 4=Enable sync, 5=Enable and restrict |
| sync_mail | integer | Mail sync setting. Allowed values: 0=Default, 1=Restrict modification, 2=Disable sync, 3=Disable and restrict, 4=Enable sync, 5=Enable and restrict |
| sync_reminder | integer | Reminders sync setting. Allowed values: 0=Default, 1=Restrict modification, 2=Disable sync, 3=Disable and restrict, 4=Enable sync, 5=Enable and restrict |
| oauth_signin_url | string | Oauth Signin Url |
| oauth_token_request_url | string | Oauth Token Request Url |

## Possible Response Codes

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

## Sample Response: HTTP 200

Exchange ActiveSync payload item successfully modified

```json
{
  "prevent_move": false,
  "use_mime_encrypt": false,
  "payload_id": 9007199254741000,
  "disable_mail_recents_syncing": false,
  "allow_move": true,
  "use_ssl": true,
  "user_name": "user@zylker.com",
  "past_days_mail_to_sync": 7,
  "encryption_cert_id": -1,
  "email_address": "user@zylker.com",
  "signing_cert_id": -1,
  "account_name": "Exchange ActiveSync",
  "active_sync_host": "https://zylker.com",
  "use_only_mail_app": false
}
```

## Rate Limit

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