Update pass

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

string

required

Pass UUID or External ID

Query Parameters

includePassDesign

boolean

If true, includes the pass design in the response

includeLocations

boolean

If true, includes the locations in the response if any are present

includeBeacons

boolean

If true, includes the beacons in the response if any are present

Body

application/json

pass

object

Show child attributes

pass.nfc[DEPRECATED]

boolean

deprecated

Whether the pass is NFC enabled. Setting this to true will set the pass UUID as the NFC message. This parameter is deprecated, please use the nfc object instead.

Example:

false

pass.nfc

object

Show child attributes

pass.nfc.enabled

boolean

Whether the pass is NFC enabled.

pass.nfc.source

enum<string>

Source of the NFC message

Available options:

extId,

custom,

uuid

pass.nfc.customValue

string

Custom NFC message, source must be set to custom

pass.qr

object

deprecated

This parameter is deprecated, please use the barcode object instead.

Show child attributes

pass.qr.value

string

QR code value

Example:

"abc123"

pass.qr.displayText

boolean

If true, display the QR code value as text on the pass

pass.barcode

object

Show child attributes

pass.barcode.enabled

boolean

If true, barcode will be added to the pass

pass.barcode.type

enum<string>

Barcode type

Available options:

qr,

code128,

aztec,

pdf417

pass.barcode.source

enum<string>

Source of the barcode

Available options:

uuid,

extId,

custom

pass.barcode.value

string

Barcode value, source must be set to custom If your source type is uuid or extId don't need to set this value.

You can make the value dynamic using the %{passData.xyz} syntax (e.g., Hello, %{passData.extId}). Currently, only %{passData.extId} and %{passData.uuid} are supported.

Example:

"abc123"

pass.barcode.displayText

boolean

If true, display the barcode value as text on the pass

pass.beacons

object

Array of iBeacons, currently only available on Apple devices, due to Android device restrictions. Maximum of 10 iBeacons per pass. To update an existing iBeacon, include the proximityUUID, major and minor values in the data array while sending a PATCH request. Only relevantText can be updated. For more actions, use the beaconActions object.

Show child attributes

pass.beacons.data

object[]

Maximum array length: 10

Show child attributes

pass.beacons.data.proximityUUID

string

Unique identifier of a beacon

Example:

"F8F589E9-C07E-58B0-AEAB-A36BE4D48FAC"

pass.beacons.data.major

integer

Major Value, provides additional identification for a beacon

Example:

"65535"

pass.beacons.data.minor

integer

Minor Value, provides additional identification for a beacon

Example:

"8525"

pass.beacons.data.relevantText

string

Text to display on lock screen when the user is in range of the beacon

Example:

"You're near my store"

pass.beacons.actions

object

Actions to perform on beacons, only one at a time. Must be called using method PATCH

Show child attributes

pass.beacons.actions.deleteAll

boolean

Delete all beacons. Data array must be empty.

pass.beacons.actions.replaceAll

boolean

Include ibeacons in the data array. When this action is invoked, all existing beacons are deleted, and replaced with the new beacons.

pass.beacons.actions.delete

object[]

Array of iBeacons to delete

Show child attributes

pass.beacons.actions.delete.proximityUUID

string

Unique identifier of a beacon

Example:

"F8F589E9-C07E-58B0-AEAB-A36BE4D48FAC"

pass.beacons.actions.delete.major

integer

Major Value, provides additional identification for a beacon

Example:

"65535"

pass.beacons.actions.delete.minor

integer

Minor Value, provides additional identification for a beacon

Example:

"8525"

pass.beacons.actions.delete.relevantText

string

Text to display on lock screen when the user is in range of the beacon

Example:

"You're near my store"

pass.locations

object

deprecated

Array of locations. Maximum of 10 locations per pass. To update an existing location, include latitude and longitued values in the data array while sending a PATCH request. Only relevantText and maxDistance values can be updated. For more actions, use the beaconActions object.

Show child attributes

pass.locations.data

object[]

Maximum array length: 10

Show child attributes

pass.locations.data.latitude

number<double>

Latitude of the location in degrees

