Device (since 1.0.5)

A device is a mobile phone or tablet that can receive push notifications. Devices must register themselves with the Speakap API in order to start receiving updates. A device (identified by either a device_token (iOS) or an apid (android) can be used by only 1 user at a time, meaning that if two users register the same device, only last registered device will receive push notifications.

Representations

JSON

Properties

Name Type Description
deviceId string the device_token (ios) or apid (android)
notificationTypes object switches for notification types
notificationTypes. news boolean new news posts
notificationTypes. private_messages boolean new private messages
notificationTypes. alert_mention boolean see Alert types
notificationTypes. alert_new_comment boolean see Alert types
notificationTypes. alert_also_commented boolean see Alert types
notificationTypes. alert_new_update_to_user boolean see Alert types
notificationTypes. alert_group_invitation boolean see Alert types
notificationTypes. alert_group_invitation_acceptation boolean see Alert types
notificationTypes. alert_group_invitation_declination boolean see Alert types
notificationTypes. alert_group_membership_request boolean see Alert types
notificationTypes. alert_group_membership_approval boolean see Alert types
notificationTypes. alert_group_membership_denial boolean see Alert types
notificationTypes. alert_group_membership_denial boolean see Alert types
notificationTypes. alert_added_to_groups boolean see Alert types
notificationTypes. alert_removed_from_groups boolean see Alert types
privacyLevel string low, medium or high
type string ios or android