Sign in

v2

latestOpenAPI 3.1.02026-08-074390396.7 KB
Passes

Update pass

patch/api/v1/passes/{id}

Path parameters

idstring required

Pass UUID or External ID

Query parameters

includePassDesignboolean

If true, includes the pass design in the response

includeLocationsboolean

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

includeBeaconsboolean

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

Request body

messagestring

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

passAction'deactivate' | 'reactivate'

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.
groupTagstring

Tag used for grouping passes

Example request

{
  "pass": {
    "qr": {
      "value": "abc123"
    },
    "barcode": {
      "value": "abc123"
    },
    "beacons": {
      "data": [
        {
          "proximityUUID": "F8F589E9-C07E-58B0-AEAB-A36BE4D48FAC",
          "relevantText": "You're near my store"
        }
      ],
      "actions": {
        "delete": [
          {
            "proximityUUID": "F8F589E9-C07E-58B0-AEAB-A36BE4D48FAC",
            "relevantText": "You're near my store"
          }
        ]
      }
    },
    "locations": {
      "data": [
        {
          "latitude": 51.54321132456805,
          "longitude": -0.022901231803803924,
          "maxDistance": 400,
          "relevantText": "You're near my store"
        }
      ],
      "actions": {
        "delete": [
          {
            "latitude": 51.54321132456805,
            "longitude": -0.022901231803803924,
            "maxDistance": 400,
            "relevantText": "You're near my store"
          }
        ]
      }
    },
    "templateOverride": {
      "bannerImage": {
        "imageAssetId": "19cb334f9696e64e10e7759f0"
      },
      "logoImage": {
        "imageAssetId": "19cb334f9696e64e10e7759f0"
      },
      "thumbnailImage": {
        "imageAssetId": "19cb334f9696e64e10e7759f0"
      },
      "artworkImage": {
        "imageAssetId": "19cb334f9696e64e10e7759f0"
      },
      "secondaryLogoImage": {
        "imageAssetId": "19cb334f9696e64e10e7759f0"
      },
      "venueMapImage": {
        "imageAssetId": "19cb334f9696e64e10e7759f0"
      }
    },
    "enhancedEventData": {
      "event": {
        "name": "PassEntry Christmas Party",
        "startDateTime": "2026-12-10T18:00:00Z",
        "endDateTime": "2026-12-10T22:00:00Z"
      },
      "venue": {
        "name": "Fulham Green",
        "region": "London",
        "location": {
          "latitude": 51.468532,
          "longitude": -0.210611
        },
        "contactPhoneNumber": "+447400123456",
        "contactEmailAddress": "venue@passentry.com",
        "websiteUrl": "https://www.example.com"
      },
      "seat": {
        "number": "7",
        "row": "H",
        "section": "312",
        "gate": "26"
      },
      "eventGuide": {
        "venueOpenDateTime": "2026-12-10T17:00:00Z",
        "venueCloseDateTime": "2026-12-10T22:00:00Z",
        "bagPolicyUrl": "https://www.example.com/bag-policy",
        "orderFoodUrl": "https://www.example.com/order-food",
        "transitInformationUrl": "https://www.example.com/transit-information",
        "parkingInformationUrl": "https://www.example.com/parking-information",
        "directionsInformationUrl": "https://www.example.com/directions-information",
        "merchandiseUrl": "https://www.example.com/merchandise",
        "accessibilityUrl": "https://www.example.com/accessibility",
        "addOnUrl": "https://www.example.com/add-on"
      }
    }
  },
  "message": "Your pass details have been updated. Click to show pass",
  "locations": [
    {
      "name": "West Entrance",
      "latitude": 51.54321132456805,
      "longitude": -0.022901231803803924,
      "radius": 90,
      "message": "Welcome! Enjoy the show!"
    }
  ],
  "beacons": [
    {
      "name": "West Entrance",
      "proximityUuid": "E2C56DB5-DFFB-48D2-B060-D0F5A71096E0",
      "major": 1246,
      "minor": 6421,
      "message": "You're near my store"
    }
  ],
  "groupTag": "EASTER_OFFER_22",
  "groupTags": [
    "EASTER_OFFER_22",
    "SUMMER_SALE_22"
  ]
}

Response

Successful

Example response

{
  "data": {
    "id": "e89b1330fc391ec89656f3c664318cff8805471e",
    "type": "pass",
    "attributes": {
      "barcode": {
        "value": "123abcd"
      },
      "passDesign": {
        "backgroundColor": "#EFEFEF",
        "labelColor": "#EFEFEF",
        "textColor": "#EFEFEF"
      },
      "locations": [
        {
          "name": "West Entrance",
          "latitude": 51.54321132456805,
          "longitude": -0.022901231803803924,
          "radius": 90,
          "message": "Welcome! Enjoy the show!",
          "address": "Mick's Garage, Queens Yard, London, England, E9 5EN, United Kingdom"
        }
      ],
      "beacons": [
        {
          "proximityUuid": "E2C56DB5-DFFB-48D2-B060-D0F5A71096E0",
          "major": 65535,
          "minor": 8525,
          "message": "You're near my store",
          "name": "West Entrance"
        }
      ],
      "enhancedEventData": {
        "event": {
          "name": "PassEntry Christmas Party",
          "startDateTime": "2026-12-10T18:00:00Z",
          "endDateTime": "2026-12-10T22:00:00Z"
        },
        "venue": {
          "name": "Fulham Green",
          "region": "London",
          "location": {
            "latitude": 51.468532,
            "longitude": -0.210611
          },
          "contactPhoneNumber": "+447400123456",
          "contactEmailAddress": "venue@passentry.com",
          "websiteUrl": "https://www.example.com"
        },
        "seat": {
          "number": "7",
          "row": "H",
          "section": "312",
          "gate": "26"
        },
        "eventGuide": {
          "venueOpenDateTime": "2026-12-10T17:00:00Z",
          "venueCloseDateTime": "2026-12-10T22:00:00Z"
        }
      }
    }
  },
  "meta": {
    "notifications": {
      "message": "Delivered succesfully"
    }
  }
}