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

Update Device Registration (PUT)

Updates push device registration with the new user ID or the specified token. In most use cases, only the user ID is updated.

Roles

Users in the following roles are authorized to perform this operation:

• mfpadmin
• mfpdeployer
• mfpoperator

Method

PUT

Path

/management-apis/2.0/runtimes/runtime-name/notifications/applications/application-name/devices/device-id

Example

https://www.example.com/mfpadmin/management-apis/2.0/runtimes/myruntime/notifications/applications/myapplication/devices/12345-6789?locale=de_DE&mfpPushEnableBroadcast=true

Path Parameters

runtime-name

The name of the runtime. This is the context root of the runtime web application, without the leading slash.

application-name

The name of the application.

device-id

The device id.

Query Parameters

Query parameters are optional.

locale

The locale used for error messages.

mfpPushEnableBroadcast

Participate in the broadcast messaging.

Consumes

application/json, application/xml, text/xml

Produces

application/json, application/xml, text/xml

Payload

JSON Example

{
  "deviceId" : "JeremyiOSPhone",
  "platform" : "A",
  "token" : "c6a41224 23333917 9fde1532",
  "userId" : "Jeremy",
}

XML Example

<?xml version="1.0" encoding="UTF-8"?>
<device-update
  deviceId="JeremyiOSPhone"
  platform="A"
  token="c6a41224 23333917 9fde1532"
  userId="Jeremy"/>

Payload Properties

The payload has the following properties:

deviceId

The unique identifier of the device

platform

The device platform

token

The unique push token of the device

userId

The identifier of the user of the device.

Errors

400

The request was not understood by the push server.

403

The user is not authorized to call this service.

404

The corresponding runtime or application is not found or not running.

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 administration service