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

To modify Exchange Active Sync policy payload item

Endpoints

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

Copy full URL

Request URL

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

Scope

MDMDeviceMgmt.UPDATECopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

Content-TypestringMandatory

application/jsonCopied!

AcceptstringMandatory

application/jsonCopied!

- Path Parameters

profile_idstringMandatory

Unique identifier of the profile. Obtain from the Create Profile or Get Profiles response

payload_idstringMandatory

Unique identifier of the payload item. Obtain from the Get Payload Item IDs response

- Request Body

application/json

JSON Object

Hide Sub-Attributes

account_namestringOptional

Account Name. Default: Exchange ActiveSync

active_sync_hoststringMandatory

Active Sync Host

allow_movebooleanOptional

Allow Move. Default: true

prevent_movebooleanOptional

Prevent Move. Default: false

disable_mail_recents_syncingbooleanOptional

Disable Mail Recents Syncing. Default: false

use_only_mail_appbooleanOptional

Use Only Mail App. Default: false

use_sslbooleanOptional

Use Ssl. Default: true

use_mime_encryptbooleanOptional

Use Mime Encrypt. Default: false

signing_cert_idlongOptional

Signing identity certificate ID obtained from the Certificates API.

encryption_cert_idlongOptional

Encryption identity certificate ID obtained from the Certificates API.

domainstringOptional

Domain. Default: %domainname%

user_namestringOptional

User Name. Default: %upn%

email_addressstringOptional

Email Address. Default: %email%

passwordstringOptional

Password (sensitive - write-only)

password_idlongOptional

Password Id

past_days_mail_to_syncintegerOptional

Past Days Mail To Sync. Default: 0

identity_cert_idlongOptional

Identity certificate ID obtained from the Certificates API. Must be an identity certificate (is_identity = true)

cert_compatible_ios4booleanOptional

Cert Compatible Ios4. Default: false

oauthbooleanOptional

Oauth. Default: false

sync_calenderintegerOptional

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_contactsintegerOptional

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_notesintegerOptional

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_mailintegerOptional

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_reminderintegerOptional

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_urlstringOptional

Oauth Signin Url

oauth_token_request_urlstringOptional

Oauth Token Request Url

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

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

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("Accept", "application/json")
        .header("Authorization", " d92d4xxxxxxxxxxxxx15f52")
        .method("PUT", HttpRequest.BodyPublishers.ofString("{\"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}"))
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

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

payload = "{\"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}"

headers = {
    'Content-Type': "application/json",
    'Accept': "application/json",
    'Authorization': " 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"))


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

    data=Map();
    data.put("account_name","value");
    data.put("active_sync_host","value");
    data.put("allow_move",true);
    data.put("prevent_move",true);
    data.put("disable_mail_recents_syncing",true);
    data.put("use_only_mail_app",true);
    data.put("use_ssl",true);
    data.put("use_mime_encrypt",true);
    data.put("signing_cert_id","1");
    data.put("encryption_cert_id","1");
    data.put("domain","value");
    data.put("user_name","value");
    data.put("email_address","value");
    data.put("password","value");
    data.put("password_id","1");
    data.put("past_days_mail_to_sync","1");
    data.put("identity_cert_id","1");
    data.put("cert_compatible_ios4",true);
    data.put("oauth",true);
    data.put("sync_calender","1");
    data.put("sync_contacts","1");
    data.put("sync_notes","1");
    data.put("sync_mail","1");
    data.put("sync_reminder","1");
    data.put("oauth_signin_url","value");
    data.put("oauth_token_request_url","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;

$headers=@{}
$headers.Add("Content-Type", "application/json")
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", " 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 '{"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

Copied!

  {
    "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
  }

▼ Show full

Response Parameters

- HTTP code 200

Response Body - application/json

JSON Object

Hide Sub-Attributes

payload_idlong

Unique identifier of the payload item

account_namestring

Account Name. Default: Exchange ActiveSync

active_sync_hoststring

Active Sync Host

allow_moveboolean

Allow Move. Default: true

prevent_moveboolean

Prevent Move. Default: false

disable_mail_recents_syncingboolean

Disable Mail Recents Syncing. Default: false

use_only_mail_appboolean

Use Only Mail App. Default: false

use_sslboolean

Use Ssl. Default: true

use_mime_encryptboolean

Use Mime Encrypt. Default: false

signing_cert_idlong

Signing identity certificate ID obtained from the Certificates API.

encryption_cert_idlong

Encryption identity certificate ID obtained from the Certificates API.

domainstring

Domain. Default: %domainname%

user_namestring

User Name. Default: %upn%

email_addressstring

Email Address. Default: %email%

passwordstring

Password (sensitive - write-only)

password_idlong

Password Id

past_days_mail_to_syncinteger

Past Days Mail To Sync. Default: 0

identity_cert_idlong

Identity certificate ID obtained from the Certificates API. Must be an identity certificate (is_identity = true)

cert_compatible_ios4boolean

Cert Compatible Ios4. Default: false

oauthboolean

Oauth. Default: false

sync_calenderinteger

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_contactsinteger

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_notesinteger

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_mailinteger

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_reminderinteger

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_urlstring

Oauth Signin Url

oauth_token_request_urlstring

Oauth Token Request Url

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Exchange ActiveSync payload item successfully modified

Copied!

  {
    "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
  }

▼ Show full

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.