Example:

51.54321132456805

pass.locations.data.longitude

number<double>

Longitude of the location in degrees

Example:

-0.022901231803803924

pass.locations.data.maxDistance

integer

Specifies the maximum radius distance in meters. If passType is eventTicket, max is 1000. Otherwise, max is 100. Currently only available on Apple devices, due to Android device restrictions.

Required range: x >= 10

Example:

400

pass.locations.data.relevantText

string

Text to display on lock screen when the user is in range of the location. Currently only available on Apple devices, due to Android device restrictions.

Example:

"You're near my store"

pass.locations.actions

object

Actions to perform on locations, only one at a time. Must be called using method PATCH

Show child attributes

pass.locations.actions.deleteAll

boolean

Delete all locations. Data array must be empty.

pass.locations.actions.replaceAll

boolean

Include locations in the data array. When this action is invoked, all existing locations are deleted, and replaced with the new locations.

pass.locations.actions.delete

object[]

Array of locations to delete

Show child attributes

pass.locations.actions.delete.latitude

number<double>

Latitude of the location in degrees

Example:

51.54321132456805

pass.locations.actions.delete.longitude

number<double>

Longitude of the location in degrees

Example:

-0.022901231803803924

pass.locations.actions.delete.maxDistance

integer

Specifies the maximum radius distance in meters. If passType is eventTicket, max is 1000. Otherwise, max is 100. Currently only available on Apple devices, due to Android device restrictions.

Required range: x >= 10

Example:

400

pass.locations.actions.delete.relevantText

string

Text to display on lock screen when the user is in range of the location. Currently only available on Apple devices, due to Android device restrictions.

Example:

"You're near my store"

pass.templateOverride

object

Overrides the pass template design, if templateOverride are set, any changes to the pass template will not be applied to this pass. To revert to the original template design, pass null to any previously overriden value.

Show child attributes

pass.templateOverride.backgroundColor

string | null

Must be a valid hex color code. Background color cannot be overridden for Google Wallet loyalty passes and must be set at template level.

pass.templateOverride.labelColor

string | null

Must be a valid hex color code. Only valid for iphone passes

pass.templateOverride.textColor

string | null

Must be a valid hex color code. Only valid for iphone passes

pass.templateOverride.bannerImage

string | null

URL of the banner image. Must be direct image URL, valid media types are PNG, JPEG, JPG

Example:

"https://passentry.com/static/media/logo.0f0e5d7eb4cd5f6d2d6d9243b357043e.svg"

pass.templateOverride.logoImage

string | null

URL of the logo image. Must be direct image URL, valid media types are PNG, JPEG, JPG. DOES NOT UPDATE GOOGLE LOGO, GOOGLE LOGO MUST BE SET AT TEMPLATE LEVEL.

Example:

"https://passentry.com/static/media/logo.0f0e5d7eb4cd5f6d2d6d9243b357043e.svg"

pass.templateOverride.thumbnailImage

string | null

URL of the thumbnail image. Must be direct image URL, valid media types are PNG, JPEG, JPG. PASS TYPE MUST BE GENERIC. DOES NOT APPEAR ON GOOGLE PASSES

Example:

"https://passentry.com/static/media/logo.0f0e5d7eb4cd5f6d2d6d9243b357043e.svg"

pass.expiresAt

string | null

In ISO8601 format, UTC. If present, pass will be deactivated at this time. Pass status will be set to deactivated. Google wallet passes may take up to 24 hours to deactivate. If your organisation is in trial, expiresAt may not be set after the trial expiry..

pass.relevantDateTime

string

In ISO8601 format, UTC. Currently only available on Apple devices, due to Android device restrictions. If present, this enables upcoming notifications or persistent notifications for the pass

Note: You can only set this field if the pass type is eventTicket or transit

pass.{key}

The templateKey identifies a pass field in the template (using the template field ID). Its value must be an object with a required value string, and may optionally include a localisation object that maps locale codes to translated values.

Note: This feature is in closed beta and currently only available on the API. Please contact PassEntry for access.

Example:

