POST
/
api
/
v1
/
passes
/
{id}
/
notification
curl --request POST \
  --url https://api.passentry.com/api/v1/passes/{id}/notification \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "value": {
    "notification": {
      "message": "Use code PASSENTRY2024 for 10% off!"
    }
  }
}'
{
  "data": {
    "id": "e89b1330fc391ec89656f3c664318cff8805471e",
    "type": "pass",
    "attributes": {
      "downloadUrl": "<string>",
      "passType": "generic",
      "deviceType": "android",
      "createdAt": "<string>",
      "status": "issued",
      "extId": "<string>",
      "groupTag": "<string>",
      "addedAt": "<string>",
      "removedAt": "<string>",
      "deactivatedAt": "<string>",
      "expiresAt": "<string>",
      "passTemplateUuid": "<string>",
      "passTemplateName": "<string>",
      "nfc": "<string>",
      "barcode": {
        "type": "qrCode",
        "value": "<string>",
        "displayText": true
      },
      "latestMessage": "<string>",
      "passContent": {},
      "passDesign": {
        "backgroundColor": "#EFEFEF",
        "labelColor": "#EFEFEF",
        "textColor": "#EFEFEF",
        "bannerImageUrl": "<string>",
        "logoImageUrl": "<string>"
      },
      "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"
        }
      ],
      "passSource": {
        "oneOf": {
          "appleBase64": "<string>",
          "googleDownloadUrl": "<string>"
        }
      }
    }
  },
  "meta": {
    "notifications": {
      "status": "delivered",
      "message": "Delivered succesfully"
    }
  }
}

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

Pass UUID or External ID

Body

application/json
notification
object

Response

200
application/json
Succesful
data
object
meta
object

Was this page helpful?