> ## Documentation Index
> Fetch the complete documentation index at: https://docs.passentry.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Batch Pass Creation

> Learn how to create large numbers of passes in bulk using CSV uploads in the PassEntry Dashboard, including template mapping, dynamic fields and how to review results and fix errors.

**Batch Pass Creation** allows you to create large numbers of passes in a single operation using a CSV file. Use this approach when you need to issue passes at scale, such as during migrations, bulk onboarding or campaign launches.

<Info>
  This guide covers creating passes via CSV upload in the PassEntry Dashboard. If you want to **create passes programmatically** or integrate bulk issuance into
  automated workflows, see the [Batch Pass Creation API documentation](/api-reference/v1/batches/create-passes-batch).
</Info>

<h2>Creating a Batch via CSV</h2>
Head over to the Bulk Operations section, you will find "Create 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.

<img style={{border: "1px solid #e0e0e0", borderRadius: "10px"}} src="https://mintcdn.com/passentry-0/HmGZWgR5hl_EFpPJ/documentation/bulk-operations/batch-pass-creation/creation-form.png?fit=max&auto=format&n=HmGZWgR5hl_EFpPJ&q=85&s=1f9a5563ae5415058566571abefa0264" width="1407" height="603" data-path="documentation/bulk-operations/batch-pass-creation/creation-form.png" />

**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](/assets/passentry-pass-batch-creation-sample.csv)

## Configuration

<Warning>
  Ensure the CSV is formatted in UTF-8 encoding.
</Warning>

### Fixed headers

For more information on the functionality of each field, please refer to the [API Reference](../../../api-reference/v1/passes/create-pass).