{
  "pass": {
    "eventName": {
      "value": "Summer Festival",
      "localisation": {
        "es": { "value": "Festival de Verano" },
        "fr": { "value": "Festival d'Été" }
      }
    }
  }
}

message

string

Push Notification message to display. If present, response will include X-Notification-Status header

Example:

"Your pass details have been updated. Click to show pass"

passAction

enum<string>

Only available when updating the pass.

deactivate: Deactivates the pass, setting it to 'expired' in the wallet. When in this state, pass can receive updates but does not receive Apple notifications.
reactivate: Reactivates the pass, setting it to 'active' in the wallet. In the case of Apple passes, the pass will remain in the 'expired' passes section of the wallet, user will need to manually select 'unhide' to move passes to the main passes view.

Available options:

deactivate,

reactivate

locations

object[]

Array of locations. Maximum of 10 locations

Show child attributes

locations.name

string

required

Name of the location, used for display purposes only

Example:

"West Entrance"

locations.latitude

number<double>

required

Latitude of the location

Example:

51.54321132456805

locations.longitude

number<double>

required

Longitude of the location

Example:

-0.022901231803803924

locations.radius

integer

default:100

Effective geofence radius of the location in meters. Maximum is 1000 for eventTicket passes, 100 for other pass types. Currently only available on Apple devices, due to Android device restrictions.

Required range: 10 <= x <= 1000

Example:

90

locations.message

string

Message to display when user enters geofence. Currently only available on Apple devices, due to Android device restrictions.

Example:

"Welcome! Enjoy the show!"

beacons

object[]

Array of beacons, currently only available on Apple devices, due to Android device restrictions. Maximum of 10 beacons

Show child attributes

beacons.name

string

required

Name of the beacon, used for display purposes only

Example:

"West Entrance"

beacons.proximityUuid

string

required

Unique identifier of the beacon

Example:

"E2C56DB5-DFFB-48D2-B060-D0F5A71096E0"

beacons.major

integer

Major Value, provides additional identification for a beacon

Required range: 0 <= x <= 65535

Example:

1246

beacons.minor

integer

Minor Value, provides additional identification for a beacon

Required range: 0 <= x <= 65535

Example:

6421

beacons.message

string | null

Message to display on lock screen when the user is in range of the beacon

Example:

"You're near my store"

groupTag

string

Tag used for grouping passes

Example:

"EASTER_OFFER_22"

groupTags

array

Tags used for grouping passes

Example:

["EASTER_OFFER_22", "SUMMER_SALE_22"]

Response

Successful

data

object

Show child attributes

data.id

string

Auto-generated UUID of the pass

Example:

"e89b1330fc391ec89656f3c664318cff8805471e"

data.type

string

Example:

"pass"

data.attributes

object

Show child attributes

data.attributes.downloadUrl

string

Unique download URL of the pass

data.attributes.passType

enum<string>

Pass Type

Available options:

generic,

eventTicket,

storeCard,

transit

data.attributes.deviceType

enum<string>

Available options:

android,

iphone

data.attributes.createdAt

string

In ISO8601 format, UTC

data.attributes.status

enum<string>

Pass Status

Available options:

issued,

active,

removed,

deactivated

data.attributes.extId

string | null

Pass External ID

data.attributes.groupTag

string | null

Tag used for grouping passes

data.attributes.groupTags

array | null

Tag used for grouping passes

data.attributes.addedAt

string | null

When pass has been added to wallet by the user. In ISO8601 format, UTC

data.attributes.removedAt

string | null

When pass has been removed from wallet by the user. In ISO8601 format, UTC

data.attributes.deactivatedAt

string | null

When pass has been deactivated. In ISO8601 format, UTC

data.attributes.expiresAt

string | null

Pass will expire at this time. In ISO8601 format, UTC

data.attributes.passTemplateUuid

string

UUID of corresponding pass template

data.attributes.passTemplateName

string

Name of corresponding pass template

data.attributes.nfc

string | null

If present, the NFC message to be conveyed when the pass is tapped

data.attributes.barcode

object

If present, the barcode type and value

Show child attributes

