POST
/
api
/
v1
/
pass-templates
curl --request POST \
  --url https://api.passentry.com/api/v1/pass-templates \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "passTemplate": {
    "name": "PassEntry Supermarket",
    "templateType": "generic",
    "centralTitle": "PassEntry Supermarket",
    "notificationHeader": "PassEntry Supermarket"
  },
  "colors": {
    "background": "#ffffff",
    "label": "#000000",
    "text": "#000000"
  },
  "images": {
    "banner": "https://example.com/banner.png",
    "icon": "https://example.com/icon.png",
    "logo": "https://example.com/logo.png",
    "watermark": {
      "color": "dark",
      "position": "bottomRight"
    }
  },
  "appLinking": {
    "apple": {
      "appStoreUrl": [
        "https://apps.apple.com/gb/app/whatsapp-messenger/id310633997"
      ]
    },
    "google": {
      "app": {
        "playStoreUrl": "https://play.google.com/store/apps/details?id=com.whatsapp"
      },
      "displayText": {
        "text": "Click here to find out more!"
      }
    }
  },
  "barcode": {
    "enabled": true,
    "type": "qr",
    "source": "custom",
    "value": "123abcd",
    "displayText": false
  },
  "locations": [
    {
      "name": "Venue",
      "latitude": 51.54321132456805,
      "longitude": -0.022901231803803924,
      "radius": 100,
      "message": "Welcome to the venue"
    }
  ],
  "beacons": [
    {
      "name": "Beacon",
      "proximityUuid": "123e4567-e89b-12d3-a456-426614174000",
      "major": 1,
      "minor": 1,
      "message": "Welcome to the venue"
    }
  ]
}'
{
  "data": {
    "type": "passTemplate",
    "id": "19cb334f9696e64e10e7759f0",
    "attributes": {
      "processingStatus": "processing",
      "message": "Your pass template is being processed, please check again in a few moments."
    },
    "links": {
      "self": "https://api.passentry.com/v1/pass-templates/19cb334f9696e64e10e7759f0"
    }
  }
}

This endpoint is under closed beta. Please contact PassEntry to request access.

Authorizations

Authorization
string
header
required

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

Body

application/json

Pass Template object

Response

202
application/json

Succesful

The response is of type object.