PATCH /push/deviceRegistrations/{device_id}
Specific attributes of an existing registration can be updated. Only clientId, metadata and push.recipient are mutable.
Servers
- https://rest.ably.io
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
device_id |
String | Yes |
Device's ID. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
X-Ably-Version |
String | No |
The version of the API you wish to use. |
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
format |
String | No |
The response format you would like Possible values:
|
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
id |
String | No |
Unique identifier for the device generated by the device itself. |
push.state |
String | No |
the current state of the push device. Possible values:
|
platform |
String | No |
Platform of the push device. Possible values:
|
metadata |
Object | No |
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. |
push.recipient |
Object | No |
Push recipient details for a device. |
push.recipient.transportType |
String | No |
Defines which push platform is being used. Possible values:
|
push.recipient.deviceToken |
String | No |
when using APNs, specifies the required device token. |
push.recipient.registrationToken |
String | No |
when using GCM or FCM, specifies the required registration token. |
push.recipient.deviceId |
String | No |
Client ID of recipient |
push.recipient.clientId |
String | No |
Client ID of recipient |
formFactor |
String | No |
Form factor of the push device. Possible values:
|
clientId |
String | No |
Optional trusted client identifier for the device. |
deviceSecret |
String | No |
Secret value for the device. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.