PATCH
/
api
/
v1
/
pass-templates
/
{id}
curl --request PATCH \
  --url https://api.passentry.com/api/v1/pass-templates/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "passTemplate": {
    "name": "PassEntry Coffee Shop",
    "colors": {
      "background": "#EEEEEE"
    },
    "images": {
      "watermark": {
        "color": "dark",
        "position": "topLeft"
      }
    },
    "appLinking": {
      "apple": {
        "appStoreUrl": []
      }
    },
    "beacons": []
  }
}'
{
  "id": "19cb334f9696e64e10e7759f0",
  "type": "passTemplate",
  "attributes": {
    "name": "PassEntry Supermarket",
    "templateType": "generic",
    "centralTitle": "PassEntry Supermarket",
    "notificationHeader": "PassEntry Supermarket",
    "colors": {
      "background": "#EFEFEF",
      "label": "#FF8477",
      "text": "#29323A"
    },
    "images": {
      "banner": "https://example.com/banner.png",
      "logo": "https://example.com/logo.png",
      "icon": "https://example.com/icon.png",
      "watermark": {
        "color": "light",
        "position": "topLeft"
      },
      "apple": {
        "banner": "https://example.com/apple_banner.png",
        "logo": "https://example.com/apple_logo.png",
        "icon": "https://example.com/apple_icon.png",
        "thumbnail": "https://example.com/apple_thumbnail.png",
        "watermark": {
          "color": "light",
          "position": "topLeft"
        }
      },
      "google": {
        "banner": "https://example.com/google_banner.png",
        "logo": "https://example.com/google_logo.png",
        "wideLogo": "https://example.com/google_wide_logo.png",
        "watermark": {
          "color": "light",
          "position": "topLeft"
        }
      }
    },
    "fields": {
      "header": {
        "one": {
          "id": "membership_tier",
          "label": "Membership Tier",
          "defaultValue": "Gold"
        },
        "two": {
          "id": "membership_tier",
          "label": "Membership Tier",
          "defaultValue": "Gold"
        }
      },
      "central": {
        "one": {
          "id": "membership_tier",
          "label": "Membership Tier",
          "defaultValue": "Gold"
        },
        "two": {
          "id": "membership_tier",
          "label": "Membership Tier",
          "defaultValue": "Gold"
        }
      },
      "details": {
        "one": {
          "id": "membership_tier",
          "label": "Membership Tier",
          "defaultValue": "Gold"
        },
        "two": {
          "id": "membership_tier",
          "label": "Membership Tier",
          "defaultValue": "Gold"
        },
        "three": {
          "id": "membership_tier",
          "label": "Membership Tier",
          "defaultValue": "Gold"
        },
        "four": {
          "id": "membership_tier",
          "label": "Membership Tier",
          "defaultValue": "Gold"
        },
        "five": {
          "id": "membership_tier",
          "label": "Membership Tier",
          "defaultValue": "Gold"
        },
        "six": {
          "id": "membership_tier",
          "label": "Membership Tier",
          "defaultValue": "Gold"
        }
      },
      "back": {
        "one": {
          "id": "membership_tier",
          "label": "Membership Tier",
          "defaultValue": "Gold"
        },
        "two": {
          "id": "membership_tier",
          "label": "Membership Tier",
          "defaultValue": "Gold"
        },
        "three": {
          "id": "membership_tier",
          "label": "Membership Tier",
          "defaultValue": "Gold"
        },
        "four": {
          "id": "membership_tier",
          "label": "Membership Tier",
          "defaultValue": "Gold"
        },
        "five": {
          "id": "membership_tier",
          "label": "Membership Tier",
          "defaultValue": "Gold"
        },
        "six": {
          "id": "membership_tier",
          "label": "Membership Tier",
          "defaultValue": "Gold"
        }
      }
    },
    "appLinking": {
      "apple": {
        "appStoreUrl": [
          "https://apps.apple.com/gb/app/whatsapp-messenger/id310633997"
        ]
      },
      "google": {
        "web": {
          "url": "https://passentry.com/"
        },
        "displayText": {
          "text": "<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": [
      {
        "name": "West Entrance",
        "proximityUuid": "E2C56DB5-DFFB-48D2-B060-D0F5A71096E0",
        "major": 1246,
        "minor": 6421,
        "message": "You're near my store"
      }
    ],
    "barcode": {
      "enabled": true,
      "type": "qr",
      "source": "custom",
      "value": "abc123",
      "displayText": true
    }
  }
}

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.

Path Parameters

id
string
required

Pass Template UUID

Body

application/json

Pass Template object

Response

200
application/json

Successful

The response is of type object.