PATCH
/
wallet-pass
/
{id}
Update Pass
curl --request PATCH \
  --url https://api.ubpass.co/v1/wallet-pass/{id} \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '{
  "notificationHeader": "BLUE PASS",
  "passName": "VIP MEMBERSHIP PASS - UPDATED",
  "passMetadata": {
    "description": "Updated VIP membership pass with enhanced benefits",
    "organizationName": "Premium Brands Inc",
    "backgroundColor": "#4a32A8",
    "displayTextColor": "#FFFFFF",
    "topField": {
      "key": "tabKey",
      "label": "SEE OFFERS",
      "value": "Tab (...)"
    },
    "secondaryFields": [
      {
        "key": "auxiliaryFieldKey",
        "label": "Member Level",
        "value": "VIP Platinum"
      },
      {
        "key": "auxiliaryFieldKey2",
        "label": "Expires",
        "value": "Dec 31, 2026"
      }
    ],
    "backFields": [
      {
        "key": "featured",
        "label": "Featured",
        "value": [
          {
            "link": "https://premiumbrands.com/",
            "text": "Visit Our Website"
          }
        ]
      },
      {
        "key": "connectWithUs",
        "label": "Connect",
        "value": [
          {
            "link": "https://x.com/premiumbrands/",
            "text": "X"
          },
          {
            "link": "https://www.instagram.com/premiumbrands/",
            "text": "Instagram"
          }
        ],
        "changeMessage": null
      }
    ],
    "qrUrl": "https://premiumbrands.com/vip-benefits",
    "qrText": "Scan for VIP benefits"
  },
  "uploadInfoList": [
    {
      "fileName": "icon.png",
      "uploadKey": "1f089d37-8a1b-4c2d-9e3f-123456789abc"
    },
    {
      "fileName": "logo.png",
      "uploadKey": "1f089d37-8a1b-4c2d-9e3f-123456789def"
    },
    {
      "fileName": "strip.png",
      "uploadKey": "1f089d37-8a1b-4c2d-9e3f-123456789ghi"
    }
  ]
}'
{
  "id": "1f089d37-5ebe-6778-af59-99631cec7ab5",
  "createdTime": "2025-09-04T21:09:36.027Z",
  "updatedTime": "2025-09-04T21:15:42.123Z",
  "createdBy": "1ef58ae6-40ac-6fd2-96af-45801844c4e2",
  "updatedBy": "1ef58ae6-40ac-6fd2-96af-45801844c4e2",
  "workspaceId": "1f089d29-6f9c-66c2-af59-99631cec7ab5",
  "accountId": "1f089d29-6fa8-6a13-af59-99631cec7ab5",
  "notificationHeader": "BLUE PASS",
  "passName": "VIP MEMBERSHIP PASS - UPDATED",
  "status": "Published",
  "passMetadata": {
    "description": "Updated VIP membership pass with enhanced benefits",
    "organizationName": "Premium Brands Inc",
    "backgroundColor": "#4a32A8",
    "displayTextColor": "#FFFFFF",
    "topField": {
      "key": "tabKey",
      "label": "SEE OFFERS",
      "value": "Tab (...)"
    },
    "secondaryFields": [
      {
        "key": "auxiliaryFieldKey",
        "label": "Member Level",
        "value": "VIP Platinum"
      },
      {
        "key": "auxiliaryFieldKey2",
        "label": "Expires",
        "value": "Dec 31, 2026"
      }
    ],
    "qrUrl": "https://premiumbrands.com/vip-benefits",
    "qrText": "Scan for VIP benefits"
  },
  "uploadInfoList": [
    {
      "fileName": "icon.png",
      "uploadKey": "1f089d37-8a1b-4c2d-9e3f-123456789abc"
    },
    {
      "fileName": "logo.png",
      "uploadKey": "1f089d37-8a1b-4c2d-9e3f-123456789def"
    },
    {
      "fileName": "strip.png",
      "uploadKey": "1f089d37-8a1b-4c2d-9e3f-123456789ghi"
    }
  ]
}

Authorizations

​
api-key
string
header
required

API Key authentication

Headers

​
x-workspace-id
string

Workspace ID to perform the operation in. If not provided, system will use the first one assigned to the user

