Modify the configuration of a eSIM payload item within a profile

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

To modify Ios Esim policy payload item

Request URL

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

Scope

MDMDeviceMgmt.UPDATECopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

Content-TypestringMandatory
application/jsonapplication/jsonCopied!
AcceptstringMandatory
application/jsonapplication/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
esim_server_urlstringMandatory

Esim Server Url

allow_esim_modificationbooleanOptional

Allow Esim Modification. Default: True

force_preserve_esim_on_erasebooleanOptional

Force Preserve Esim On Erase. Default: False

allow_esim_outgoing_transfersbooleanOptional

Allow Esim Outgoing Transfers. Default: True

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request PUT \
  --url https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/iosesimpolicy/payloaditems/{payload_id} \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"esim_server_url":"https://zylker.com","force_preserve_esim_on_erase":false,"allow_esim_modification":true,"allow_esim_outgoing_transfers":true}'

Sample Request Body

Modify eSIM payload item

Copied!
  {
    "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_idlong

Unique identifier of the payload item

esim_server_urlstring

Esim Server Url

allow_esim_modificationboolean

Allow Esim Modification. Default: True

force_preserve_esim_on_eraseboolean

Force Preserve Esim On Erase. Default: False

allow_esim_outgoing_transfersboolean

Allow Esim Outgoing Transfers. Default: True

Possible Response Codes

200HTTP code

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.