For up-to-date product documentation, see the IBM MobileFirst Foundation Developer Center.

Push GCM Settings (PUT)

Updates GCM settings referenced by the applicationId

Method

PUT

Path

/apps/applicationId/settings/gcmConf

Example

https://example.com:443/imfpush/v1/apps/myapp/settings/gcmConf

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: application/json. This parameter has to be mandatorily set.

Consumes

application/json

Produces

application/json

Payload

The details of the gcm settings.

JSON Example

{
  "apiKey" : "AxBNGYUwehjokn",
  "senderId" : "123456789",
}

Payload Properties

The payload has the following properties:

apiKey

The GCM API Key.

senderId

The GCM SenderId.

Response

Retrieves GCM settings for the application.

JSON Example

{
  "apiKey" : "AxBNGYUwehjokn",
  "senderId" : "123456789",
}

Response Properties

The response has the following properties:

apiKey

The GCM API Key.

senderId

The GCM SenderId.

Errors

400

Bad 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.

Parent topic: REST API for the MobileFirst Server push service