<table>
  <thead>
    <tr>
      <th>Column Name</th>
      <th>Description</th>
      <th>Required?</th>
      <th>Example</th>
      <th>Type</th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>ext\_id</td>
      <td>External ID for the pass</td>
      <td>Yes</td>
      <td>Pass12345</td>
      <td>Text (Any)</td>
    </tr>

    <tr>
      <td>group\_tags</td>
      <td>Comma separated tags to group passes</td>
      <td>No</td>
      <td>summer\_offer\_24</td>
      <td>Text (Any)</td>
    </tr>

    <tr>
      <td>nfc\_enabled</td>
      <td>Boolean to enable NFC</td>
      <td>No</td>
      <td>true</td>
      <td>Boolean (true or false)</td>
    </tr>

    <tr>
      <td>nfc\_source</td>
      <td>Source of NFC data</td>
      <td>No</td>
      <td>extId</td>
      <td>Text (extId or uuid or custom)</td>
    </tr>

    <tr>
      <td>nfc\_custom\_value</td>
      <td>Custom value for NFC, nfc\_source must be set to custom</td>
      <td>No</td>
      <td>summer\_20\_off</td>
      <td>Text (any)</td>
    </tr>

    <tr>
      <td>barcode\_enabled</td>
      <td>Boolean to enable barcode</td>
      <td>No</td>
      <td>true</td>
      <td>Boolean (true or false)</td>
    </tr>

    <tr>
      <td>barcode\_type</td>
      <td>Type of barcode</td>
      <td>No</td>
      <td>qr</td>
      <td>Text (qr, code128, aztec or pdf417)</td>
    </tr>

    <tr>
      <td>barcode\_source</td>
      <td>Source of barcode</td>
      <td>No</td>
      <td>extId</td>
      <td>Text (extId, uuid or custom)</td>
    </tr>

    <tr>
      <td>barcode\_value</td>
      <td>Value for the barcode, barcode\_source must be set to custom</td>
      <td>No</td>
      <td>abcd12345</td>
      <td>Text (Any)</td>
    </tr>

    <tr>
      <td>barcode\_display\_text</td>
      <td>Boolean to display barcode value as text</td>
      <td>No</td>
      <td>true</td>
      <td>Boolean (true or false)</td>
    </tr>

    <tr>
      <td>expires\_at</td>
      <td>Expiration date and time for the pass</td>
      <td>No</td>
      <td>2024-08-14T18:12:11Z</td>
      <td>Datetime in iso8601 format</td>
    </tr>

    <tr>
      <td>override\_background\_color</td>

      <td>
        Override the background colour of the pass.

        <br />

        [Restrictions apply depending on device and template type](../../../api-reference/v1/passes/create-pass#body-pass-template-override)
      </td>

      <td>No</td>
      <td>#000000</td>
      <td>Text (hex colour code)</td>
    </tr>

    <tr>
      <td>override\_label\_color</td>

      <td>
        Override the label colour of the pass.

        <br />

        [Restrictions apply depending on device and template type](../../../api-reference/v1/passes/create-pass#body-pass-template-override)
      </td>

      <td>No</td>
      <td>#FFFFFF</td>
      <td>Text (hex colour code)</td>
    </tr>

    <tr>
      <td>override\_text\_color</td>

      <td>
        Override the text colour of the pass.

        <br />

        [Restrictions apply depending on device and template type](../../../api-reference/v1/passes/create-pass#body-pass-template-override)
      </td>

      <td>No</td>
      <td>#FFFFFF</td>
      <td>Text (hex colour code)</td>
    </tr>

    <tr>
      <td>override\_banner\_image\_asset\_id</td>
      <td>UUID of a processed [Image Asset](/api-reference/v1/image-assets/guide) to use as the banner image</td>
      <td>No</td>
      <td>f47ac10b-58cc-4372-a567-0e02b2c3d479</td>
      <td>Text (UUID)</td>
    </tr>

    <tr>
      <td>override\_logo\_image\_asset\_id</td>
      <td>UUID of a processed [Image Asset](/api-reference/v1/image-assets/guide) to use as the logo image</td>
      <td>No</td>
      <td>f47ac10b-58cc-4372-a567-0e02b2c3d479</td>
      <td>Text (UUID)</td>
    </tr>

    <tr>
      <td>override\_thumbnail\_image\_asset\_id</td>
      <td>UUID of a processed [Image Asset](/api-reference/v1/image-assets/guide) to use as the thumbnail image (generic passes only)</td>
      <td>No</td>
      <td>f47ac10b-58cc-4372-a567-0e02b2c3d479</td>
      <td>Text (UUID)</td>
    </tr>
  </tbody>
</table>

<Info>
  Template override columns require template overrides to be enabled for your organisation. Image assets must be uploaded and fully processed before they can be referenced by UUID. See the [Image Assets guide](/api-reference/v1/image-assets/guide) for details.
</Info>

### 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 an `ID` 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`

<img style={{border: "1px solid #e0e0e0", borderRadius: "10px"}} src="https://mintcdn.com/passentry-0/HmGZWgR5hl_EFpPJ/documentation/bulk-operations/batch-pass-creation/dynamic-field-id-example.png?fit=max&auto=format&n=HmGZWgR5hl_EFpPJ&q=85&s=ee44747c386774a2f1e38c6d596e7c5e" width="560" height="347" data-path="documentation/bulk-operations/batch-pass-creation/dynamic-field-id-example.png" />

### 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.

For example:

| 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>"` |

This will ensure that the special characters are handled correctly, and the markdown is rendered as expected.

## Results

Once you've uploaded your CSV, you'll be able to track the progress of your batch on the Passes page.

<img style={{border: "1px solid #e0e0e0", borderRadius: "10px"}} src="https://mintcdn.com/passentry-0/HmGZWgR5hl_EFpPJ/documentation/bulk-operations/batch-pass-creation/pass-creation-index.png?fit=max&auto=format&n=HmGZWgR5hl_EFpPJ&q=85&s=499f538b8653a93b4d3a1d29fed612fe" width="1220" height="673" data-path="documentation/bulk-operations/batch-pass-creation/pass-creation-index.png" />

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](https://download.passentry.com/download?pass=1234567890) |
| Pass12346 | 1234567891 | [https://download.passentry.com/download?pass=1234567891](https://download.passentry.com/download?pass=1234567891) |

## FAQ

### When should I use batch pass creation instead of the API?

Use CSV batch creation for one-off or infrequent bulk operations, such as migrations or campaign launches. For recurring or automated workflows, use the standard pass creation API to issue passes programmatically.

### What happens if some rows in my CSV fail?

If any rows fail, you can download an error CSV showing which rows failed and why. You can fix the errors and re-upload the CSV to retry only the failed passes.

### Is there a limit to how many passes I can create in one batch?

The maximum batch size depends on your plan and system limits. Large CSV files are supported, but extremely large batches may take longer to process.
