Sign in

v2

latestOpenAPI 3.0.1raw.githubusercontent.com2024-06-24221444.3 KB
Push

Update a device registration

Device registrations can be upserted (the existing registration is replaced entirely) with a PUT operation. Only clientId, metadata and push.recipient are mutable.

put/push/deviceRegistrations/{device_id}

Path parameters

device_idstring required

Device's ID.

Request body

idstring

Unique identifier for the device generated by the device itself.

clientIdstring

Optional trusted client identifier for the device.

formFactor'phone' | 'tablet' | 'desktop' | 'tv' | 'watch' | 'car' | 'embedded'

Form factor of the push device.

metadataobject

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'ios' | 'android' | 'browser'

Platform of the push device.

deviceSecretstring

Secret value for the device.

push.state'Active' | 'Failing' | 'Failed'

the current state of the push device.

Response

OK

idstring

Unique identifier for the device generated by the device itself.

clientIdstring

Optional trusted client identifier for the device.

formFactor'phone' | 'tablet' | 'desktop' | 'tv' | 'watch' | 'car' | 'embedded'

Form factor of the push device.

metadataobject

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'ios' | 'android' | 'browser'

Platform of the push device.

deviceSecretstring

Secret value for the device.

push.state'Active' | 'Failing' | 'Failed'

the current state of the push device.