--> --> --> -->

logout Method

Use the logout method to disconnect the push device from the recipient. After successfully completing the request, it will be impossible to deliver the push notification to the device by the recipient’s ID.

Call this method if the mobile application user has logged out of their account or if the user has refused to receive push notifications.

Make sure the manual device registration method is set in the push application settings before using this method.

The server returns a response with code 200 if the request is successful.

Connection URL

To use the method, send a POST request to: https://app.edna.io/api/push/device/logout

Request Parameters

ParameterTypeDescription
subscriberObject
(optional)
The recipient of the message: The ID in edna Pulse, the client’s phone number and other IDs for push messages.

subscriberFilter includes the following parameters:
address: the value that depends on type.
type: this is PHONEEDNA_ID and other IDs for push messages (the full list of IDs is available below in the description of the type parameter).

If type is PHONE, then address is the client’s phone number. For example:

“subscriberFilter”:
{
“address”: “00000000000”,
“type”: “PHONE”
}
subscriber.addressStringThe ID value of the specified type.
subscriber.typeStringThe type of the client’s ID.

Possible values (should be given in capital letters):
• INSTAGRAM_ID: the client’s ID on Instagram.
• FACEBOOK_ID.
• PHONE: the client’s phone number in the format <00000000000>.
• EMAIL.
• UTM.
• COOKIE_ID.
• TELEGRAM_ID.
• GOOGLE_ID.
• APPLE_ID.
• YANDEX_ID.
• EXT_USER_ID.
deviceAppInfo.
deviceAddress
StringThe unique push address of the user’s device in the edna service. It is received in a callback from the edna mobile push libraries:
• EDNAPushXDeviceInfo on iOS.
• onDeviceAddressChanged on Android.
It changes along with the change of tokens in push clouds. Also used as DEVICE_APP_ID.
deviceAppInfo.
deviceUID
StringThe unique identifier of the user’s device.
It remains the same until the user reinstalls the application.
deviceAppInfo.
deviceName
String (optional)The name indicated by the user for the device.
deviceAppInfo.
systemName
String (optional)The name of the user’s device model.
deviceAppInfo.
appPackage
StringThe name of the application package.
deviceAppInfo.
locale
String (optional)The user device interface locale in the <EN> format.
deviceAppInfo.
timezone
String (optional)The time zone installed on the user’s device, in the format of a TZ identifier of the <Cyprus/Nicosia> type.
deviceAppInfo.
notificationAlertAllowed
Boolean (optional)Permission to display notifications for the application.
deviceAppInfo.
notificationDelayedViewEnabled
Boolean (optional)Whether the application is included in the notification overview (iOS only).
deviceAppInfo.
timeSensitiveNotificationAllowed
Boolean (optional)Whether time-sensitive notifications are available (iOS only).

Request Example

{
  "subscriber": {
    "address": "00001002030",
    "type": "PHONE"
  },
  "deviceAppInfo": {
    "deviceAddress": "gcmfptwlc8lv1ahl28hannuesjj98yqodl",
    "deviceUID": "6e083b67005411b28e736bbcda15d0a2b5d8bb08",
    "appPackage": "com.edna.android.push.demo_x_bestapp5000_c6b91927-0d8e-4f43-a507-c3f216c56319",
    "locale": "EN",
    "timezone": "Cyprus/Nicosia",
    "notificationAlertAllowed": true,
    "notificationDelayedViewEnabled": false,
    "timeSensitiveNotificationAllowed": false
  }
}