---
title: "Update the mobile pass customisation"
method: POST
path: "/customers/sites/{siteId}/mobile-pass-customisation"
tags: ["Sites"]
---

# Update the mobile pass customisation

`POST /customers/sites/{siteId}/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.

## Request body

- object
  - `icon_id` string, 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_id` string, uuid — `Media` to use as the logo on the mobile pass. Shown at the top of the pass next to the brand name.
  - `strip_id` string, uuid — The media id of the strip image
  - `background_colour` string — Background hex colour for the pass, excluding the leading `#`. Use the brand colour that contrasts well with white text.
  - `foreground_colour` string — Foreground hex colour for the primary pass copy, excluding the leading `#`. Pick a value with high contrast against `background_colour`.
  - `label_colour` string — Hex colour for the small field labels on the pass, excluding the leading `#`. Defaults to a slightly dimmer shade than `foreground_colour`.
  - `enabled` boolean — Whether or not to enable mobile passes for this site

## Response `200`

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

- object
  - `data` MobilePassCustomisation, required — Visual customisation for a site's mobile pass — Apple Wallet / Google Wallet — including the icon, logo, strip image and colour scheme. Each media reference points to a `Media` record uploaded via the media endpoints.
    - `enabled` boolean, required — Whether or not mobile passes are enabled for this site
    - `icon_id` string, uuid — The id of the icon
    - `icon` Media
      - `id` string, uuid, required — Unique identifier of the uploaded media item, returned from `createMedia`. Pass this ID into any field that accepts a media reference (logos, hero images, product images, etc.).
      - `file_name` string, required — Original filename of the uploaded asset, preserved as provided at upload time. Used for display in the media library and as a hint when serving downloads.
      - `mime_type` string, required — The mime type of the media item.
      - `original_url` string, required — The url of the media resource.
      - `size` integer, required — The size of the media item in bytes.
      - `url` string, required — The url of the converted media resource.
    - `logo_id` string, uuid — The id of the logo
    - `logo` Media
      - `id` string, uuid, required — Unique identifier of the uploaded media item, returned from `createMedia`. Pass this ID into any field that accepts a media reference (logos, hero images, product images, etc.).
      - `file_name` string, required — Original filename of the uploaded asset, preserved as provided at upload time. Used for display in the media library and as a hint when serving downloads.
      - `mime_type` string, required — The mime type of the media item.
      - `original_url` string, required — The url of the media resource.
      - `size` integer, required — The size of the media item in bytes.
      - `url` string, required — The url of the converted media resource.
    - `strip_id` string, uuid — The id of the strip image
    - `strip` Media
      - `id` string, uuid, required — Unique identifier of the uploaded media item, returned from `createMedia`. Pass this ID into any field that accepts a media reference (logos, hero images, product images, etc.).
      - `file_name` string, required — Original filename of the uploaded asset, preserved as provided at upload time. Used for display in the media library and as a hint when serving downloads.
      - `mime_type` string, required — The mime type of the media item.
      - `original_url` string, required — The url of the media resource.
      - `size` integer, required — The size of the media item in bytes.
      - `url` string, required — The url of the converted media resource.
    - `background_colour` string — A hex colour code excluding the preceding `#` for the background
    - `foreground_colour` string — A hex colour code excluding the preceding `#` for the foreground
    - `label_colour` string — A hex colour code excluding the preceding `#` for the labels

## Other responses

- `401` — The user is unauthenticated
- `403` — The authenticated user does not have permission.
- `404` — The resource couldn't be found
- `422` — The request didn't pass validation

---

[API](https://skmtc.dev/try/apis/trybe-api.md) · [All operations](https://skmtc.dev/try/apis/trybe-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/try/trybe-api/revisions/f37f92702da5/schema)