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

# Send push notification via wallet pass

> Send a push notification to the customer's device via an active wallet pass.



## OpenAPI

````yaml /api-reference/openapi.json post /api/v2/wallet/notifications/
openapi: 3.0.3
info:
  title: Zupy API v2
  version: 2.0.0
  description: >-
    Zupy API v2 — versioned, gateway-aware API with envelope responses, RFC 7807
    errors, and multi-auth support (JWT, API Key, Device Key).
servers:
  - url: https://api.zupy.com
    description: Production
security: []
tags:
  - name: Authentication
    description: OTP request and verification endpoints
  - name: Customers
    description: Customer management, points, history, and data operations
  - name: Loyalty Programs
    description: Loyalty program configuration and details
  - name: Rewards
    description: Loyalty reward catalog (definitions redeemed with points)
  - name: Companies
    description: Company information and loyalty configuration
  - name: Coupons
    description: >-
      Issued coupons (RewardRedemption) — both loyalty-reward redemptions and
      marketing claims
  - name: Wallet
    description: Apple Wallet pass generation and notifications
  - name: Webhooks
    description: Partner integration webhook endpoints
  - name: Webhook Management
    description: Configure and test outbound webhook delivery
paths:
  /api/v2/wallet/notifications/:
    post:
      tags:
        - Wallet
      summary: Send push notification via wallet pass
      description: >-
        Send a push notification to the customer's device via an active wallet
        pass.
      operationId: wallet_notifications_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WalletNotificationRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/WalletNotificationRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/WalletNotificationRequest'
        required: true
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WalletNotificationResponse'
          description: ''
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: ''
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
          description: ''
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: ''
      security:
        - apiKeyAuth: []
components:
  schemas:
    WalletNotificationRequest:
      type: object
      description: Wallet push notification request parameters.
      properties:
        customer_id:
          type: string
          maxLength: 27
        type:
          $ref: '#/components/schemas/TypeEnum'
        message:
          type: string
          maxLength: 500
      required:
        - customer_id
        - message
        - type
    WalletNotificationResponse:
      type: object
      description: >-
        Wallet push notification result with notification ID and delivery
        status.
      properties:
        notification_id:
          type: string
        status:
          type: string
          default: queued
      required:
        - notification_id
    Error:
      type: object
      description: RFC 7807 Problem Details error response.
      properties:
        type:
          type: string
          format: uri
        title:
          type: string
        status:
          type: integer
        detail:
          type: string
        instance:
          type: string
      required:
        - detail
        - instance
        - status
        - title
        - type
    ValidationError:
      type: object
      description: RFC 7807 error with validation errors array.
      properties:
        type:
          type: string
          format: uri
        title:
          type: string
        status:
          type: integer
        detail:
          type: string
        instance:
          type: string
        errors:
          type: array
          items:
            $ref: '#/components/schemas/FieldError'
      required:
        - detail
        - errors
        - instance
        - status
        - title
        - type
    TypeEnum:
      enum:
        - points_update
        - coupon_available
        - program_update
      type: string
      description: |-
        * `points_update` - Points Update
        * `coupon_available` - Coupon Available
        * `program_update` - Program Update
    FieldError:
      type: object
      description: Individual field error in a validation error response.
      properties:
        field:
          type: string
        detail:
          type: string
      required:
        - detail
        - field
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: >-
        Per-company partner API key (zupy_pk_…). Validated by Zupy against the
        company integration key hash (Story 14.x); send it on every request as
        the X-API-Key header. Scoped read-write to the owning company's data.

````