# 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 ### Request URL ``` https://{serverurl}/api/v1/mdm/profiles/{profile_id}/payloads/exchangeactivesyncpolicy/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-exchange-activesync-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 **Content-Type:** `application/json` **Type:** JSON object #### Attributes - **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/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). - **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/mobile-device-management/help/api/cloud/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 ```bash curl --request PUT \ --url https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/exchangeactivesyncpolicy/payloaditems/{payload_id} \ --header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52' \ --header 'content-type: application/json' \ --data '{"active_sync_host":"https://zylker.com"}' ``` ### 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/exchangeactivesyncpolicy/payloaditems/{payload_id}")) .header("content-type", "application/json") .header("Authorization", "Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52") .method("PUT", HttpRequest.BodyPublishers.ofString("{\"active_sync_host\":\"https://zylker.com\"}")) .build(); HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString()); System.out.println(response.body()); } } ``` ### Python ```python import http.client conn = http.client.HTTPSConnection("appdomain") payload = "{\"active_sync_host\":\"https://zylker.com\"}" headers = { 'content-type': "application/json", 'Authorization': "Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52" } conn.request("PUT", "/api/v1/mdm/profiles/{profile_id}/payloads/exchangeactivesyncpolicy/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("active_sync_host","value"); response = invokeUrl [ url: "https://appDomain/api/v1/mdm/profiles/{profile_id}/payloads/exchangeactivesyncpolicy/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/exchangeactivesyncpolicy/payloaditems/{payload_id}' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{"active_sync_host":"https://zylker.com"}' ``` ## Sample Request Body ```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 ### HTTP 200 **Content-Type:** `application/json` **Type:** JSON object #### Attributes - **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/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). - **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/mobile-device-management/help/api/cloud/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–5 (see above) - **sync_contacts** (integer) Contacts sync setting. Allowed values: 0–5 (see above) - **sync_notes** (integer) Notes sync setting. Allowed values: 0–5 (see above) - **sync_mail** (integer) Mail sync setting. Allowed values: 0–5 (see above) - **sync_reminder** (integer) Reminders sync setting. Allowed values: 0–5 (see above) - **oauth_signin_url** (string) Oauth Signin Url - **oauth_token_request_url** (string) Oauth Token Request Url ### Sample Response ```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 } ``` ## Possible Response Codes - **200** – HTTP code