Update Pass notification

curl --request PATCH \
  --url https://api.ubpass.co/v1/wallet-pass/notifications/{id} \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '{
  "notificationName": "VIP Member Update - Enhanced",
  "notificationMessage": "Your VIP membership benefits have been updated with new exclusive offers! Don'\''t miss out on the latest deals.",
  "status": "Scheduled",
  "scheduledTime": "2025-09-05T10:00:00.000Z"
}'

{
  "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",
  "passSerialNumber": "1f09804f-d6c7-66ec-8db2-27a5651e1de2",
  "notificationName": "VIP Member Update - Enhanced",
  "notificationMessage": "Your VIP membership benefits have been updated with new exclusive offers! Don't miss out on the latest deals.",
  "status": "Scheduled",
  "scheduledTime": "2025-09-05T10:00:00.000Z",
  "sentTime": null
}

Passport - Push Notifications

Update Pass notification

Update wallet pass notification. Only Draft or Scheduled notifications can be updated.

Status Changes:

Change from Draft to Processing for immediate delivery
Change from Draft to Scheduled for future delivery
Update Scheduled notifications to change delivery time or content

Scheduling Notes:

Scheduled notifications are processed every 15 minutes
Delivery may occur within 15 minutes of the scheduled time
Once a notification is Processing or Published, it cannot be updated

PATCH

wallet-pass

notifications

{id}

Update Pass notification

curl --request PATCH \
  --url https://api.ubpass.co/v1/wallet-pass/notifications/{id} \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '{
  "notificationName": "VIP Member Update - Enhanced",
  "notificationMessage": "Your VIP membership benefits have been updated with new exclusive offers! Don'\''t miss out on the latest deals.",
  "status": "Scheduled",
  "scheduledTime": "2025-09-05T10:00:00.000Z"
}'

{
  "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",
  "passSerialNumber": "1f09804f-d6c7-66ec-8db2-27a5651e1de2",
  "notificationName": "VIP Member Update - Enhanced",
  "notificationMessage": "Your VIP membership benefits have been updated with new exclusive offers! Don't miss out on the latest deals.",
  "status": "Scheduled",
  "scheduledTime": "2025-09-05T10:00:00.000Z",
  "sentTime": null
}

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

string

required

Unique identifier of the notification to update

Body

application/json

Updated notification data including message content and scheduling options

passSerialNumber

string

required

Wallet pass id to which the notification belongs.

notificationName

string

required

Notification name. This is will not appear on pass, it's used internally to identify the notification.

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 id to which the notification belongs.

notificationMessage

string

Notification message. For Apple passes, this message will be displayed on the lock screen when a notification is sent to the pass. For Google passes, this message will be displayed at the back of the pass when a notification is sent to the pass.

status

enum<string>

Notification status: Draft: Notification will not be sent until the status is changed to Scheduled or ProcessingScheduled: Notification is scheduled to be sent at a specific time. Processing: Notification is being sent. Published: Notification has been sent.Failed: Notification failed to be sent. If the status is not specified at the time of creation, it will be sent immediately.

Available options:

Draft,

Initializing,

Processing,

Finalizing,

Published,

Scheduled,

AppleFailedGoogleSuccess,

AppleSuccessGoogleFailed,

Failed

publishedTime

string<date-time>

Time when the notification was sent in ISO 8601 format including milliseconds and timezone offset.

scheduledTime

string<date-time>

Time when the notification will be sent in ISO 8601 format including milliseconds and timezone offset.

appleNotificationSentCount

integer

Number of active users who have received this notification on their Apple Wallets.

googleNotificationSentCount

integer

Number of active users who have received this notification on their Google Wallets.

totalNotificationSentCount

integer

Total number of active users who have received this notification on their wallets (Apple + Google).

notificationStats

object

Show child attributes

Response

Notification updated successfully

passSerialNumber

string

required

Wallet pass id to which the notification belongs.

notificationName

string

required

Notification name. This is will not appear on pass, it's used internally to identify the notification.

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 id to which the notification belongs.

notificationMessage

string

status

enum<string>

Available options:

Draft,

Initializing,

Processing,

Finalizing,

Published,

Scheduled,

AppleFailedGoogleSuccess,

AppleSuccessGoogleFailed,

Failed

publishedTime

string<date-time>

Time when the notification was sent in ISO 8601 format including milliseconds and timezone offset.

scheduledTime

string<date-time>

Time when the notification will be sent in ISO 8601 format including milliseconds and timezone offset.

appleNotificationSentCount

integer

Number of active users who have received this notification on their Apple Wallets.

googleNotificationSentCount

integer

Number of active users who have received this notification on their Google Wallets.

totalNotificationSentCount

integer

Total number of active users who have received this notification on their wallets (Apple + Google).

notificationStats

object

Show child attributes

Delete Pass notification Get notification statistics

Getting Started

Pique

Passport - Passes

Passport - Push Notifications

Passport - Locations

Upload APIs

Update Pass notification

Authorizations

Headers

Path Parameters

Body

Response