Update pass
curl --request PATCH \
--url https://api.passentry.com/api/v1/passes/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"pass": {
"nfc": {
"enabled": false
},
"fullName": "Jane Roberts"
},
"message": "Your pass details have been updated. Click to show pass",
"locations": [
{
"name": "Venue",
"latitude": 51.54321132456805,
"longitude": -0.022901231803803924,
"radius": 100,
"message": "Welcome to the venue"
}
]
}'{
"data": {
"id": "d2ac8d95-6914-4cac-957c-2a5ccf534390",
"type": "pass",
"attributes": {
"downloadUrl": "https://www.example.com?pass=d2ac8d95-6914-4cac-957c-2a5ccf534390",
"passType": "generic",
"createdAt": "2022-01-01T00:00:00Z",
"status": "issued",
"extId": "b1985e420025dd92ccf2",
"passTemplateUuid": "2e2d7ee8c306e8f0223dbdc1",
"passTemplateName": "PassEntry Ticketing",
"nfc": null,
"barcode": null,
"latestMessage": "Your pass details have been updated. Click to show pass",
"passContent": {
"fullName": "Jane Roberts",
"nfc": {
"enabled": false
}
}
}
},
"meta": {
"notifications": {
"status": "notDelivered",
"message": "Pass has not been added to the wallet"
}
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Pass UUID or External ID
Query Parameters
If true, includes the pass design in the response
If true, includes the locations in the response if any are present
If true, includes the beacons in the response if any are present
Body
Whether the pass is NFC enabled. Setting this to true will set the pass UUID as the NFC message
false
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.
iBeacon object
Unique identifier of a beacon
"F8F589E9-C07E-58B0-AEAB-A36BE4D48FAC"
Major Value, provides additional identification for a beacon
"65535"
Minor Value, provides additional identification for a beacon
"8525"
Text to display on lock screen when the user is in range of the beacon
"You're near my store"
Actions to perform on beacons, only one at a time. Must be called using method PATCH
Delete all beacons. Data array must be empty.
Include ibeacons in the data array. When this action is invoked, all existing beacons are deleted, and replaced with the new beacons.
Array of iBeacons to delete
iBeacon object
Unique identifier of a beacon
"F8F589E9-C07E-58B0-AEAB-A36BE4D48FAC"
Major Value, provides additional identification for a beacon
"65535"
Minor Value, provides additional identification for a beacon
"8525"
Text to display on lock screen when the user is in range of the beacon
"You're near my store"
Array of locations, currently only available on Apple devices, due to Android device restrictions. 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.
Location object
Latitude of the location in degrees
51.54321132456805
Latitude of the location in degrees
-0.022901231803803924
Specifies the maximum radius distance in meters. If passType is eventTicket, max is 1000. Otherwise, max is 100.
x >= 10400
Text to display on lock screen when the user is in range of the beacon
"You're near my store"
Actions to perform on locations, only one at a time. Must be called using method PATCH
Delete all locations. Data array must be empty.
Include locations in the data array. When this action is invoked, all existing locations are deleted, and replaced with the new locations.
Array of locations to delete
Location object
Latitude of the location in degrees
51.54321132456805
Latitude of the location in degrees
-0.022901231803803924
Specifies the maximum radius distance in meters. If passType is eventTicket, max is 1000. Otherwise, max is 100.
x >= 10400
Text to display on lock screen when the user is in range of the beacon
"You're near my store"
Overrides the pass template design, if templateOverride are set, any changes to the pass template will not be applied to this pass. Pass design will need to be updated via templateOverride.
Must be a valid hex color code, if pass type is loyalty and device is google does not update color. Must be set at template level.
Must be a valid hex color code. Only valid for iphone passes
Must be a valid hex color code. Only valid for iphone passes
URL of the banner image. Must be direct image URL, valid media types are PNG, JPEG, JPG
"https://passentry.com/static/media/logo.0f0e5d7eb4cd5f6d2d6d9243b357043e.svg"
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.
"https://passentry.com/static/media/logo.0f0e5d7eb4cd5f6d2d6d9243b357043e.svg"
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
"https://passentry.com/static/media/logo.0f0e5d7eb4cd5f6d2d6d9243b357043e.svg"
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.
The templateKey identifies an individual pass field in the pass template, using the template field ID. The value is the assigned value for a specific field and is displayed on the pass. For example, {'fullName': 'Jane Smith'} corresponds to the 'fullName' template field ID.
Push Notification message to display. If present, response will include X-Notification-Status header
"Your pass details have been updated. Click to show pass"
Only available when updating the pass.
deactivate, reactivate Array of locations, currently only available on Apple devices, due to Android device restrictions. Maximum of 10 locations
Name of the location, used for display purposes only
"West Entrance"
Latitude of the location
51.54321132456805
Longitude of the location
-0.022901231803803924
Effective geofence radius of the location in meters. Maximum is 1000 for eventTicket passes, 100 for other pass types
10 <= x <= 100090
Message to display when user enters geofence
"Welcome! Enjoy the show!"
Array of beacons, currently only available on Apple devices, due to Android device restrictions. Maximum of 10 beacons
Name of the beacon, used for display purposes only
"West Entrance"
Unique identifier of the beacon
"E2C56DB5-DFFB-48D2-B060-D0F5A71096E0"
Major Value, provides additional identification for a beacon
65535
Minor Value, provides additional identification for a beacon
8525
Message to display on lock screen when the user is in range of the beacon
"You're near my store"
Tag used for grouping passes
"EASTER_OFFER_22"
Response
Auto-generated UUID of the pass
"e89b1330fc391ec89656f3c664318cff8805471e"
"pass"
Unique download URL of the pass
Pass Type
generic, eventTicket, storeCard android, iphone In ISO8601 format, UTC
Pass Status
issued, active, removed, deactivated Pass External ID
Tag used for grouping passes
When pass has been added to wallet by the user. In ISO8601 format, UTC
When pass has been removed from wallet by the user. In ISO8601 format, UTC
When pass has been deactivated. In ISO8601 format, UTC
Pass will expire at this time. In ISO8601 format, UTC
UUID of corresponding pass template
Name of corresponding pass template
If present, the NFC message to be conveyed when the pass is tapped
If present, the last push message sent to the pass
The templateKey identifies an individual pass field in the pass template, using the template field ID. The value is the assigned value for a specific field and is displayed on the pass. For example, {'fullName': 'Jane Smith'} corresponds to the 'fullName' template field ID.
Pass design values, present if pass template has been overridden for this pass, or if 'includePassDesign' query param is set to true
Pass background color in hex format
"#EFEFEF"
Pass label color in hex format. Only valid for iphone passes
"#EFEFEF"
Pass text color in hex format. Only valid for iphone passes
"#EFEFEF"
URL of pass banner image
URL of pass logo image
Locations, present if 'includeLocations' query param is set to true
Name of the location, used for display purposes only
"West Entrance"
Latitude of the location
51.54321132456805
Longitude of the location
-0.022901231803803924
Effective geofence radius of the location in meters. Maximum is 1000 for eventTicket passes, 100 for other pass types
10 <= x <= 100090
Message to display when user enters geofence
"Welcome! Enjoy the show!"
Geocoded address of the location. Used for display purposes only. This is calculated automatically from the latitude and longitude values
"Mick's Garage, Queens Yard, London, England, E9 5EN, United Kingdom"
Beacons, present if 'includeBeacons' query param is set to true
Unique identifier of the beacon
"E2C56DB5-DFFB-48D2-B060-D0F5A71096E0"
Major Value, provides additional identification for a beacon
65535
Minor Value, provides additional identification for a beacon
8525
Message to display on lock screen when the user is in range of the beacon
"You're near my store"
Name of the beacon, used for display purposes only
"West Entrance"
Pass source, present if 'includePassDesign' query param is present, one of Apple/Google and current pass status is not 'active'.
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.
Google Wallet Pass download URL. Will prompt the user to download the pass to their Google Wallet when opened on an Android device.
Was this page helpful?
curl --request PATCH \
--url https://api.passentry.com/api/v1/passes/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"pass": {
"nfc": {
"enabled": false
},
"fullName": "Jane Roberts"
},
"message": "Your pass details have been updated. Click to show pass",
"locations": [
{
"name": "Venue",
"latitude": 51.54321132456805,
"longitude": -0.022901231803803924,
"radius": 100,
"message": "Welcome to the venue"
}
]
}'{
"data": {
"id": "d2ac8d95-6914-4cac-957c-2a5ccf534390",
"type": "pass",
"attributes": {
"downloadUrl": "https://www.example.com?pass=d2ac8d95-6914-4cac-957c-2a5ccf534390",
"passType": "generic",
"createdAt": "2022-01-01T00:00:00Z",
"status": "issued",
"extId": "b1985e420025dd92ccf2",
"passTemplateUuid": "2e2d7ee8c306e8f0223dbdc1",
"passTemplateName": "PassEntry Ticketing",
"nfc": null,
"barcode": null,
"latestMessage": "Your pass details have been updated. Click to show pass",
"passContent": {
"fullName": "Jane Roberts",
"nfc": {
"enabled": false
}
}
}
},
"meta": {
"notifications": {
"status": "notDelivered",
"message": "Pass has not been added to the wallet"
}
}
}