Zendesk Push Notification Devices API

The Zendesk Push Notification Devices API lets you register and manage the mobile devices that should receive push notifications for a given Zendesk user. With it, you can create device records using the apps push token (APNs for iOS, FCM/GCM for Android), list the devices linked to a user, update or disable a device entry, and delete registrations when a user signs out or a device is replaced.

OpenAPI Specification

push-notification-devices-openapi-original.yml Raw ↑
openapi: 3.1.0
info:
  version: "1.0"
  title: Zendesk Push Notification Devices
  description: Needs a description.
paths:
  /api/v2/push_notification_devices/destroy_many:
    post:
      operationId: PushNotificationDevices
      tags:
        - Push Notification Devices
      summary: Zendesk Post  Api V2 Push_notification_devices Destroy_many
      description: >-
        Unregisters the mobile devices that are receiving push notifications.
        Specify the devices as an array of mobile device tokens.


        #### Allowed for


        * Admins
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PushNotificationDevicesRequest'
            examples:
              default:
                $ref: '#/components/examples/PushNotificationDevicesRequestExample'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: string
                description: empty
                example: ''
              example: ''
components:
  schemas: {}
tags:
  - name: Push Notification Devices