Configure the Poster Generic layout

Display Apple Wallet Generic passes in a poster-style layout that makes a background image the focus of the pass.

View as Markdown

How the Poster Generic layout works

The Poster Generic layout displays a background image across the front of an Apple Wallet Generic pass, with the header, primary, and footer fields overlaid on it. Secondary and auxiliary fields appear on the back. Use it where prominent artwork should be the primary visual element. Passes can also include up to two actions that link to relevant content or services.

Configure Poster Generic with any Wallet API operation that creates or updates a template or pass. Airship applies the layout when an Apple Generic template or pass has a background_image in headers and at least one field with fieldType set to footer.

Poster Generic is supported for iOS 27 and later. Devices running earlier iOS versions use the standard Generic layout as a fallback.

For more information, see Creating a Poster Generic Pass  in Apple’s developer documentation.

Poster Generic template example

The following example is a Create template request using the Poster Generic layout.

Create a Generic template with the Poster Generic layout
POST /v1/template/1234 HTTP/1.1
Authorization: Basic <authorization string>
Content-Type: application/json
Api-Revision: 1.2

{
  "headers": {
    "icon_image": {
      "formatType": 1,
      "fieldType": "image",
      "value": "https://example.com/images/icon.png"
    },
    "logo_image": {
      "formatType": 1,
      "fieldType": "image",
      "value": "https://example.com/images/logo.png"
    },
    "background_image": {
      "formatType": 1,
      "fieldType": "image",
      "value": "https://example.com/images/poster-background.png"
    }
  },
  "fields": {
    "eventTitle": {
      "formatType": "String",
      "order": 1,
      "fieldType": "header",
      "value": "VIP Access",
      "label": "Pass"
    },
    "memberName": {
      "formatType": "String",
      "order": 1,
      "fieldType": "primary",
      "value": "Alex Smith",
      "label": "Member"
    },
    "footerInfo": {
      "formatType": "String",
      "order": 1,
      "fieldType": "footer",
      "value": "Valid until Dec 2026",
      "label": "Status"
    },
    "passDetails": {
      "formatType": "String",
      "order": 1,
      "fieldType": "secondary",
      "value": "Tier 1 benefits included",
      "label": "Details"
    }
  },
  "vendor": "Apple",
  "projectType": "generic",
  "projectId": 1234,
  "type": "Generic",
  "vendorId": 1,
  "deleted": "False",
  "description": "Poster Generic pass template",
  "name": "VIP Poster Pass",
  "disabled": "False"
}