Unpublish App
The Unpublish App service unpublishes an application that was added into Volt MX Foundry Engagement Services. This service accepts App ID as an input parameter to unpublish an application.
Note: Only published applications are allowed to send push notifications.
URL
The HTTP URL for Unpublish App API is:
http://<host>:<port>/api/v1/applications/<id>/unpublish
This service implements Gateway Filter for Authentication to authenticate access of the service by a user.
Note: Provide the unique appId assigned to an app to unpublish it.
Method
POST
Header
The payload's request header includes Content-Type as application/json;charset=UTF-8.
Input Parameters
The following fields are input parameters:
| Input Parameter | Required | Type | Description |
|---|---|---|---|
| Application ID | Yes | long | The unique ID assigned to the application. |
Output Parameters
The following fields are output parameters:
| Output Parameter | Type | Description |
|---|---|---|
| id | long | Unique app ID assigned to an app |
| message | string | Response status message |
Sample Response
{
"id" : "300966548262167",
"message" : "Application unpublished successfully"
}
Response Status
| Code | Description |
|---|---|
| Status 200 | Application unpublished successfully |
| Status 400 | Application not found for publishing/unpublishing |
| Status 401 | Unauthorized request |
| Status 500 | Server failure to process request |