Push Application (PUT)
Updates an existing application status. The API can be used to enable or disable an application.
Method
PUT
Path
/apps/applicationId/status
Example
https://example.com:443/imfpush/v1/apps/myapp/status
Path Parameters
- applicationId
- The name or identifier of the application
Header Parameters
Some header parameters are optional.
- Accept-Language
- (Optional) The preferred language to use for error messages. Default:en-US
- Authorization
- The token with the scope "apps.write" and "push.application.<applicationId>" obtained using the confidential client in the format Bearer token.. This parameter has to be mandatorily set.
- Content-Type
- Specify the JSON content type. For example: application/json. This parameter has to be mandatorily set.
Consumes
application/json
Produces
application/json
Payload
The details of the application.
JSON Example
{
"enabled" : "true",
}
Payload Properties
The payload has the following properties:- enabled
- The status of the application
Response
The details of the application.
JSON Example
{
"applicationId" : "testApp",
"enabled" : "true",
}
Response Properties
The response has the following properties:
- applicationId
- The application Id.
- enabled
- The status of the application.
Errors
400Bad Request - The request was not understood by the push server. An invalid JSON could result in this error code.401
Unauthorized - The caller is either not authenticated or not authorized to make this request.404
The applicationId does not exist.405
Unsupported Content type - The content type specified in Content-Type header is not application/json.406
Unsupported Accept type - The content type specified in Accept header is not application/json.500
An internal error occurred.