Path Parameters

​
id
string
required

Unique identifier of the wallet pass to update

Body

application/json

Updated wallet pass data including metadata, fields, and asset references

​
passName
string
required

Name of the pass, the name has to be unique within the workspace.

Example:

"My Wallet Pass"

​
passMetadata
object
required

Pass metadata.

​
id
string
​
createdTime
string<date-time>

The time when the entity was created in ISO 8601 format including milliseconds and timezone offset.

Example:

"2025-05-13T15:07:15.036Z"

​
updatedTime
string<date-time>

The time when the entity was last updated in ISO 8601 format including milliseconds and timezone offset.

Example:

"2025-05-13T15:07:15.036Z"

​
createdBy
string

The user who created the entity.

​
updatedBy
string

The user who last updated the entity.

​
workspaceId
string

Workspace the pass belongs to.

​
uploadInfoList
object[]

Wallet pass images. each pass has to have a logo, icon, and strip images in png format. footer.png is optional.

​
passLink
string

The link where passes can be downloaded. This link will be generated after passes are created.

​
notificationHeader
string

This is used for Apple passes. The notification header is displayed on the lock screen when a notification is sent to the pass.

​
account
object

Account which the pass belongs to. If it's not provided the system will automatically use the default account for the workspace.

​
appleIssuedCount
integer

Total number of users who have added this pass to their Apple Wallets

​
googleIssuedCount
integer

Total number of users who have added this pass to their Google Wallets

​
totalIssuedCount
integer

Total number of users who have added this pass to their wallets (Apple + Google)

​
appleActiveCount
integer

Total number of users who have added this pass to their Apple Wallets and have not removed it

​
googleActiveCount
integer

Total number of users who have added this pass to their Google Wallets and have not removed it

​
totalActiveCount
integer

Total number of users who have added this pass to their wallets (Apple + Google) and have not removed it

​
passLinkSlug
string

Slug to be used for the pass link. This is used to generate the pass link, if not provided the system will generate a random slug.

​
googlePassLink
string

Raw link to Google Pass. This link is provided by Google API.

​
status
enum<string>

Pass status

Available options:
Draft,
Published
Example:

"Draft, Published"

Response

Wallet pass updated successfully

​
passName
string
required

Name of the pass, the name has to be unique within the workspace.

Example:

"My Wallet Pass"

​
passMetadata
object
required

Pass metadata.

​
id
string
​
createdTime
string<date-time>

The time when the entity was created in ISO 8601 format including milliseconds and timezone offset.

Example:

"2025-05-13T15:07:15.036Z"

​
updatedTime
string<date-time>

The time when the entity was last updated in ISO 8601 format including milliseconds and timezone offset.

Example:

"2025-05-13T15:07:15.036Z"

​
createdBy
string

The user who created the entity.

​
updatedBy
string

The user who last updated the entity.

​
workspaceId
string

Workspace the pass belongs to.

​
uploadInfoList
object[]

Wallet pass images. each pass has to have a logo, icon, and strip images in png format. footer.png is optional.

​
passLink
string

The link where passes can be downloaded. This link will be generated after passes are created.

​
notificationHeader
string

This is used for Apple passes. The notification header is displayed on the lock screen when a notification is sent to the pass.

​
account
object

Account which the pass belongs to. If it's not provided the system will automatically use the default account for the workspace.

​
appleIssuedCount
integer

Total number of users who have added this pass to their Apple Wallets

​
googleIssuedCount
integer

Total number of users who have added this pass to their Google Wallets

​
totalIssuedCount
integer

Total number of users who have added this pass to their wallets (Apple + Google)

​
appleActiveCount
integer

Total number of users who have added this pass to their Apple Wallets and have not removed it

​
googleActiveCount
integer

Total number of users who have added this pass to their Google Wallets and have not removed it

​
totalActiveCount
integer

Total number of users who have added this pass to their wallets (Apple + Google) and have not removed it

​
passLinkSlug
string

Slug to be used for the pass link. This is used to generate the pass link, if not provided the system will generate a random slug.

​
googlePassLink
string

Raw link to Google Pass. This link is provided by Google API.

​
status
enum<string>

Pass status

Available options:
Draft,
Published
Example:

"Draft, Published"