Push APNS settings (PUT)
Uploads an APNS certificate to the application referenced by the applicationId
Method
PUT
Path
/apps/applicationId/settings/apnsConf
Example
https://example.com:443/imfpush/v1/apps/myapp/settings/apnsConf
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 "apnsConf.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 content type. For example: multipart/form-data. This parameter has to be mandatorily set.
Consumes
multipart/form-data
Produces
application/json
Form-data Parameters
- certificate
- (file) The APNS certificate.
- password
- (String) Password for the APNS certificate
- isSandBox
- (boolean) The APNS certificate type.
Response
Successfully updated the APNS settings.
JSON Example
{
"certificate" : "apns-certificate.p12",
"isSandBox" : "true",
"validUntil" : "2016-09-06T05:51:11.000Z",
}
Response Properties
The response has the following properties:
- certificate
- The name of the APNS certificate.
- isSandBox
- The APNS certificate type.
- validUntil
- The APNS certificate validity date.
Errors
400Bad Request - The request was not understood by the push server. An invalid data in the input.401
Unauthorized - The caller is either not authenticated or not authorized to make this request.404
The application does not exist.406
Unsupported Accept type - The content type specified in Accept header is not application/json.500
An internal error occurred.