Sign in

v2

latestOpenAPI 3.1.02026-08-074390396.7 KB
Pass Templates

Create Pass Template

Create a new pass template

post/api/v1/pass-templates

Request body

Example request

{
  "passTemplate": {
    "name": "PassEntry Supermarket",
    "centralTitle": "PassEntry Supermarket",
    "notificationHeader": "PassEntry Supermarket",
    "description": "PassEntry Supermarket",
    "defaultLanguage": "en",
    "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",
      "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"
      },
      "google": {
        "banner": "https://example.com/google_banner.png",
        "logo": "https://example.com/google_logo.png",
        "wideLogo": "https://example.com/google_wide_logo.png"
      }
    },
    "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/"
        }
      }
    },
    "locations": [
      {
        "name": "West Entrance",
        "latitude": 51.54321132456805,
        "longitude": -0.022901231803803924,
        "radius": 90,
        "message": "Welcome! Enjoy the show!"
      }
    ],
    "beacons": [
      {
        "name": "West Entrance",
        "proximityUuid": "E2C56DB5-DFFB-48D2-B060-D0F5A71096E0",
        "major": 1246,
        "minor": 6421,
        "message": "You're near my store"
      }
    ],
    "barcode": {
      "value": "abc123"
    },
    "enhancedEventTicket": {
      "images": {
        "artwork": "https://www.example.com/artwork.png",
        "secondaryLogo": "https://www.example.com/secondary-logo.png",
        "venueMap": "https://www.example.com/venue-map.png"
      }
    }
  }
}

Response

Succesful

idstring

Unique identifier for the pass template

typestring

Example response

{
  "id": "19cb334f9696e64e10e7759f0",
  "type": "passTemplate",
  "attributes": {
    "name": "PassEntry Supermarket",
    "status": "published"
  },
  "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"
    }
  }
}