Modify the configuration of a eSIM payload item within a profile To modify Ios Esim policy payload item
Request URL https://{serverurl} /api/v1/mdm/profiles/{profile_id}/payloads/iosesimpolicy/payloaditems/{payload_id}
Scope
Header Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
Request Parameters - Path Parameters profile_id string Mandatory
payload_id string Mandatory
- Request Body application/json JSON object
Hide Sub-Attributes esim_server_url string Mandatory
allow_esim_modification boolean Optional
Allow Esim Modification. Default: True
force_preserve_esim_on_erase boolean Optional
Force Preserve Esim On Erase. Default: False
allow_esim_outgoing_transfers boolean Optional
Allow Esim Outgoing Transfers. Default: True
Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request PUT \
--url https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/iosesimpolicy/payloaditems/{payload_id} \
--header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52' \
--header 'content-type: application/json' \
--data '{"esim_server_url":"https://zylker.com"}'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/iosesimpolicy/payloaditems/{payload_id}"))
.header("content-type", "application/json")
.header("Authorization", "Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52")
.method("PUT", HttpRequest.BodyPublishers.ofString("{\"esim_server_url\":\"https://zylker.com\"}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
}
}
import http.client
conn = http.client.HTTPSConnection("appdomain")
payload = "{\"esim_server_url\":\"https://zylker.com\"}"
headers = {
'content-type': "application/json",
'Authorization': "Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52"
}
conn.request("PUT", "/api/v1/mdm/profiles/{profile_id}/payloads/iosesimpolicy/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("esim_server_url","value");
response = invokeUrl
[
url: "https://appDomain/api/v1/mdm/profiles/{profile_id}/payloads/iosesimpolicy/payloaditems/{payload_id}"
type: PUT
headers: headersMap
body: data
connection: connection_name
]
info response;
$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/iosesimpolicy/payloaditems/{payload_id}' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{"esim_server_url":"https://zylker.com"}'▼ Show full
Sample Request Body {
"esim_server_url": "https://zylker.com",
"force_preserve_esim_on_erase": false,
"allow_esim_modification": true,
"allow_esim_outgoing_transfers": true
}
▼ Show full
Response Parameters - HTTP code 200 Response Body - application/json JSON object
Hide Sub-Attributes payload_id long
Unique identifier of the payload item
allow_esim_modification boolean
Allow Esim Modification. Default: True
force_preserve_esim_on_erase boolean
Force Preserve Esim On Erase. Default: False
allow_esim_outgoing_transfers boolean
Allow Esim Outgoing Transfers. Default: True
Possible Response Codes Sample Response: HTTP 200 eSIM payload item successfully modified
Copied!
{
"esim_server_url": "https://zylker.com",
"payload_id": 9007199254741000,
"force_preserve_esim_on_erase": false,
"allow_esim_modification": true,
"allow_esim_outgoing_transfers": true
}
▼ 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.
© 2026, Zoho Corporation Pvt. Ltd. All Rights Reserved.
© 2026, Zoho Corporation Pvt. Ltd. All Rights Reserved.