Update a device registration

PATCH /push/deviceRegistrations/{device_id}

Specific attributes of an existing registration can be updated. Only clientId, metadata and push.recipient are mutable.

Path parameters

device_id string Required

Device's ID.

Body

id string

Unique identifier for the device generated by the device itself.
clientId string

Optional trusted client identifier for the device.
formFactor string

Form factor of the push device.

Values are phone, tablet, desktop, tv, watch, car, or embedded.
metadata object

Optional metadata object for this device. The metadata for a device may only be set by clients with push-admin privileges and will be used more extensively in the future with smart notifications.
platform string

Platform of the push device.

Values are ios or android.
deviceSecret string

Secret value for the device.
push.recipient object

Push recipient details for a device.
Hide push.recipient attributes Show push.recipient attributes object
- transportType string
  
  Defines which push platform is being used.
  
  Values are apns, fcm, or gcm.
- deviceToken string
  
  when using APNs, specifies the required device token.
- registrationToken string
  
  when using GCM or FCM, specifies the required registration token.
- clientId string
  
  Client ID of recipient
- deviceId string
  
  Client ID of recipient

Responses

2XX

OK
Hide response attributes Show response attributes object
- id string
  
  Unique identifier for the device generated by the device itself.
- clientId string
  
  Optional trusted client identifier for the device.
- formFactor string
  
  Form factor of the push device.
  
  Values are phone, tablet, desktop, tv, watch, car, or embedded.
- metadata object
  
  Optional metadata object for this device. The metadata for a device may only be set by clients with push-admin privileges and will be used more extensively in the future with smart notifications.
- platform string
  
  Platform of the push device.
  
  Values are ios or android.
- deviceSecret string
  
  Secret value for the device.
- push.recipient object
  
  Push recipient details for a device.
  
  Hide push.recipient attributes Show push.recipient attributes object
  
  transportType string
  
  Defines which push platform is being used.
  
  Values are apns, fcm, or gcm.
  
  deviceToken string
  
  when using APNs, specifies the required device token.
  
  registrationToken string
  
  when using GCM or FCM, specifies the required registration token.
- push.state string
  
  the current state of the push device.
  
  Values are Active, Failing, or Failed.
default

Error
Hide headers attributes Show headers attributes
- x-ably-errorcode integer
  
  The error code.
- x-ably-errormessage string
  
  The error message.
- x-ably-serverid string Required
  
  The ID for the server communicated with.
Hide response attributes Show response attributes object
- message string
  
  Message explaining the error's cause.
- code integer
  
  Error code.
- statusCode integer
  
  Status error code.
- href string
  
  Link to help with error.
- serverId string
  
  Server ID with which error was encountered.

PATCH /push/deviceRegistrations/{device_id}

curl \
 -X PATCH https://rest.ably.io/push/deviceRegistrations/{device_id} \
 -H "Content-Type: application/json" \
 -d '{"id":"string","clientId":"string","formFactor":"phone","metadata":{},"platform":"ios","deviceSecret":"string","push.recipient":{"transportType":"apns","deviceToken":"string","registrationToken":"string","clientId":"string","deviceId":"string"}}'

Request example

{
  "id": "string",
  "clientId": "string",
  "formFactor": "phone",
  "metadata": {},
  "platform": "ios",
  "deviceSecret": "string",
  "push.recipient": {
    "transportType": "apns",
    "deviceToken": "string",
    "registrationToken": "string",
    "clientId": "string",
    "deviceId": "string"
  }
}

Request examples

{
  "id": "string",
  "clientId": "string",
  "formFactor": "phone",
  "metadata": {},
  "platform": "ios",
  "deviceSecret": "string",
  "push.recipient": {
    "transportType": "apns",
    "deviceToken": "string",
    "registrationToken": "string",
    "clientId": "string",
    "deviceId": "string"
  }
}

Response examples (2XX)

{
  "id": "string",
  "clientId": "string",
  "formFactor": "phone",
  "metadata": {},
  "platform": "ios",
  "deviceSecret": "string",
  "push.recipient": {
    "transportType": "apns",
    "deviceToken": "string",
    "registrationToken": "string"
  },
  "push.state": "Active"
}

Response examples (2XX)

{
  "id": "string",
  "clientId": "string",
  "formFactor": "phone",
  "metadata": {},
  "platform": "ios",
  "deviceSecret": "string",
  "push.recipient": {
    "transportType": "apns",
    "deviceToken": "string",
    "registrationToken": "string"
  },
  "push.state": "Active"
}

Response examples (default)

# Headers
x-ably-errorcode: 42
x-ably-errormessage: string
x-ably-serverid: string

# Payload
{
  "message": "string",
  "code": 42,
  "statusCode": 42,
  "href": "string",
  "serverId": "string"
}

Response examples (default)

# Headers
x-ably-errorcode: 42
x-ably-errormessage: string
x-ably-serverid: string

# Payload
{
  "message": "string",
  "code": 42,
  "statusCode": 42,
  "href": "string",
  "serverId": "string"
}