Pass Templates are created asynchronously and the response will return a 202 status code. Use the URL returned in the response to check the status of the pass template.
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",
"defaultLanguage": "en",
"centralTitle": "PassEntry Supermarket",
"notificationHeader": "PassEntry Supermarket",
"description": "PassEntry Supermarket",
"colors": {
"background": "#dbdbdb",
"label": "#000000",
"text": "#000000"
},
"images": {
"banner": "https://example.com/images/banner.jpg",
"logo": "https://example.com/images/logo.jpg",
"icon": "https://example.com/images/icon.jpg",
"watermark": {
"color": "light",
"position": "bottomRight"
}
},
"fields": {
"header": {
"one": {
"id": "points",
"label": "Points",
"defaultValue": "0",
"localisation": {
"fr": {
"label": "Points",
"defaultValue": "0"
},
"is": {
"label": "Stig",
"defaultValue": "0"
}
}
}
},
"central": {
"one": {
"id": "name",
"label": "Central",
"defaultValue": "Sample Name",
"localisation": {
"fr": {
"label": "Central",
"defaultValue": "Exemple de Nom"
},
"is": {
"label": "Miðja",
"defaultValue": "Sýnishorn Nafn"
}
}
}
},
"details": {
"one": {
"id": "name",
"label": "Name",
"defaultValue": "Jane Doe",
"localisation": {
"fr": {
"label": "Nom",
"defaultValue": "Jeanne Dupont"
},
"is": {
"label": "Nafn",
"defaultValue": "Jóna Jónsdóttir"
}
}
},
"two": {
"id": "discount",
"label": "Discount",
"defaultValue": "15%",
"localisation": {
"fr": {
"label": "Réduction",
"defaultValue": "15%"
},
"is": {
"label": "Afsláttur",
"defaultValue": "15%"
}
}
},
"three": {
"id": "tier",
"label": "Membership Tier",
"defaultValue": "Silver",
"localisation": {
"fr": {
"label": "Niveau de fidélité",
"defaultValue": "Argent"
},
"is": {
"label": "Aðildarstig",
"defaultValue": "Silfur"
}
}
}
},
"back": {
"one": {
"id": "email",
"label": "Email",
"defaultValue": "[email protected]",
"localisation": {
"fr": {
"label": "E-mail",
"defaultValue": "[email protected]"
},
"is": {
"label": "Netfang",
"defaultValue": "[email protected]"
}
}
}
}
},
"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 for more!"
}
}
},
"barcode": {
"enabled": true,
"type": "qr",
"source": "custom",
"value": "123abcd"
},
"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"
}
]
}
}
'{
"id": "19cb334f9696e64e10e7759f0",
"type": "passTemplate",
"attributes": {
"name": "PassEntry Supermarket",
"templateType": "eventTicket",
"transitType": "airplane",
"processingStatus": "processing"
},
"meta": {
"message": "Your pass template is being processed, please check again in a few moments.",
"links": {
"self": "https://api.passentry.com/v1/pass-templates/19cb334f9696e64e10e7759f0"
}
}
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Pass Template object
Show child attributes
Name of the pass template, used for display purposes
"PassEntry Supermarket"
Used for Google Wallet Passes, pass Title
"PassEntry Supermarket"
Header text to be displayed on notifications
"PassEntry Supermarket"
Description of the pass template. This text is used as the notification header for Android geofencing alerts.
"PassEntry Supermarket"
Type of pass template, determines the design and functionality of the pass Type of pass template, determines the design and functionality of the pass
generic, loyalty, eventTicket, transit Language code (ISO 639-1) used as the default language for labels on this template
"en"
Images for the pass template, must be direct links to publicly accessible HTTPS URLs. Review our design guidelines for more information.
Show child attributes
Banner image URL, used unless platform specific images are provided
"https://example.com/banner.png"
Logo image URL, used unless platform specific images are provided
"https://example.com/logo.png"
Icon image URL, used unless platform specific images are provided
"https://example.com/icon.png"
PassEntry logo watermark. To remove watermark, contact Sales at PassEntry. Otherwise, watermak is required
Show child attributes
Color of the watermark, light or dark
light, dark Position of the watermark, top left, top right, bottom left, or bottom right
topLeft, topRight, bottomLeft, bottomRight Show child attributes
Banner image URL, used for Apple Wallet
"https://example.com/apple_banner.png"
Logo image URL, used for Apple Wallet
"https://example.com/apple_logo.png"
Icon image URL, used for Apple Wallet
"https://example.com/apple_icon.png"
Thumbnail image URL, used for Apple Wallet
"https://example.com/apple_thumbnail.png"
PassEntry logo watermark. To remove watermark, contact Sales at PassEntry. Otherwise, watermak is required
Show child attributes
Color of the watermark, light or dark
light, dark Position of the watermark, top left, top right, bottom left, or bottom right
topLeft, topRight, bottomLeft, bottomRight Show child attributes
Banner image URL, used for Google Wallet
"https://example.com/google_banner.png"
Logo image URL, used for Google Wallet
"https://example.com/google_logo.png"
Wide logo image URL, used for Google Wallet
"https://example.com/google_wide_logo.png"
PassEntry logo watermark. To remove watermark, contact Sales at PassEntry. Otherwise, watermak is required
Show child attributes
Color of the watermark, light or dark
light, dark Position of the watermark, top left, top right, bottom left, or bottom right
topLeft, topRight, bottomLeft, bottomRight Fields for the pass template, for exact positioning of fields please review our design guidelines
Show child attributes
Show child attributes
Field object. Set value to null to remove the field.
Show child attributes
Field ID, used to to target and identify a specific field. Must be unique within the pass template or pass. Required if field is used.
"membership_tier"
Label of the field. This will be displayed to the user in the pass.
"Membership Tier"
Default value of the field. This will be displayed to the user in the pass if no value is provided.
"Gold"
Optional. Localised overrides for field labels and values, keyed by BCP-47/ISO language code (e.g., en, fr, is). Omitted entirely if no translations are provided. This feature is available on request and works only via the Pass Templates API (not dashboard), please contact PassEntry to enable localisation for your organisation.
Show child attributes
Show child attributes
Localised label to be displayed for this field when the user language matches the provided language code
Localised default value to be displayed for this field when the user language matches the provided language code
Field object. Set value to null to remove the field.
Show child attributes
Field ID, used to to target and identify a specific field. Must be unique within the pass template or pass. Required if field is used.
"membership_tier"
Label of the field. This will be displayed to the user in the pass.
"Membership Tier"
Default value of the field. This will be displayed to the user in the pass if no value is provided.
"Gold"
Optional. Localised overrides for field labels and values, keyed by BCP-47/ISO language code (e.g., en, fr, is). Omitted entirely if no translations are provided. This feature is available on request and works only via the Pass Templates API (not dashboard), please contact PassEntry to enable localisation for your organisation.
Show child attributes
Show child attributes
Localised label to be displayed for this field when the user language matches the provided language code
Localised default value to be displayed for this field when the user language matches the provided language code
Central field for the pass template.
Note: Please use both one and two fields for transit type
Show child attributes
Field object. Set value to null to remove the field.
Show child attributes
Field ID, used to to target and identify a specific field. Must be unique within the pass template or pass. Required if field is used.
"membership_tier"
Label of the field. This will be displayed to the user in the pass.
"Membership Tier"
Default value of the field. This will be displayed to the user in the pass if no value is provided.
"Gold"
Optional. Localised overrides for field labels and values, keyed by BCP-47/ISO language code (e.g., en, fr, is). Omitted entirely if no translations are provided. This feature is available on request and works only via the Pass Templates API (not dashboard), please contact PassEntry to enable localisation for your organisation.
Show child attributes
Show child attributes
Localised label to be displayed for this field when the user language matches the provided language code
Localised default value to be displayed for this field when the user language matches the provided language code
Field object. Set value to null to remove the field.
Show child attributes
Field ID, used to to target and identify a specific field. Must be unique within the pass template or pass. Required if field is used.
"membership_tier"
Label of the field. This will be displayed to the user in the pass.
"Membership Tier"
Default value of the field. This will be displayed to the user in the pass if no value is provided.
"Gold"
Optional. Localised overrides for field labels and values, keyed by BCP-47/ISO language code (e.g., en, fr, is). Omitted entirely if no translations are provided. This feature is available on request and works only via the Pass Templates API (not dashboard), please contact PassEntry to enable localisation for your organisation.
Show child attributes
Show child attributes
Localised label to be displayed for this field when the user language matches the provided language code
Localised default value to be displayed for this field when the user language matches the provided language code
Show child attributes
Field object. Set value to null to remove the field.
Show child attributes
Field ID, used to to target and identify a specific field. Must be unique within the pass template or pass. Required if field is used.
"membership_tier"
Label of the field. This will be displayed to the user in the pass.
"Membership Tier"
Default value of the field. This will be displayed to the user in the pass if no value is provided.
"Gold"
Optional. Localised overrides for field labels and values, keyed by BCP-47/ISO language code (e.g., en, fr, is). Omitted entirely if no translations are provided. This feature is available on request and works only via the Pass Templates API (not dashboard), please contact PassEntry to enable localisation for your organisation.
Show child attributes
Show child attributes
Localised label to be displayed for this field when the user language matches the provided language code
Localised default value to be displayed for this field when the user language matches the provided language code
Field object. Set value to null to remove the field.
Show child attributes
Field ID, used to to target and identify a specific field. Must be unique within the pass template or pass. Required if field is used.
"membership_tier"
Label of the field. This will be displayed to the user in the pass.
"Membership Tier"
Default value of the field. This will be displayed to the user in the pass if no value is provided.
"Gold"
Optional. Localised overrides for field labels and values, keyed by BCP-47/ISO language code (e.g., en, fr, is). Omitted entirely if no translations are provided. This feature is available on request and works only via the Pass Templates API (not dashboard), please contact PassEntry to enable localisation for your organisation.
Show child attributes
Show child attributes
Localised label to be displayed for this field when the user language matches the provided language code
Localised default value to be displayed for this field when the user language matches the provided language code
Field object. Set value to null to remove the field.
Show child attributes
Field ID, used to to target and identify a specific field. Must be unique within the pass template or pass. Required if field is used.
"membership_tier"
Label of the field. This will be displayed to the user in the pass.
"Membership Tier"
Default value of the field. This will be displayed to the user in the pass if no value is provided.
"Gold"
Optional. Localised overrides for field labels and values, keyed by BCP-47/ISO language code (e.g., en, fr, is). Omitted entirely if no translations are provided. This feature is available on request and works only via the Pass Templates API (not dashboard), please contact PassEntry to enable localisation for your organisation.
Show child attributes
Show child attributes
Localised label to be displayed for this field when the user language matches the provided language code
Localised default value to be displayed for this field when the user language matches the provided language code
Field object. Set value to null to remove the field.
Show child attributes
Field ID, used to to target and identify a specific field. Must be unique within the pass template or pass. Required if field is used.
"membership_tier"
Label of the field. This will be displayed to the user in the pass.
"Membership Tier"
Default value of the field. This will be displayed to the user in the pass if no value is provided.
"Gold"
Optional. Localised overrides for field labels and values, keyed by BCP-47/ISO language code (e.g., en, fr, is). Omitted entirely if no translations are provided. This feature is available on request and works only via the Pass Templates API (not dashboard), please contact PassEntry to enable localisation for your organisation.
Show child attributes
Show child attributes
Localised label to be displayed for this field when the user language matches the provided language code
Localised default value to be displayed for this field when the user language matches the provided language code
Field object. Set value to null to remove the field.
Show child attributes
Field ID, used to to target and identify a specific field. Must be unique within the pass template or pass. Required if field is used.
"membership_tier"
Label of the field. This will be displayed to the user in the pass.
"Membership Tier"
Default value of the field. This will be displayed to the user in the pass if no value is provided.
"Gold"
Optional. Localised overrides for field labels and values, keyed by BCP-47/ISO language code (e.g., en, fr, is). Omitted entirely if no translations are provided. This feature is available on request and works only via the Pass Templates API (not dashboard), please contact PassEntry to enable localisation for your organisation.
Show child attributes
Show child attributes
Localised label to be displayed for this field when the user language matches the provided language code
Localised default value to be displayed for this field when the user language matches the provided language code
Field object. Set value to null to remove the field.
Show child attributes
Field ID, used to to target and identify a specific field. Must be unique within the pass template or pass. Required if field is used.
"membership_tier"
Label of the field. This will be displayed to the user in the pass.
"Membership Tier"
Default value of the field. This will be displayed to the user in the pass if no value is provided.
"Gold"
Optional. Localised overrides for field labels and values, keyed by BCP-47/ISO language code (e.g., en, fr, is). Omitted entirely if no translations are provided. This feature is available on request and works only via the Pass Templates API (not dashboard), please contact PassEntry to enable localisation for your organisation.
Show child attributes
Show child attributes
Localised label to be displayed for this field when the user language matches the provided language code
Localised default value to be displayed for this field when the user language matches the provided language code
Show child attributes
Field object. Set value to null to remove the field.
Show child attributes
Field ID, used to to target and identify a specific field. Must be unique within the pass template or pass. Required if field is used.
"membership_tier"
Label of the field. This will be displayed to the user in the pass.
"Membership Tier"
Default value of the field. This will be displayed to the user in the pass if no value is provided.
"Gold"
Optional. Localised overrides for field labels and values, keyed by BCP-47/ISO language code (e.g., en, fr, is). Omitted entirely if no translations are provided. This feature is available on request and works only via the Pass Templates API (not dashboard), please contact PassEntry to enable localisation for your organisation.
Show child attributes
Show child attributes
Localised label to be displayed for this field when the user language matches the provided language code
Localised default value to be displayed for this field when the user language matches the provided language code
Field object. Set value to null to remove the field.
Show child attributes
Field ID, used to to target and identify a specific field. Must be unique within the pass template or pass. Required if field is used.
"membership_tier"
Label of the field. This will be displayed to the user in the pass.
"Membership Tier"
Default value of the field. This will be displayed to the user in the pass if no value is provided.
"Gold"
Optional. Localised overrides for field labels and values, keyed by BCP-47/ISO language code (e.g., en, fr, is). Omitted entirely if no translations are provided. This feature is available on request and works only via the Pass Templates API (not dashboard), please contact PassEntry to enable localisation for your organisation.
Show child attributes
Show child attributes
Localised label to be displayed for this field when the user language matches the provided language code
Localised default value to be displayed for this field when the user language matches the provided language code
Field object. Set value to null to remove the field.
Show child attributes
Field ID, used to to target and identify a specific field. Must be unique within the pass template or pass. Required if field is used.
"membership_tier"
Label of the field. This will be displayed to the user in the pass.
"Membership Tier"
Default value of the field. This will be displayed to the user in the pass if no value is provided.
"Gold"
Optional. Localised overrides for field labels and values, keyed by BCP-47/ISO language code (e.g., en, fr, is). Omitted entirely if no translations are provided. This feature is available on request and works only via the Pass Templates API (not dashboard), please contact PassEntry to enable localisation for your organisation.
Show child attributes
Show child attributes
Localised label to be displayed for this field when the user language matches the provided language code
Localised default value to be displayed for this field when the user language matches the provided language code
Field object. Set value to null to remove the field.
Show child attributes
Field ID, used to to target and identify a specific field. Must be unique within the pass template or pass. Required if field is used.
"membership_tier"
Label of the field. This will be displayed to the user in the pass.
"Membership Tier"
Default value of the field. This will be displayed to the user in the pass if no value is provided.
"Gold"
Optional. Localised overrides for field labels and values, keyed by BCP-47/ISO language code (e.g., en, fr, is). Omitted entirely if no translations are provided. This feature is available on request and works only via the Pass Templates API (not dashboard), please contact PassEntry to enable localisation for your organisation.
Show child attributes
Show child attributes
Localised label to be displayed for this field when the user language matches the provided language code
Localised default value to be displayed for this field when the user language matches the provided language code
Field object. Set value to null to remove the field.
Show child attributes
Field ID, used to to target and identify a specific field. Must be unique within the pass template or pass. Required if field is used.
"membership_tier"
Label of the field. This will be displayed to the user in the pass.
"Membership Tier"
Default value of the field. This will be displayed to the user in the pass if no value is provided.
"Gold"
Optional. Localised overrides for field labels and values, keyed by BCP-47/ISO language code (e.g., en, fr, is). Omitted entirely if no translations are provided. This feature is available on request and works only via the Pass Templates API (not dashboard), please contact PassEntry to enable localisation for your organisation.
Show child attributes
Show child attributes
Localised label to be displayed for this field when the user language matches the provided language code
Localised default value to be displayed for this field when the user language matches the provided language code
Field object. Set value to null to remove the field.
Show child attributes
Field ID, used to to target and identify a specific field. Must be unique within the pass template or pass. Required if field is used.
"membership_tier"
Label of the field. This will be displayed to the user in the pass.
"Membership Tier"
Default value of the field. This will be displayed to the user in the pass if no value is provided.
"Gold"
Optional. Localised overrides for field labels and values, keyed by BCP-47/ISO language code (e.g., en, fr, is). Omitted entirely if no translations are provided. This feature is available on request and works only via the Pass Templates API (not dashboard), please contact PassEntry to enable localisation for your organisation.
Show child attributes
Show child attributes
Localised label to be displayed for this field when the user language matches the provided language code
Localised default value to be displayed for this field when the user language matches the provided language code
Used to add a link on your pass to an app or website.
Show child attributes
Link to your android App or website
Show child attributes
Array of locations. Maximum of 10 locations
Show child attributes
Name of the location, used for display purposes only
"West Entrance"
Latitude of the location
51.54321132456805
Longitude of the location
-0.022901231803803924
Effective geofence radius of the location in meters. Maximum is 1000 for eventTicket passes, 100 for other pass types. Currently only available on Apple devices, due to Android device restrictions.
10 <= x <= 100090
Message to display when user enters geofence. Currently only available on Apple devices, due to Android device restrictions.
"Welcome! Enjoy the show!"
Array of beacons, currently only available on Apple devices, due to Android device restrictions. Maximum of 10 beacons
Show child attributes
Name of the beacon, used for display purposes only
"West Entrance"
Unique identifier of the beacon
"E2C56DB5-DFFB-48D2-B060-D0F5A71096E0"
Major Value, provides additional identification for a beacon
0 <= x <= 655351246
Minor Value, provides additional identification for a beacon
0 <= x <= 655356421
Message to display on lock screen when the user is in range of the beacon
"You're near my store"
Barcode for a pass template
Show child attributes
If true, barcode will be added to the pass
Barcode type
qr, code128, aztec, pdf417 Source of the barcode
custom, uuid, extId Barcode value. You can leave it blank if the value will be dynamically set in the pass, but you can also provide a default.
You can make the value dynamic using the %{passData.xyz} syntax (e.g., Hello, %{passData.extId}). Currently, only %{passData.extId} and %{passData.uuid} are supported.
If source is set to extId or uuid, the value will be automatically populated and can be left blank.
"abc123"
If true, display the barcode value as text on the pass
Loyalty balance for the pass template.
Show child attributes
If enabled, pass will have a loyalty balance field that can be updated via the loyalty API.
Type of number to be displayed on the pass, number will be converted to this type.
integer, decimal For loyalty templates, if true, pass will be enabled for Google Wallet NFC.
Transit type for the transit pass template.
Note: This field is required for transit type passes.
airplane, bus, train, ferry, other Succesful
Unique identifier for the pass template
"19cb334f9696e64e10e7759f0"
"passTemplate"
Show child attributes
Name of the pass template, used for display purposes
"PassEntry Supermarket"
Type of pass template, determines the design and functionality of the pass
eventTicket, loyalty, generic, transit Transit type for the transit pass template
airplane, bus, train, ferry, other Processing status of the pass template
processing, processed, failed, updating Show child attributes
Processing status message
"Your pass template is being processed, please check again in a few moments."
Was this page helpful?
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",
"defaultLanguage": "en",
"centralTitle": "PassEntry Supermarket",
"notificationHeader": "PassEntry Supermarket",
"description": "PassEntry Supermarket",
"colors": {
"background": "#dbdbdb",
"label": "#000000",
"text": "#000000"
},
"images": {
"banner": "https://example.com/images/banner.jpg",
"logo": "https://example.com/images/logo.jpg",
"icon": "https://example.com/images/icon.jpg",
"watermark": {
"color": "light",
"position": "bottomRight"
}
},
"fields": {
"header": {
"one": {
"id": "points",
"label": "Points",
"defaultValue": "0",
"localisation": {
"fr": {
"label": "Points",
"defaultValue": "0"
},
"is": {
"label": "Stig",
"defaultValue": "0"
}
}
}
},
"central": {
"one": {
"id": "name",
"label": "Central",
"defaultValue": "Sample Name",
"localisation": {
"fr": {
"label": "Central",
"defaultValue": "Exemple de Nom"
},
"is": {
"label": "Miðja",
"defaultValue": "Sýnishorn Nafn"
}
}
}
},
"details": {
"one": {
"id": "name",
"label": "Name",
"defaultValue": "Jane Doe",
"localisation": {
"fr": {
"label": "Nom",
"defaultValue": "Jeanne Dupont"
},
"is": {
"label": "Nafn",
"defaultValue": "Jóna Jónsdóttir"
}
}
},
"two": {
"id": "discount",
"label": "Discount",
"defaultValue": "15%",
"localisation": {
"fr": {
"label": "Réduction",
"defaultValue": "15%"
},
"is": {
"label": "Afsláttur",
"defaultValue": "15%"
}
}
},
"three": {
"id": "tier",
"label": "Membership Tier",
"defaultValue": "Silver",
"localisation": {
"fr": {
"label": "Niveau de fidélité",
"defaultValue": "Argent"
},
"is": {
"label": "Aðildarstig",
"defaultValue": "Silfur"
}
}
}
},
"back": {
"one": {
"id": "email",
"label": "Email",
"defaultValue": "[email protected]",
"localisation": {
"fr": {
"label": "E-mail",
"defaultValue": "[email protected]"
},
"is": {
"label": "Netfang",
"defaultValue": "[email protected]"
}
}
}
}
},
"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 for more!"
}
}
},
"barcode": {
"enabled": true,
"type": "qr",
"source": "custom",
"value": "123abcd"
},
"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"
}
]
}
}
'{
"id": "19cb334f9696e64e10e7759f0",
"type": "passTemplate",
"attributes": {
"name": "PassEntry Supermarket",
"templateType": "eventTicket",
"transitType": "airplane",
"processingStatus": "processing"
},
"meta": {
"message": "Your pass template is being processed, please check again in a few moments.",
"links": {
"self": "https://api.passentry.com/v1/pass-templates/19cb334f9696e64e10e7759f0"
}
}
}