Update an app's details or version in a specific release label

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

Update specific app version of the app

Request URL

https://{server-hostname}:8383/api/v1/mdm/apps/{app_id}/labels/{release_label_id}

Scope

MDMDeviceMgmt.UPDATECopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

Content-TypestringMandatory
application/jsonapplication/jsonCopied!
AcceptstringMandatory
application/jsonapplication/jsonCopied!

- Path Parameters

app_idstringMandatory

Unique identifier of the application. Obtain from the Get App List response

release_label_idstringMandatory

Unique identifier of the release label. Obtain from the Get App Details response

- Request Body

application/json
JSON Object
Hide Sub-Attributes
platform_typeintegerOptional

Platform: 1 = iOS, 2 = Android, 3 = Windows

app_typeintegerMandatory

App type: 0 = Free Store App, 1 = Paid Store App, 2 = Enterprise App

app_category_idintegerOptional

Identifier for the app category

app_namestringMandatory

Name of the app

bundle_identifierstringOptional

App bundle identifier

app_versionstringOptional

New version string of the app

supported_devicesintegerOptional

Supported devices: 1 = Smartphone, 2 = Tablet, 3 = Both

descriptionstringOptional

Custom description of the app

remove_app_with_profilebooleanOptional

Remove app when profile is removed (iOS Store apps only)

prevent_backupbooleanOptional

Prevent app data backup during device backup

app_filelongOptional

File ID of the updated app package. Upload using Upload File

display_imagelongOptional

File ID of the app display image. Upload using Upload File

full_imagelongOptional

File ID of the app full-size image. Upload using Upload File

config_filelongOptional

File ID of the app configuration file. Upload using Upload File

vpp_file_sourcelongOptional

File ID of the VPP file source. Upload using Upload File

force_update_in_labelbooleanOptional

true = update within label, false = add in different label

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request PUT \
  --url https://appdomain/api/v1/mdm/apps/{app_id}/labels/{release_label_id} \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"app_name":"Zylker MDM","prevent_backup":false,"app_type":2,"platform_type":2,"app_version":"12.3.45","supported_devices":3,"bundle_identifier":"com.manageengine.mdm.iosagent","description":"Updated enterprise app","force_update_in_label":true,"app_category_id":2,"remove_app_with_profile":false,"app_file":9007199254741080}'

Sample Request Body

Update app version within a specific release label

Copied!
  {
    "app_name": "Zylker MDM",
    "prevent_backup": false,
    "app_type": 2,
    "platform_type": 2,
    "app_version": "12.3.45",
    "supported_devices": 3,
    "bundle_identifier": "com.manageengine.mdm.iosagent",
    "description": "Updated enterprise app",
    "force_update_in_label": true,
    "app_category_id": 2,
    "remove_app_with_profile": false,
    "app_file": 9007199254741080
  }
                
Show full

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Hide Sub-Attributes
app_distributed_devices_countinteger

Count of devices the app has been distributed to

app_typeinteger

App type: 0 = Free Store App, 1 = Paid Store App, 2 = Enterprise App

is_multiple_app_version_availableboolean

Whether the app has multiple versions available

supported_devicesinteger

Supported devices: 1 = Smartphone, 2 = Tablet, 3 = Both

is_downgrade_availableboolean

Whether a version downgrade is available

is_for_all_customersboolean

Whether the app is uploaded for all customers

profile_namestring

Name of the app profile

platform_typeinteger

Platform: 1 = iOS, 2 = Android, 3 = Windows

app_version_codestring

Latest version code of the app on MDM server

release_label_idlong

ID of the release label

app_distributed_group_countinteger

Count of groups the app has been distributed to

app_idlong

Unique identifier for the app

app_category_namestring

Category name of the app

app_group_idlong

App group ID

versionstring

Version of the app

remove_app_with_profileboolean

Whether the app is removed when the profile is removed (iOS only)

country_codestring

Country code for App Store (iOS only). May be null

release_label_display_namestring

Display name for the release label (e.g., Stable, Beta)

added_timelong

Epoch timestamp (milliseconds) when the app was added

iconstring

URL link for the app icon image

descriptionstring

Description of the app

app_category_idinteger

Identifier for the app category

is_delete_applicableboolean

Whether the app can be deleted. false for approved versions

store_urlstring

Store URL for the app (iOS only). May be null

app_filelong

File ID of the app package

modified_timelong

Epoch timestamp (milliseconds) when the app was last modified

bundle_identifierstring

App bundle identifier

store_idstring

Identifier for the App Store (iOS only). May be null

app_titlestring

Title of the app

is_paid_appboolean

Whether the app is a paid app

private_appinteger

0 = Public App, 1 = Private App

app_namestring

Name of the app

prevent_backupboolean

Whether app data backup is prevented

is_distributableboolean

Whether the app can be distributed to devices/groups

is_purchased_from_portalboolean

Whether the app was purchased from a portal (VPP/PfW/Bstore)

release_labelsJSON Array

Array of release label objects with version details

Show Sub-Attributes
JSON Object
Show Sub-Attributes
release_label_typeinteger

Version type: 1 = Stable, 2 = Beta

release_label_namestring

Label name (e.g., Stable, Beta)

release_label_idlong

Unique ID for the release label

app_versionstring

The version of the app in this label

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

App updated with full details including distribution and version information

Copied!
  {
    "release_label_display_name": "Beta",
    "app_distributed_devices_count": 100,
    "app_type": 2,
    "is_multiple_app_version_available": true,
    "added_time": 1714630800000,
    "supported_devices": 3,
    "icon": "https://appDomain/mdm-logo.png",
    "is_downgrade_available": true,
    "description": "The is an enterprise app",
    "is_for_all_customers": true,
    "app_category_id": 2,
    "is_delete_applicable": false,
    "store_url": "https://www.zylker.com/app/zylker-mdm/id720111835?mt=8",
    "app_file": 9007199254741080,
    "profile_name": "Zylker MDM",
    "modified_time": 1714717200000,
    "platform_type": 2,
    "app_version_code": "10822",
    "release_label_id": 9007199254741076,
    "app_distributed_group_count": 10,
    "bundle_identifier": "com.manageengine.mdm.iosagent",
    "app_id": 9007199254741080,
    "store_id": "9007199254741069",
    "app_category_name": "Productivity",
    "app_title": "Zylker MDM",
    "is_paid_app": false,
    "app_group_id": 9007199254741082,
    "private_app": 0,
    "version": "1.1.1",
    "remove_app_with_profile": true,
    "country_code": "US",
    "app_name": "Zylker MDM",
    "prevent_backup": false,
    "is_distributable": true,
    "is_purchased_from_portal": false,
    "release_labels": [
      {
        "release_label_type": 1,
        "app_version": "12.3.45",
        "release_label_name": "Stable",
        "release_label_id": 9007199254741076
      }
    ]
  }
                
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.