PATCH
/
wallet-pass
/
notifications
/
{id}
Update push 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 '{
  "passSerialNumber": "<string>",
  "notificationName": "<string>",
  "notificationMessage": "<string>",
  "status": "Draft",
  "scheduledTime": "2023-11-07T05:31:56Z"
}'
{
  "passSerialNumber": "<string>",
  "notificationName": "<string>",
  "notificationMessage": "<string>",
  "status": "Draft",
  "scheduledTime": "2023-11-07T05:31:56Z"
}

Authorizations

​
api-key
string
header
required

Path Parameters

​
id
string
required

Pass id

Body

application/json

Update notification request body

​
passSerialNumber
string
required

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.

​
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. Scheduled: Notification is scheduled to be sent at a specific time.

Available options:
Draft,
Scheduled
​
scheduledTime
string<date-time>

Time when the notification will be sent in ISO 8601 format including milliseconds and timezone offset. Notifications are processed and sent in batches every 15 minutes (at :00, :15, :30, and :45 minutes past each hour). Scheduled times that fall between these intervals will be automatically queued for the next available batch.

Response

Notification has been created successfully.

​
passSerialNumber
string
required

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.

​
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. Scheduled: Notification is scheduled to be sent at a specific time.

Available options:
Draft,
Scheduled
​
scheduledTime
string<date-time>

Time when the notification will be sent in ISO 8601 format including milliseconds and timezone offset. Notifications are processed and sent in batches every 15 minutes (at :00, :15, :30, and :45 minutes past each hour). Scheduled times that fall between these intervals will be automatically queued for the next available batch.