---
title: "Create a new pass"
method: POST
path: "/pass"
tags: ["Pass"]
---

# Create a new pass

`POST /pass`

Create a new pass

## Request body

- PassCreate
  - `passbook` string, required
  - `data` PassData, required — The data object containing all the information, colours and fields for a pass. If cloned from a passbook template, the fields (headerFields, primaryFields, secondaryFields, auxiliaryFields, backFields) should be updated with a value property.
    - `auxiliaryFields` PassField[]
      - `key` string
      - `label` string
      - `value` string
      - `string` boolean
      - `number` boolean
      - `date` boolean
      - `dataDetectorTypes` 'PKDataDetectorTypePhoneNumber' | 'PKDataDetectorTypeLink' | 'PKDataDetectorTypeAddress' | 'PKDataDetectorTypeCalendarEvent'
      - `textAlignment` 'PKTextAlignmentLeft' | 'PKTextAlignmentCenter' | 'PKTextAlignmentRight' | 'PKTextAlignmentNatural'
      - `dateStyle` 'PKDateStyleNone' | 'PKDateStyleShort' | 'PKDateStyleMedium' | 'PKDateStyleLong' | 'PKDateStyleFull'
      - `timeStyle` 'PKDateStyleNone' | 'PKDateStyleShort' | 'PKDateStyleMedium' | 'PKDateStyleLong' | 'PKDateStyleFull'
      - `ignoresTimeZone` boolean
      - `isRelative` boolean
      - `currencyCode` string
      - `numberStyle` 'PKNumberStyleDecimal' | 'PKNumberStylePercent' | 'PKNumberStyleScientific' | 'PKNumberStyleSpellOut'
    - `backFields` PassField[]
      - `key` string
      - `label` string
      - `value` string
      - `string` boolean
      - `number` boolean
      - `date` boolean
      - `dataDetectorTypes` 'PKDataDetectorTypePhoneNumber' | 'PKDataDetectorTypeLink' | 'PKDataDetectorTypeAddress' | 'PKDataDetectorTypeCalendarEvent'
      - `textAlignment` 'PKTextAlignmentLeft' | 'PKTextAlignmentCenter' | 'PKTextAlignmentRight' | 'PKTextAlignmentNatural'
      - `dateStyle` 'PKDateStyleNone' | 'PKDateStyleShort' | 'PKDateStyleMedium' | 'PKDateStyleLong' | 'PKDateStyleFull'
      - `timeStyle` 'PKDateStyleNone' | 'PKDateStyleShort' | 'PKDateStyleMedium' | 'PKDateStyleLong' | 'PKDateStyleFull'
      - `ignoresTimeZone` boolean
      - `isRelative` boolean
      - `currencyCode` string
      - `numberStyle` 'PKNumberStyleDecimal' | 'PKNumberStylePercent' | 'PKNumberStyleScientific' | 'PKNumberStyleSpellOut'
    - `headerFields` PassField[]
      - `key` string
      - `label` string
      - `value` string
      - `string` boolean
      - `number` boolean
      - `date` boolean
      - `dataDetectorTypes` 'PKDataDetectorTypePhoneNumber' | 'PKDataDetectorTypeLink' | 'PKDataDetectorTypeAddress' | 'PKDataDetectorTypeCalendarEvent'
      - `textAlignment` 'PKTextAlignmentLeft' | 'PKTextAlignmentCenter' | 'PKTextAlignmentRight' | 'PKTextAlignmentNatural'
      - `dateStyle` 'PKDateStyleNone' | 'PKDateStyleShort' | 'PKDateStyleMedium' | 'PKDateStyleLong' | 'PKDateStyleFull'
      - `timeStyle` 'PKDateStyleNone' | 'PKDateStyleShort' | 'PKDateStyleMedium' | 'PKDateStyleLong' | 'PKDateStyleFull'
      - `ignoresTimeZone` boolean
      - `isRelative` boolean
      - `currencyCode` string
      - `numberStyle` 'PKNumberStyleDecimal' | 'PKNumberStylePercent' | 'PKNumberStyleScientific' | 'PKNumberStyleSpellOut'
    - `primaryFields` PassField[]
      - `key` string
      - `label` string
      - `value` string
      - `string` boolean
      - `number` boolean
      - `date` boolean
      - `dataDetectorTypes` 'PKDataDetectorTypePhoneNumber' | 'PKDataDetectorTypeLink' | 'PKDataDetectorTypeAddress' | 'PKDataDetectorTypeCalendarEvent'
      - `textAlignment` 'PKTextAlignmentLeft' | 'PKTextAlignmentCenter' | 'PKTextAlignmentRight' | 'PKTextAlignmentNatural'
      - `dateStyle` 'PKDateStyleNone' | 'PKDateStyleShort' | 'PKDateStyleMedium' | 'PKDateStyleLong' | 'PKDateStyleFull'
      - `timeStyle` 'PKDateStyleNone' | 'PKDateStyleShort' | 'PKDateStyleMedium' | 'PKDateStyleLong' | 'PKDateStyleFull'
      - `ignoresTimeZone` boolean
      - `isRelative` boolean
      - `currencyCode` string
      - `numberStyle` 'PKNumberStyleDecimal' | 'PKNumberStylePercent' | 'PKNumberStyleScientific' | 'PKNumberStyleSpellOut'
    - `secondaryFields` PassField[]
      - `key` string
      - `label` string
      - `value` string
      - `string` boolean
      - `number` boolean
      - `date` boolean
      - `dataDetectorTypes` 'PKDataDetectorTypePhoneNumber' | 'PKDataDetectorTypeLink' | 'PKDataDetectorTypeAddress' | 'PKDataDetectorTypeCalendarEvent'
      - `textAlignment` 'PKTextAlignmentLeft' | 'PKTextAlignmentCenter' | 'PKTextAlignmentRight' | 'PKTextAlignmentNatural'
      - `dateStyle` 'PKDateStyleNone' | 'PKDateStyleShort' | 'PKDateStyleMedium' | 'PKDateStyleLong' | 'PKDateStyleFull'
      - `timeStyle` 'PKDateStyleNone' | 'PKDateStyleShort' | 'PKDateStyleMedium' | 'PKDateStyleLong' | 'PKDateStyleFull'
      - `ignoresTimeZone` boolean
      - `isRelative` boolean
      - `currencyCode` string
      - `numberStyle` 'PKNumberStyleDecimal' | 'PKNumberStylePercent' | 'PKNumberStyleScientific' | 'PKNumberStyleSpellOut'
    - `background` string, uri
    - `backgroundColor` string
    - `barcode` object
      - `format` string
      - `messageEncoding` string
    - `description` string
    - `footer` string, uri
    - `foregroundColor` string
    - `icon` string, uri
    - `labelColor` string
    - `logo` string, uri
    - `logoText` string
    - `strip` string, uri
    - `suppressStripShine` boolean
    - `thumbnail` string, uri
    - `transitType` 'PKTransitTypeAir' | 'PKTransitTypeBoat' | 'PKTransitTypeTrain' | 'PKTransitTypeBus' | 'PKTransitTypeGeneric'
  - `barcode` string, required

## Response `201`

Created

## Changes

- **2020-03-11** `5ed31e104b6f` — 1 info
  - the endpoint scheme security `ApplicationSecret` was added to the API

[Change history](https://skmtc.dev/notificare/apis/notificare-cloud-api/changes/pass/post.md)

---

[API](https://skmtc.dev/notificare/apis/notificare-cloud-api.md) · [All operations](https://skmtc.dev/notificare/apis/notificare-cloud-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/notificare/notificare-cloud-api/revisions/aad692b34bab/schema)