data.attributes.barcode.enabled

boolean

Barcode enabled

data.attributes.barcode.type

enum<string>

Barcode type

Available options:

qr,

code128,

aztec,

pdf417

data.attributes.barcode.source

enum<string>

Barcode source

Available options:

uuid,

extId,

custom

data.attributes.barcode.value

string

Barcode value

Example:

"123abcd"

data.attributes.barcode.displayText

boolean

If true, display the barcode value as text on the pass

data.attributes.latestMessage

string | null

If present, the last push message sent to the pass

data.attributes.passContent

object

Show child attributes

data.attributes.passContent.{key}

Example:

{
  "eventName": {
    "value": "Summer Festival",
    "localisation": {
      "es": { "value": "Festival de Verano" },
      "fr": { "value": "Festival d'Été" }
    }
  }
}

data.attributes.passDesign

object

Pass design values, present if pass template has been overridden for this pass, or if 'includePassDesign' query param is set to true

Show child attributes

data.attributes.passDesign.backgroundColor

string

Pass background color in hex format

Example:

"#EFEFEF"

data.attributes.passDesign.labelColor

string

Pass label color in hex format. Only valid for iphone passes

Example:

"#EFEFEF"

data.attributes.passDesign.textColor

string

Pass text color in hex format. Only valid for iphone passes

Example:

"#EFEFEF"

data.attributes.passDesign.bannerImageUrl

string

URL of pass banner image

data.attributes.passDesign.logoImageUrl

string

URL of pass logo image

data.attributes.locations

object[]

Locations, present if 'includeLocations' query param is set to true

Show child attributes

data.attributes.locations.name

string

Name of the location, used for display purposes only

Example:

"West Entrance"

data.attributes.locations.latitude

number<double>

Latitude of the location

Example:

51.54321132456805

data.attributes.locations.longitude

number<double>

Longitude of the location

Example:

-0.022901231803803924

data.attributes.locations.radius

integer

default:100

Effective geofence radius of the location in meters. Maximum is 1000 for eventTicket passes, 100 for other pass types. Currently only available on Apple devices, due to Android device restrictions.

Required range: 10 <= x <= 1000

Example:

90

data.attributes.locations.message

string

Message to display when user enters geofence. Currently only available on Apple devices, due to Android device restrictions.

Example:

"Welcome! Enjoy the show!"

data.attributes.locations.address

string

Geocoded address of the location. Used for display purposes only. This is calculated automatically from the latitude and longitude values

Example:

"Mick's Garage, Queens Yard, London, England, E9 5EN, United Kingdom"

data.attributes.beacons

object[]

Beacons, present if 'includeBeacons' query param is set to true

Show child attributes

data.attributes.beacons.proximityUuid

string

Unique identifier of the beacon

Example:

"E2C56DB5-DFFB-48D2-B060-D0F5A71096E0"

data.attributes.beacons.major

integer

Major Value, provides additional identification for a beacon

Example:

65535

data.attributes.beacons.minor

integer

Minor Value, provides additional identification for a beacon

Example:

8525

data.attributes.beacons.message

string | null

Message to display on lock screen when the user is in range of the beacon

Example:

"You're near my store"

data.attributes.beacons.name

string

Name of the beacon, used for display purposes only

Example:

"West Entrance"

data.attributes.passSource

object

Pass source, present if 'includePassDesign' query param is present, one of Apple/Google and current pass status is not 'active'.

Show child attributes

data.attributes.passSource.oneOf

object

Show child attributes

data.attributes.passSource.oneOf.appleBase64

string

Apple Wallet Pass Base64 string, to generate the pass, decode the string and save as a .pkpass file. Will prompt the user to download the pass to their Apple Wallet when opened on an iPhone.

data.attributes.passSource.oneOf.googleDownloadUrl

string

Google Wallet Pass download URL. Will prompt the user to download the pass to their Google Wallet when opened on an Android device.

Introduction

Entities

Pass Templates

Passes

Readers

Scans

Loyalty

Webhook Subscriptions

Webhooks

Batches

Authorizations

Path Parameters

Query Parameters

Body

Response