Sign in
Sites

Update the mobile pass customisation

Updates the mobile pass customisation for the given site, including the icon, logo, strip image and colour scheme. The icon_id is required; the other media references are optional.

post/customers/sites/{siteId}/mobile-pass-customisation

Request body

icon_idstring uuid required

Media to use as the icon on the mobile pass. Apple Wallet renders this in notifications; aim for a small square image. Must already be uploaded via the Media API.

logo_idstring uuid

Media to use as the logo on the mobile pass. Shown at the top of the pass next to the brand name.

strip_idstring uuid

The media id of the strip image

background_colourstring

Background hex colour for the pass, excluding the leading #. Use the brand colour that contrasts well with white text.

foreground_colourstring

Foreground hex colour for the primary pass copy, excluding the leading #. Pick a value with high contrast against background_colour.

label_colourstring

Hex colour for the small field labels on the pass, excluding the leading #. Defaults to a slightly dimmer shade than foreground_colour.

enabledboolean

Whether or not to enable mobile passes for this site

Example request

{
  "icon_id": "5f8a1b2c-9d3e-4a5b-8c6d-7e8f9a0b1c2d",
  "logo_id": "5f8a1b2c-9d3e-4a5b-8c6d-7e8f9a0b1c2d",
  "strip_id": "000000-000000-000000-000000",
  "background_colour": "1a1a2e",
  "foreground_colour": "ffffff",
  "label_colour": "cccccc"
}

Response

The mobile pass customisation for the site was successfully retrieved or updated.

Example response

{
  "data": {
    "icon_id": "000000-000000-000000-000000",
    "icon": {
      "file_name": "super-cool-photo.jpg",
      "mime_type": "image/jpeg",
      "original_url": "https://example.com/media/super-cool-photo.jpg",
      "size": 84256,
      "url": "https://example.com/media/super-cool-photo-thumbnail@2x.jpg"
    },
    "logo_id": "000000-000000-000000-000000",
    "logo": {
      "file_name": "super-cool-photo.jpg",
      "mime_type": "image/jpeg",
      "original_url": "https://example.com/media/super-cool-photo.jpg",
      "size": 84256,
      "url": "https://example.com/media/super-cool-photo-thumbnail@2x.jpg"
    },
    "strip_id": "000000-000000-000000-000000",
    "strip": {
      "file_name": "super-cool-photo.jpg",
      "mime_type": "image/jpeg",
      "original_url": "https://example.com/media/super-cool-photo.jpg",
      "size": 84256,
      "url": "https://example.com/media/super-cool-photo-thumbnail@2x.jpg"
    }
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.