POST
/
api
/
v1
/
entities
/
{entity_id}
/
readers
curl --request POST \
  --url https://api.passentry.com/api/v1/entities/{entity_id}/readers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "reader": {
    "name": "South Entrance Reader 1",
    "id": "south_entrance_01",
    "type": "VtapReader",
    "password": "<string>",
    "scanEnabled": true,
    "redeemEnabled": false,
    "addPointsEnabled": false,
    "mifareClassicNfcEnabled": false,
    "qrEnabled": false
  }
}'
{
  "data": {
    "id": "east-gate-1",
    "type": "reader",
    "attributes": {
      "name": "East Gate Reader",
      "readerType": "PassentryReader",
      "loggedIn": false,
      "qrEnabled": true,
      "mifareClassicNfcEnabled": false,
      "scanEnabled": true,
      "redeemEnabled": false,
      "addPointsEnabled": false,
      "ndefTagScanningEnabled": false
    }
  }
}

Authorizations

Authorization
string
header
required

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

Path Parameters

entity_id
string
required

entity_id

Body

application/json
reader
object

Response

201
application/json
Created
id
string

Identifier of the reader

Example:

"west_entrance_01"

type
string
Example:

"reader"

attributes
object

Was this page helpful?