> ## 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.

# Send Push Notification

> Send a push notification to one or more associates

NsApiSlow threshold: 5000 ms.



## OpenAPI

````yaml /openapi/agent/openapi-v3-PocketAgent.json post /api/v1/Agents/Pocket/SendPushNotification
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/SendPushNotification:
    post:
      tags:
        - Pocket_Agent
      summary: Send Push Notification
      description: |-
        Send a push notification to one or more associates

        NsApiSlow threshold: 5000 ms.
      operationId: v1PocketAgent_SendPushNotification
      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.SendPushNotificationRequest
          text/json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.PocketCarriers.SendPushNotificationRequest
          application/xml:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.PocketCarriers.SendPushNotificationRequest
          text/xml:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.PocketCarriers.SendPushNotificationRequest
          application/x-www-form-urlencoded:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.PocketCarriers.SendPushNotificationRequest
          application/json-patch+json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.PocketCarriers.SendPushNotificationRequest
          application/merge-patch+json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.PocketCarriers.SendPushNotificationRequest
        description: AssociateIds, Message
        required: true
      responses:
        '204':
          description: No Content
      security:
        - SuperOffice_Password: []
          SuperId_Authentication: []
components:
  schemas:
    SuperOffice.WebApi.v1.Carriers.PocketCarriers.SendPushNotificationRequest:
      description: 'SendPushNotification: Send a push notification to one or more associates'
      type: object
      properties:
        AssociateIds:
          type: array
          items:
            format: int32
            type: integer
        Message:
          $ref: >-
            #/components/schemas/SuperOffice.CRM.Services.PocketNotificationMessage
    SuperOffice.CRM.Services.PocketNotificationMessage:
      description: "Describes behaviour and content for a push notification message\r\n<para />\r\nCarrier object for PocketNotificationMessage.\r\nServices for the PocketNotificationMessage Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.IPocketAgent\">Pocket Agent</see>."
      type: object
      properties:
        Title:
          description: Title for the notification
          type: string
        Message:
          description: The notification message body
          type: string
        Url:
          description: >-
            An url associated with the notification that will be handled by
            Pocket
          type: string
        Silent:
          description: >-
            Indicates wether or not the message will vibrate/play a sound when
            delivered
          type: boolean
        Type:
          description: The type of notification this is
          enum:
            - Message
            - ImportantMessage
            - RemoteAction
            - YesNoQuestion
            - ShowWebPage
          type: string
        TimeToLive:
          format: int32
          description: Specifies how many minutes the message should be valid
          type: integer
        RecordId:
          format: int32
          description: >-
            If the message is about some specific database record, this could be
            its primary key
          type: integer
        Date:
          format: date-time
          description: >-
            If the message is about some event happening at a specific date and
            time
          type: string
        Duration:
          description: Specify duration of the event
          type: string
        ExtraValues:
          description: Additional key/value properties to include in the message
          type: object
          additionalProperties:
            type: string

````

## Related topics

- [SuperOffice.WebApi.Data.Pocket SendPushNotificationRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Pocket_SendPushNotificationRequest.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)
- [PushNotificationService table](/en/database/tables/pushnotificationservice.md)
- [Register Device For Push Notification](/en/api/reference/restful/agent/pocket_agent/register-device-for-push-notification.md)