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

# Change an app's delivery mode or VAPID subject

> Changes the fields in the body and keeps the others. A web app's
VAPID key can't change, because a new key ends every browser
subscription. To change it, delete the app and create it again.




## OpenAPI

````yaml /reference/openapi.yaml patch /apps/{id}
openapi: 3.1.0
info:
  title: pgw admin API
  version: 0.4.0
  description: |
    Manage a pgw tenant: its apps, upstreams, managed mode users, bindings,
    and push log.

    The API listens on `admin_listen`, `127.0.0.1:8080` by default, over plain
    HTTP. Every endpoint except `POST /bootstrap`, `POST /tls/reload`, and the
    register bans needs a tenant API key in the `Authorization` header. Those
    need the server's `PGW_BOOTSTRAP_TOKEN`. Request bodies are JSON objects
    of at most 1 MiB, or 16 MiB for `POST /config/sync`, and pgw rejects
    unknown fields. Responses are never cached.

    An unknown path gets `404`, and a method that the path doesn't serve gets
    `405` with an `Allow` header. Every `GET` endpoint also answers `HEAD`.
    An endpoint that needs an API key answers `500` when pgw can't check the
    key.

    The same listener also serves `GET /metrics`, `GET /healthz`, and
    `GET /readyz`, outside `/api/v1` and without authentication. The health
    checks and metrics pages describe them.
  license:
    name: Apache-2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
servers:
  - url: '{baseUrl}'
    description: Your pgw admin listener
    variables:
      baseUrl:
        default: http://127.0.0.1:8080/api/v1
        description: The address of admin_listen, followed by /api/v1.
  - url: http://localhost:8080/api/v1
    description: pgw on this computer
security:
  - apiKey: []
tags:
  - name: Tenant
    description: Create the first tenant and read the caller's tenant.
  - name: Apps
    description: Mobile and web apps and their push credentials.
  - name: Upstreams
    description: PBXs that pgw registers apps with.
  - name: Users
    description: >-
      SIP accounts that pgw checks itself and registers at the PBX in managed
      mode.
  - name: Bindings
    description: Devices registered through pgw.
  - name: Push events
    description: The log of push attempts.
  - name: TLS
    description: The certificate that pgw presents to apps.
  - name: Register bans
    description: >-
      Source addresses that pgw refuses REGISTERs from after too many refused
      credentials.
  - name: Config
    description: Export a tenant's configuration and make it match a snapshot.
paths:
  /apps/{id}:
    patch:
      tags:
        - Apps
      summary: Change an app's delivery mode or VAPID subject
      description: |
        Changes the fields in the body and keeps the others. A web app's
        VAPID key can't change, because a new key ends every browser
        subscription. To change it, delete the app and create it again.
      operationId: updateApp
      parameters:
        - name: id
          in: path
          required: true
          description: The app ID.
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchAppRequest'
            examples:
              deliveryMode:
                summary: Push for every call, and name the app
                value:
                  delivery_mode: always_push
                  name: Example Phone
              gatewayDefault:
                summary: Go back to the gateway default
                value:
                  delivery_mode: ''
              vapidSubject:
                summary: Change a web app's contact
                value:
                  vapid_subject: https://example.com/contact
      responses:
        '200':
          description: The updated app.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/App'
              example:
                id: Hf2kP9wQ7mXc3LrN8vBd5g
                platform: ios
                bundle_id: com.example.phone
                name: Example Phone
                apns_team_id: ABCDE12345
                apns_key_id: ABC123DEFG
                apns_environment: production
                delivery_mode: always_push
                managed_refresh_push: ''
                created_at: '2026-11-02T08:20:00Z'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          description: The tenant has no app with this ID.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: no such App
        '500':
          $ref: '#/components/responses/InternalError'
components:
  schemas:
    PatchAppRequest:
      type: object
      additionalProperties: false
      properties:
        delivery_mode:
          type: string
          enum:
            - ''
            - provisional
            - always_push
          description: >-
            An empty string makes the app use the gateway default. Omit to keep
            the current mode.
        managed_refresh_push:
          type: string
          enum:
            - ''
            - 'on'
            - 'off'
          description: >-
            An empty string makes the app use the gateway default. Omit to keep
            the current setting.
        name:
          type: string
          maxLength: 64
          description: >-
            The app's new name. An empty string removes the name, so log lines
            show the bundle ID. Omit to keep the current name.
        vapid_subject:
          type: string
          description: A web app's new `mailto:` or `https:` contact URI.
        vapid_private_key_pem:
          type: string
          description: Always refused with 400. A web app's key can't change.
          writeOnly: true
    App:
      type: object
      required:
        - id
        - platform
        - bundle_id
        - delivery_mode
        - managed_refresh_push
        - created_at
      properties:
        id:
          type: string
        platform:
          type: string
          enum:
            - ios
            - android
            - web
        bundle_id:
          type: string
        name:
          type: string
          description: Absent when the app has no name.
        apns_team_id:
          type: string
        apns_key_id:
          type: string
        apns_environment:
          type: string
          enum:
            - production
            - sandbox
        fcm_project_id:
          type: string
        fcm_project_number:
          type: string
        vapid_public_key:
          type: string
          description: >-
            A web app's VAPID public key, in unpadded base64url. Browsers
            subscribe with it.
        vapid_subject:
          type: string
        delivery_mode:
          type: string
          enum:
            - ''
            - provisional
            - always_push
          description: Empty when the app uses the gateway default.
        managed_refresh_push:
          type: string
          enum:
            - ''
            - 'on'
            - 'off'
          description: Empty when the app uses the gateway default.
        created_at:
          type: string
          format: date-time
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: string
          description: What went wrong. Never contains the values that you sent.
  responses:
    BadRequest:
      description: >-
        The request body or a parameter isn't valid. The message names the
        field.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            field:
              summary: A field that isn't valid
              value:
                error: 'invalid request: platform must be "ios", "android", or "web"'
            json:
              summary: A body that isn't valid JSON
              value:
                error: 'invalid JSON body: unknown field "colour"'
            limit:
              summary: A query parameter out of range
              value:
                error: limit must be from 1 to 1000
    Unauthorized:
      description: The API key is missing or unknown.
      headers:
        WWW-Authenticate:
          schema:
            type: string
            const: Bearer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: missing or unknown API key
    InternalError:
      description: pgw failed to complete the request. The details are in pgw's log.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: internal error
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: The tenant API key that `POST /bootstrap` returned.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.