PWpwapps
PWA

Generate manifest

Changed on

Generate manifest for PWA

get/api/v1/pwa/manifest/{pwa_id}

Request

Path parameters

pwa_idstring uuid required

Query parameters

event_idstring uuid nullable

Optional event ID

languagestring nullable

Optional language code for translation

Response

Successful Response

idstring required

ID of the PWA

namestring required

Name of the PWA

orientationstring

Orientation of the PWA

display_overridestring[]

List of display modes for the PWA

short_namestring required

Short name of the PWA

start_urlstring

Start URL of the PWA

displaystring

Display mode of the PWA

background_colorstring

Background color of the PWA

theme_colorstring

Theme color of the PWA

iconsobject[]

List of icons for the PWA

descriptionstring required

Description of the PWA

categoriesstring[]

List of categories for the PWA

screenshotsobject[]

List of screenshots for the PWA

Example response

{
  "background_color": "#FFFFFF",
  "categories": [
    "Productivity",
    "Entertainment"
  ],
  "description": "A detailed description of the app",
  "display": "standalone",
  "display_override": [],
  "icons": [],
  "id": "manifest-123",
  "name": "Sample PWA",
  "orientation": "any",
  "screenshots": [],
  "short_name": "Sample App",
  "start_url": "/",
  "theme_color": "#000000"
}

Changes

  • 615ebc9bfa17Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status