POST
/
api
/
v1
/
passes
curl --request POST \
  --url https://api.passentry.com/api/v1/passes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "pass": {
    "nfc": {
      "enabled": true
    },
    "fullName": "Jane Smith",
    "website": "https://passentry.com",
    "barcode": {
      "enabled": true,
      "type": "qr",
      "source": "custom",
      "value": "123abcd",
      "displayText": true
    }
  },
  "locations": [
    {
      "name": "Venue",
      "latitude": 51.54321132456805,
      "longitude": -0.022901231803803924,
      "radius": 100,
      "message": "Welcome to the venue"
    }
  ]
}'
{
  "data": {
    "id": "33b680b7a5460e6cd4646dfd2c1a8c33a6fbfa5c",
    "type": "pass",
    "attributes": {
      "downloadUrl": "https://www.example.com?pass=33b680b7a5460e6cd4646dfd2c1a8c33a6fbfa5c",
      "passType": "generic",
      "createdAt": "2022-06-05T10:06:53Z",
      "status": "issued",
      "extId": "123",
      "passTemplateUuid": "2e2d7ee8c306e8f0223dbdc1",
      "passTemplateName": "PassEntry Ticketing",
      "nfc": "33b680b7a5460e6cd4646dfd2c1a8c33a6fbfa5c",
      "barcode": {
        "enabled": true,
        "type": "qr",
        "source": "custom",
        "value": "123abcd",
        "displayText": true
      },
      "passContent": {
        "nfc": {
          "enabled": true
        },
        "fullName": "Jane Smith",
        "website": "https://passentry.com",
        "barcode": {
          "enabled": true,
          "type": "qr",
          "source": "custom",
          "value": "123abcd",
          "displayText": true
        }
      }
    }
  }
}

Authorizations

Authorization
string
header
required

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

Query Parameters

passTemplate
string
required

Identifies the pass template to use

extId
string

External ID used to identify the pass. Optional

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

includePassSource
enum<string>

Used when delivering the pass directly to the passholder, without using PassEntry's download page. Choose one of Apple/Google, includes the pass source in the response. The passSource object is only included if the pass is not currently 'active'

Available options:
apple,
google

Body

application/json

Response

200
application/json

Successful

The response is of type object.