This guide covers updating passes via CSV upload in the PassEntry Dashboard.
For programmatic bulk updates, see the Batch Pass Update API documentation.
For recurring or real-time per-pass updates, use the standard Update Pass API.
Step by Step
Head over to the Bulk Operations section, you will find an “Update via CSV” button. Then, create a new batch. Optionally enter a batch name, and select the pass template you want the passes to be updated under.
Configuration
Fixed headers
For more information on the functionality of each field, please refer to the API Reference.| Column Name | Description | Required? | Example | Type |
|---|---|---|---|---|
| pass_id | UUID or external ID for the pass | Yes | 1234567890 | Text (uuid or extId) |
| 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_enabled | Boolean to enable barcode | No | true | Boolean (true or false) |
| barcode_type | Type of barcode | No | qr | Text (qr, code128, aztec or pdf417) |
| barcode_source | Source of barcode | No | extId | Text (extId, uuid or custom) |
| barcode_value | Value for the barcode, barcode_source must be set to custom | No | abcd12345 | Text (Any) |
| barcode_display_text | Boolean to display barcode value as text | 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 |
| pass_action | Action to perform on the pass | No | deactivate | Text (deactivate or reactivate) |
| override_background_color | Override the background color of the pass. Restrictions apply depending on device and template type | No | #000000 | Text (hex color code) |
| override_label_color | Override the label color of the pass. Restrictions apply depending on device and template type | No | #FFFFFF | Text (hex color code) |
| override_text_color | Override the text color of the pass. Restrictions apply depending on device and template type | No | #FFFFFF | Text (hex color code) |
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.
You only need to include columns for the fields you wish to update. Any columns omitted from the CSV will remain unchanged on the pass. The only required column is
pass_id.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>" |
Tracking and managing your batches
Once you’ve uploaded your CSV, you’ll be able to track the progress of your batch. The progress bar will update in real-time, and you’ll be able to see the number of passes processed, pending, and total. If the progress bar is not updating, please refresh the page.
- Main Information: Each batch displays key details such as the batch name, template name, status, and scheduled time.
- Cancelling a scheduled batch: You can cancel a scheduled batch at any time prior to the scheduled update time.
- Rescheduling a batch: To reschedule an existing batch, cancel it, and create a new batch with the desired scheduled time.
- Updating a batch ahead of schedule: You can update a batch ahead of schedule by clicking the “Update now” button. This will process the updates immediately.