Sign in

v2

latestOpenAPI 3.1.02026-08-074390396.7 KB
Loyalty

Update loyalty balance

patch/api/v1/loyalty/{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

balanceinteger

If integer is positive, balance is added. If negative, balance is subtracted. Cannot be used with overrideBalance key

overrideBalanceinteger

Override the balance and set it to this value. Cannot be used with balance key

messagestring

Push Notification message to display. Only used if pass is active. Use alongside balance or overrideBalance keys

Example request

{
  "balance": -10
}

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"
        }
      }
    }
  }
}