Guides
Batch Pass Creation
A common use case presented by our clients is the need to create passes in batches.
Typically, doing this at scale would require some integration effort.
We now offer the ability to create passes in Batches via CSV upload.
All you need to do is do a data export from your CRM system, format it in the appropriate CSV format, and upload it to PassEntry.
Then, create a new batch.
Optionally enter a batch name, and select the pass template you want the passes to be created under.
Sample CSV
Once you’ve selected your Pass Template, you will be able to download a sample CSV, specific to your chosen Pass Template.
You can download an example CSV here: HERE
This will ensure that the special characters are handled correctly, and the markdown is rendered as expected.
The batch will be listed in the “Batches” section, and you can click on it to see the progress of the batch.
If there are any errors, you’ll be able to download a CSV of the errors that occurred, and once you’ve fixed them, you can re-upload the CSV to try again.
Once the batch is complete, you’ll be able to download a CSV of the passes created in the following format:
Step by Step
Head over to the passes section, you will a find a “Create Passes | via CSV” button
Then, create a new batch.
Optionally enter a batch name, and select the pass template you want the passes to be created under.
Sample CSV
Once you’ve selected your Pass Template, you will be able to download a sample CSV, specific to your chosen Pass Template.
You can download an example CSV here: HERE
Configuration
Ensure the CSV is formatted in UTF-8 encoding.
Fixed headers
| Column Name | Description | Required? | Example | Type |
|---|---|---|---|---|
| ext_id | External ID for the pass | Yes | Pass12345 | Text (Any) |
| group_tag (deprecated) | Tag to group passes | No | summer_offer_24, Loyalty Program | Text (Any) |
| group_tags | Comma separated tags to group passes | No | summer_offer_24 | Text (Any) |
| nfc_enabled | Boolean to enable NFC | No | true | Boolean (true or false) |
| nfc_source | Source of NFC data | No | extId | Text (extId or uuid or custom) |
| nfc_custom_value | Custom value for NFC, nfc_source must be set to custom | No | summer_20_off | Text (any) |
| barcode_qr_value | Value for the barcode or QR code | No | abcd12345 | Text (Any) |
| barcode_qr_display_text | Boolean to display qr value as text under barcode | No | true | Boolean (true or false) |
| expires_at | Expiration date and time for the pass | No | 2024-08-14T18:12:11Z | Datetime in iso8601 format |
Dynamic headers
As each template might have custom fields, this can be identified and set via custom, dynamic headers. When creating a template, you set anID for each field.
This can then be targeted in your CSV by including the prefix passfield_ followed by your template ID.
Example:
In your pass template, you’ve chosen to display Field 1 as “Customer Name”, and given it the ID of “name”.
Then, for each row in your CSV, you’ve entered a different name, to correspond with the data downloaded from your system.
In which case, your CSV would need to have a row called passfield_name
Special Characters and Markdown
When working with CSV files that include special characters such as commas, quotes, or line breaks—and especially when embedding HTML or markdown-style content—it’s important to format fields correctly to ensure they are parsed reliably. Follow these rules:- Commas (
,): Wrap the entire field in double quotes ("). - Line breaks (
\n): Wrap the entire field in double quotes ("). - Double quotes (
") inside fields: Use double quotes around the field, and escape inner quotes by doubling them (""). - Markdown or HTML: Use double quotes around the full field, and use single quotes inside HTML attributes to avoid quote conflicts, or escape double quotes if needed.
| Desired Field Content | CSV-Compliant Value |
|---|---|
| London, UK | ”London, UK” |
| London\nUK (line break) | “London\nUK” |
<a href="https://example.com">Link</a> | "<a href='https://example.com'>Link</a>" |
| ”Quoted Text" | """Quoted Text""" |
<a href="https://example.com">"Link"</a> | "<a href='https://example.com'>""Link""</a>" |
Results
Once you’ve uploaded your CSV, you’ll be able to track the progress of your batch on the Passes page.
The batch will be listed in the “Batches” section, and you can click on it to see the progress of the batch.
If there are any errors, you’ll be able to download a CSV of the errors that occurred, and once you’ve fixed them, you can re-upload the CSV to try again.
Once the batch is complete, you’ll be able to download a CSV of the passes created in the following format:
| ext_id | uuid | download_url |
|---|---|---|
| Pass12345 | 1234567890 | https://download.passentry.com/download?pass=1234567890 |
| Pass12346 | 1234567891 | https://download.passentry.com/download?pass=1234567891 |