Request

This request uses the DELETE method, which is used to remove one or more mobile apps based on the given app IDs.

Enter the following information:

In the Authorization header, replace YOUR_JWT with your JSON Web Token (JWT). For more information on how to obtain one, see JSON Web Token Authentication.
x-project-id: Your Project ID

In the request body, provide the following required parameters:

id: The unique identifier of the mobile app to be deleted.
purge: A Boolean flag indicating whether to permanently delete the app. If false, the app is simply removed but may be recoverable. If true, the app is permanently deleted.

For example:

[
  {
    "id": "b3f2a3a0-0f5a-4e4a-8f4a-9b9b9b9b9b9b",
    "purge": false
  }
]

📘
Note

If you use true, your request deletes all versions of the app associated with the same bundle ID.

For example, if you have a mobile app with a bundle ID com.katalon.mobile.myapp and you managed to upload it twice, this results in two app IDs: appId1 and appId2. If you delete appId1 with purge=true, the request removes both appId1 and appId2. This is because they share the same bundle ID, indicating they are different versions of the same app.

Response

The response will confirm the deletion of the app(s), along with their associated metadata if applicable.

See the following example:

{
  "status": "success",
  "message": "The app has been deleted successfully.",
  "deletedIds": [
    "b3f2a3a0-0f5a-4e4a-8f4a-9b9b9b9b9b9b"
  ]
}

Refer to the following table about the response body properties:

Property	Type	Description
`status`	String	The status of the deletion request (e.g., `success`, `failure`).
`message`	String	A detailed message about the deletion operation (e.g., `success`, `errors`).
`deletedIds`	Object	An array of the IDs of the apps that were successfully deleted.

Try it!

Enter the required (and optional, if applicable) fields below.
Select the language in Language.
Enter your user name or API credentials.
Review your API call and click Try it!