> ## Documentation Index
> Fetch the complete documentation index at: https://docs.superoffice.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Register Device For Push Notification

> Register a device that should receive push notifications when notable events occour

NsApiSlow threshold: 5000 ms.



## OpenAPI

````yaml /openapi/agent/openapi-v3-PocketAgent.json post /api/v1/Agents/Pocket/RegisterDeviceForPushNotification
openapi: 3.0.0
info:
  version: v1-Agents
  title: SuperOffice Agent API v1
  description: SuperOffice Agent API - PocketAgent
  contact:
    name: SuperOffice DevNet
    url: https://docs.superoffice.com/en/api/index.html
    email: sdk@superoffice.com
servers:
  - url: http://localhost:56350
  - url: https://localhost:56350
security: []
tags: []
externalDocs:
  description: >-
    The SuperOffice DevNet Community has more documentation, examples, and
    discussion forums.
  url: https://community.superoffice.com/en/developer/
paths:
  /api/v1/Agents/Pocket/RegisterDeviceForPushNotification:
    post:
      tags:
        - Pocket_Agent
      summary: Register Device For Push Notification
      description: >-
        Register a device that should receive push notifications when notable
        events occour


        NsApiSlow threshold: 5000 ms.
      operationId: v1PocketAgent_RegisterDeviceForPushNotification
      parameters:
        - name: $select
          in: query
          description: >-
            Optional comma separated list of properties to include in the
            result. Other fields are then nulled out to reduce payload size:
            "Name,department,category". Default = show all fields.
          required: false
          schema:
            type: string
        - name: SO-AppToken
          in: header
          description: >-
            The application token that identifies the partner app. Used when
            calling Online WebAPI from a server.
          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.PocketCarriers.RegisterDeviceForPushNotificationRequest
          text/json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.PocketCarriers.RegisterDeviceForPushNotificationRequest
          application/xml:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.PocketCarriers.RegisterDeviceForPushNotificationRequest
          text/xml:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.PocketCarriers.RegisterDeviceForPushNotificationRequest
          application/x-www-form-urlencoded:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.PocketCarriers.RegisterDeviceForPushNotificationRequest
          application/json-patch+json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.PocketCarriers.RegisterDeviceForPushNotificationRequest
          application/merge-patch+json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.PocketCarriers.RegisterDeviceForPushNotificationRequest
        description: DeviceInfo
        required: true
      responses:
        '204':
          description: No Content
      security:
        - SuperOffice_Password: []
          SuperId_Authentication: []
components:
  schemas:
    SuperOffice.WebApi.v1.Carriers.PocketCarriers.RegisterDeviceForPushNotificationRequest:
      description: >-
        RegisterDeviceForPushNotification: Register a device that should receive
        push notifications when notable events occour
      type: object
      properties:
        DeviceInfo:
          $ref: '#/components/schemas/SuperOffice.CRM.Services.PocketDeviceInfo'
    SuperOffice.CRM.Services.PocketDeviceInfo:
      description: "Describes a device running Pocket CRM\r\n<para />\r\nCarrier object for PocketDeviceInfo.\r\nServices for the PocketDeviceInfo Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.IPocketAgent\">Pocket Agent</see>."
      type: object
      properties:
        DeviceName:
          description: 'A friendly display name for the device. Ex: ''Bobbys iPhone 5S'''
          type: string
        DeviceIdentifier:
          description: >-
            A unique identifier of this device. This value should always be the
            same for the same device
          type: string
        PocketVersion:
          description: 'What version of Pocket CRM this device is running. Ex: ''8.0.37'''
          type: string
        Language:
          description: >-
            The language which this device will receive notifications translated
            in
          type: string
        PNSHandle:
          description: >-
            The identifier associated with the device that will be used when
            talking with vendors push services
          type: string
        Platform:
          description: What platform does this device belong to
          enum:
            - Apple
            - Google
            - Microsoft
            - AppleDeveloper
            - AppleAdHoc
            - GoogleDeveloper
          type: string
        OSVersion:
          description: 'The operating system version. Ex: ''iOS v10.2'''
          type: string
        TimeZoneId:
          format: int32
          description: The timezone to show for dates in messages
          type: integer

````

## Related topics

- [SuperOffice.WebApi.Data.Pocket RegisterDeviceForPushNotificationRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Pocket_RegisterDeviceForPushNotificationRequest.md)
- [NSPocketAgent](/en/automation/crmscript/reference/CRMScript.NetServer.NSPocketAgent.md)
- [SuperOffice.WebApi.Agents.PocketAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.PocketAgent.md)
- [SuperOffice.WebApi.Agents.IPocketAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.IPocketAgent.md)
- [Set Push Notification Tags For Device](/en/api/reference/restful/agent/pocket_agent/set-push-notification-tags-for-device.md)
- [Get Push Notification Tags For Device](/en/api/reference/restful/agent/pocket_agent/get-push-notification-tags-for-device.md)