{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Passform Docs","colors":{"primary":"#009485","light":"#19bea2","dark":"#00665c"},"logo":{"light":"https://mintcdn.com/passform/pcWZEUYGXmyjRGIQ/logo/logo-black.png?fit=max\u0026auto=format\u0026n=pcWZEUYGXmyjRGIQ\u0026q=85\u0026s=246ff0edaaabc72a37df70791750c3f5","dark":"https://mintcdn.com/passform/pcWZEUYGXmyjRGIQ/logo/logo-white.png?fit=max\u0026auto=format\u0026n=pcWZEUYGXmyjRGIQ\u0026q=85\u0026s=285fe61155165025a4cacd6dae78e96a"},"favicon":{"light":"https://mintcdn.com/passform/He9bSbndhY1Ja79s/logo/favicon-black.png?fit=max\u0026auto=format\u0026n=He9bSbndhY1Ja79s\u0026q=85\u0026s=19ab8cf19214726ea441f3aa74807264","dark":"https://mintcdn.com/passform/He9bSbndhY1Ja79s/logo/favicon-white.png?fit=max\u0026auto=format\u0026n=He9bSbndhY1Ja79s\u0026q=85\u0026s=01df01f6073dbc37e99c2e2e19970579"},"navbar":{"links":[{"href":"mailto:support@passform.io","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.passform.io"}},"footer":{"socials":{"linkedin":"https://linkedin.com/company/passform-io"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Support","icon":"envelope","href":"mailto:support@passform.io"},{"anchor":"LinkedIn","icon":"linkedin","href":"https://linkedin.com/company/passform-io"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"passform","hasAudioNarration":false,"actualSubdomain":"passform","customDomains":["docs.passform.io"],"gitSource":{"type":"github","owner":"my-shout","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ac6c6f99e03268cffa71a9a","collectionId":"7614d89a-9633-48a5-ab1a-3a7d90b4124d","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ac6c6f99e03268cffa71a9a"},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ac6c6f99e03268cffa71a9a","clientVersion":"0.0.4045","searchFilterCounts":[{"language":"default","tag":"API reference","count":24},{"language":"default","tag":"Endpoints","count":23},{"language":"default","tag":"Guides","count":15},{"language":"default","tag":"passes","count":11},{"language":"default","tag":"templates","count":6},{"language":"default","tag":"Integrations","count":3},{"language":"default","tag":"accounts","count":3},{"language":"default","tag":"Getting started","count":2},{"language":"default","tag":"Overview","count":1},{"language":"default","tag":"API Reference","count":1}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/passes/create-pass","slug":"/api-reference/passes/create-pass","pageMetadata":{"title":"Create pass","description":"Create a pass for a given template with a random passId. The pass ID will be a Base58 string that is 8 characters","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/pass/{templateId}","href":"/api-reference/passes/create-pass","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Create a pass for a given template with a random passId. The pass ID will be a Base58 string that is 8 characters\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create pass","description":"Create a pass for a given template with a random passId. The pass ID will be a Base58 string that is 8 characters","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/pass/{templateId}","href":"/api-reference/passes/create-pass","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"createPass","summary":"Create pass","tags":["passes","mcp"],"description":"Create a pass for a given template with a random passId. The pass ID will be a Base58 string that is 8 characters","requestBody":"ed53f2c7-f31c-4796-bb8e-28bac7f73486","parameters":["9151d939-769d-414c-9835-21cc2992cdca","c4ac0d20-0a87-426b-8ef4-0a6f9e7560e5"],"security":["57af7967-4b08-4f2e-99dc-39a4bedd8956"],"responses":{"200":"1ccc0672-9bae-40be-a9b9-da35824882f5","400":"9542f4d0-f885-406a-a473-424282a3d5ef","401":"09472865-d855-4a99-947e-758fc97ede65","403":"bf521338-da3c-4274-b59c-2c3ef2d862f8"},"method":"post","type":"path","servers":["3488112f-d7e8-496d-b720-fee63c0f4059"],"path":"/v1/pass/{templateId}","baseUrlOptions":["https://api.passform.io"],"title":"Create pass","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"9151d939-769d-414c-9835-21cc2992cdca":{"schema":{"type":"string","isRequired":false,"uniqueKey":"","typeLabel":"string"},"in":"query","name":"accountId","required":false},"c4ac0d20-0a87-426b-8ef4-0a6f9e7560e5":{"schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"},"in":"path","name":"templateId","required":true}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["voided"],"example":{"expiry":"2025-04-04T19:41:12.733Z","validFrom":"2025-04-04T19:41:12.733Z","voided":false,"fields":[{"key":"voucher","label":"free drinks","value":"1"}],"backFields":[{"key":"terms","label":"Terms and Condictions","value":"https://myshout.co/terms"}]},"properties":{"voided":{"default":false,"description":"Set this to true once the pass has been used","type":"boolean","isRequired":true,"uniqueKey":"voided","typeLabel":"boolean"},"primaryValue":{"description":"Required for 'generic' pass types.","type":"string","uniqueKey":"primaryValue","typeLabel":"string"},"metadata":{"description":"Metadata is for your internal use. It is not exposed to users through passes.\n The metadata is limited to 5000 characters when serialized to JSON.","type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"metadata.additionalProperties","typeLabel":"any"},"uniqueKey":"metadata","typeLabel":"object"},"locations":{"maxItems":10,"description":"Adds to the template's locations for this pass — does not replace them. Combined list is subject to each wallet platform's location limit.","type":"array","items":{"examples":[{"name":"Spark Arena","address":"42/80 Mahuhu Crescent, Parnell, Auckland 1010, New Zealand","latitude":-36.847136000000006,"longitued":174.7769837}],"type":"object","properties":{"address":{"description":"The address of the location where the event is held.","type":"string","isRequired":true,"uniqueKey":"locations.items.[INDEX].address","typeLabel":"string"},"latitude":{"description":"The latitude of the location.","type":"number","isRequired":true,"uniqueKey":"locations.items.[INDEX].latitude","typeLabel":"number"},"longitude":{"description":"The longitude of the location.","type":"number","isRequired":true,"uniqueKey":"locations.items.[INDEX].longitude","typeLabel":"number"},"name":{"description":"The name of the location where the event is held.","type":"string","uniqueKey":"locations.items.[INDEX].name","typeLabel":"string"},"relevantText":{"description":"Text shown in the Apple Wallet notification when the device enters this location. Falls back to name, then address, if not set. Not used by Google Wallet, which has no per-location text.","type":"string","uniqueKey":"locations.items.[INDEX].relevantText","typeLabel":"string"}},"required":["address","latitude","longitude"],"uniqueKey":"locations.items.[INDEX]","typeLabel":"object"},"uniqueKey":"locations","typeLabel":"object[]"},"fields":{"maxItems":4,"type":"array","items":{"description":"A field that is displayed in a voucher, that is identified by the key. It can be defined in a template and overwritten in a pass","examples":[{"key":"voucher","label":"free drinks","value":"1"}],"type":"object","properties":{"key":{"description":"The identifier of the field. This is not presented to the user.","type":"string","isRequired":true,"uniqueKey":"fields.items.[INDEX].key","typeLabel":"string"},"label":{"description":"The label to go with the value.","type":"string","isRequired":true,"uniqueKey":"fields.items.[INDEX].label","typeLabel":"string"},"value":{"description":"The data to display.","type":"string","isRequired":true,"uniqueKey":"fields.items.[INDEX].value","typeLabel":"string"}},"required":["key","label","value"],"uniqueKey":"fields.items.[INDEX]","typeLabel":"object"},"uniqueKey":"fields","typeLabel":"object[]"},"backFields":{"description":"The values can be text, numbers or urls.","type":"array","items":{"description":"A field that is displayed in a voucher, that is identified by the key. It can be defined in a template and overwritten in a pass","examples":[{"key":"voucher","label":"free drinks","value":"1"}],"type":"object","properties":{"key":{"description":"The identifier of the field. This is not presented to the user.","type":"string","isRequired":true,"uniqueKey":"backFields.items.[INDEX].key","typeLabel":"string"},"label":{"description":"The label to go with the value.","type":"string","isRequired":true,"uniqueKey":"backFields.items.[INDEX].label","typeLabel":"string"},"value":{"description":"The data to display.","type":"string","isRequired":true,"uniqueKey":"backFields.items.[INDEX].value","typeLabel":"string"}},"required":["key","label","value"],"uniqueKey":"backFields.items.[INDEX]","typeLabel":"object"},"uniqueKey":"backFields","typeLabel":"object[]"},"validFrom":{"oneOf":[{"type":"string","description":"The UTC date at which the pass becomes valid. If this is not provided the pass is valid from when it is created.","format":"date-time","uniqueKey":"validFrom.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","uniqueKey":"validFrom.oneOf.1","typeLabel":"null"}],"uniqueKey":"validFrom","typeLabel":"string\u003cdate-time> | null"},"expiry":{"oneOf":[{"type":"string","description":"The UTC date at which the pass expires. If this is not provided the voucher will have no expiry.","format":"date-time","uniqueKey":"expiry.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","uniqueKey":"expiry.oneOf.1","typeLabel":"null"}],"uniqueKey":"expiry","typeLabel":"string\u003cdate-time> | null"},"waitForWalletUpdates":{"default":false,"description":"When true, wallet update notifications are awaited synchronously before the response is returned. Defaults to false (async via Cloud Tasks).","type":"boolean","uniqueKey":"waitForWalletUpdates","typeLabel":"boolean"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"expiry":"2025-04-04T19:41:12.733Z","validFrom":"2025-04-04T19:41:12.733Z","voided":false,"fields":[{"key":"voucher","label":"free drinks","value":"1"}],"backFields":[{"key":"terms","label":"Terms and Condictions","value":"https://myshout.co/terms"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"1ccc0672-9bae-40be-a9b9-da35824882f5":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"pass":{"description":"The current details of a pass instance","type":"object","properties":{"id":{"minLength":1,"description":"Id is a unique identifier of the pass, it could be a voucher code or membership id","type":"string","isRequired":true,"uniqueKey":"pass.id","typeLabel":"string"},"templateId":{"description":"Template id used by this voucher","type":"string","isRequired":true,"uniqueKey":"pass.templateId","typeLabel":"string"},"accountId":{"description":"The account id that created the pass/template","type":"string","isRequired":true,"uniqueKey":"pass.accountId","typeLabel":"string"},"code":{"minLength":1,"description":"The code that is used as data in the QR Code. This can be different to the id if you wish to have a url or more data in the QR code.","type":"string","isRequired":true,"uniqueKey":"pass.code","typeLabel":"string"},"expiry":{"oneOf":[{"type":"string","description":"The UTC date at which the pass expires. If this is not provided the voucher will have no expiry.","format":"date-time","isRequired":true,"uniqueKey":"pass.expiry.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","isRequired":true,"uniqueKey":"pass.expiry.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"pass.expiry","typeLabel":"string\u003cdate-time> | null"},"validFrom":{"oneOf":[{"type":"string","description":"The UTC date at which the pass becomes valid. If this is not provided the pass is valid from when it is created.","format":"date-time","isRequired":true,"uniqueKey":"pass.validFrom.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","isRequired":true,"uniqueKey":"pass.validFrom.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"pass.validFrom","typeLabel":"string\u003cdate-time> | null"},"voided":{"default":false,"description":"Set this to true once the pass has been used","type":"boolean","isRequired":true,"uniqueKey":"pass.voided","typeLabel":"boolean"},"primaryValue":{"description":"Required for 'generic' pass types.","type":"string","uniqueKey":"pass.primaryValue","typeLabel":"string"},"metadata":{"description":"Metadata is for your internal use. It is not exposed to users through passes.\n The metadata is limited to 5000 characters when serialized to JSON.","type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"pass.metadata.additionalProperties","typeLabel":"any"},"uniqueKey":"pass.metadata","typeLabel":"object"},"locations":{"maxItems":10,"description":"Adds to the template's locations for this pass — does not replace them. Combined list is subject to each wallet platform's location limit.","type":"array","items":{"type":"object","properties":{"address":{"description":"The address of the location where the event is held.","type":"string","isRequired":true,"uniqueKey":"pass.locations.items.[INDEX].address","typeLabel":"string"},"latitude":{"description":"The latitude of the location.","type":"number","isRequired":true,"uniqueKey":"pass.locations.items.[INDEX].latitude","typeLabel":"number"},"longitude":{"description":"The longitude of the location.","type":"number","isRequired":true,"uniqueKey":"pass.locations.items.[INDEX].longitude","typeLabel":"number"},"name":{"description":"The name of the location where the event is held.","type":"string","uniqueKey":"pass.locations.items.[INDEX].name","typeLabel":"string"},"relevantText":{"description":"Text shown in the Apple Wallet notification when the device enters this location. Falls back to name, then address, if not set. Not used by Google Wallet, which has no per-location text.","type":"string","uniqueKey":"pass.locations.items.[INDEX].relevantText","typeLabel":"string"}},"required":["address","latitude","longitude"],"example":{"name":"Spark Arena","address":"42/80 Mahuhu Crescent, Parnell, Auckland 1010, New Zealand","latitude":-36.847136000000006,"longitued":174.7769837},"uniqueKey":"pass.locations.items.[INDEX]","typeLabel":"object"},"uniqueKey":"pass.locations","typeLabel":"object[]"},"fields":{"maxItems":4,"type":"array","items":{"description":"A field that is displayed in a voucher, that is identified by the key. It can be defined in a template and overwritten in a pass","type":"object","properties":{"key":{"description":"The identifier of the field. This is not presented to the user.","type":"string","isRequired":true,"uniqueKey":"pass.fields.items.[INDEX].key","typeLabel":"string"},"label":{"description":"The label to go with the value.","type":"string","isRequired":true,"uniqueKey":"pass.fields.items.[INDEX].label","typeLabel":"string"},"value":{"description":"The data to display.","type":"string","isRequired":true,"uniqueKey":"pass.fields.items.[INDEX].value","typeLabel":"string"}},"required":["key","label","value"],"example":{"key":"voucher","label":"free drinks","value":"1"},"uniqueKey":"pass.fields.items.[INDEX]","typeLabel":"object"},"uniqueKey":"pass.fields","typeLabel":"object[]"},"backFields":{"description":"The values can be text, numbers or urls.","type":"array","items":{"description":"A field that is displayed in a voucher, that is identified by the key. It can be defined in a template and overwritten in a pass","type":"object","properties":{"key":{"description":"The identifier of the field. This is not presented to the user.","type":"string","isRequired":true,"uniqueKey":"pass.backFields.items.[INDEX].key","typeLabel":"string"},"label":{"description":"The label to go with the value.","type":"string","isRequired":true,"uniqueKey":"pass.backFields.items.[INDEX].label","typeLabel":"string"},"value":{"description":"The data to display.","type":"string","isRequired":true,"uniqueKey":"pass.backFields.items.[INDEX].value","typeLabel":"string"}},"required":["key","label","value"],"example":{"key":"voucher","label":"free drinks","value":"1"},"uniqueKey":"pass.backFields.items.[INDEX]","typeLabel":"object"},"uniqueKey":"pass.backFields","typeLabel":"object[]"}},"required":["id","templateId","accountId","code","expiry","validFrom","voided"],"example":{"id":"WgXcQ","templateId":"fan-reward","accountId":"LDvGjp645u6Q6t9pbvog","code":"ASDF123","expiry":"2025-04-04T19:41:12.733Z","validFrom":"2025-04-04T19:41:12.733Z","voided":false,"fields":[{"key":"voucher","label":"free drinks","value":"1"}],"backFields":[{"key":"terms","label":"Terms and Condictions","value":"https://myshout.co/terms"}]},"isRequired":true,"uniqueKey":"pass","typeLabel":"object"},"googleUrl":{"type":"string","isRequired":true,"uniqueKey":"googleUrl","typeLabel":"string"},"appleUrl":{"type":"string","isRequired":true,"uniqueKey":"appleUrl","typeLabel":"string"},"webUrl":{"type":"string","isRequired":true,"uniqueKey":"webUrl","typeLabel":"string"}},"required":["pass","googleUrl","appleUrl","webUrl"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"pass":{"id":"WgXcQ","templateId":"fan-reward","accountId":"LDvGjp645u6Q6t9pbvog","code":"ASDF123","expiry":"2025-04-04T19:41:12.733Z","validFrom":"2025-04-04T19:41:12.733Z","voided":false,"fields":[{"key":"voucher","label":"free drinks","value":"1"}],"backFields":[{"key":"terms","label":"Terms and Condictions","value":"https://myshout.co/terms"}]},"googleUrl":"\u003cstring>","appleUrl":"\u003cstring>","webUrl":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"9542f4d0-f885-406a-a473-424282a3d5ef":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number","uniqueKey":"statusCode","typeLabel":"number"},"code":{"type":"string","uniqueKey":"code","typeLabel":"string"},"error":{"type":"string","uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"}},"title":"HttpError","uniqueKey":"","typeLabel":"HttpError · object"},"examples":{"Example":{"title":"Example","value":{"statusCode":123,"code":"\u003cstring>","error":"\u003cstring>","message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"09472865-d855-4a99-947e-758fc97ede65":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number","uniqueKey":"statusCode","typeLabel":"number"},"code":{"type":"string","uniqueKey":"code","typeLabel":"string"},"error":{"type":"string","uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"}},"title":"HttpError","uniqueKey":"","typeLabel":"HttpError · object"},"examples":{"Example":{"title":"Example","value":{"statusCode":123,"code":"\u003cstring>","error":"\u003cstring>","message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"bf521338-da3c-4274-b59c-2c3ef2d862f8":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number","uniqueKey":"statusCode","typeLabel":"number"},"code":{"type":"string","uniqueKey":"code","typeLabel":"string"},"error":{"type":"string","uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"}},"title":"HttpError","uniqueKey":"","typeLabel":"HttpError · object"},"examples":{"Example":{"title":"Example","value":{"statusCode":123,"code":"\u003cstring>","error":"\u003cstring>","message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"57af7967-4b08-4f2e-99dc-39a4bedd8956":{"bearerAuth":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"3488112f-d7e8-496d-b720-fee63c0f4059":{"url":"https://api.passform.io"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"passform","siteName":"Passform Docs","title":"Create pass - Passform Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-07T22:26:06.502Z","originalFileLocation":"api-reference/passes/create-pass.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Create a pass for a given template with a random passId. The pass ID will be a Base58 string that is 8 characters\">\u003cmeta data-mint-head name=\"application-name\" content=\"Passform Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/passform/dcIVTjFp3kP0357g/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/passform/dcIVTjFp3kP0357g/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/passform/dcIVTjFp3kP0357g/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/passform/dcIVTjFp3kP0357g/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/passform/dcIVTjFp3kP0357g/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/passform/dcIVTjFp3kP0357g/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/passform/dcIVTjFp3kP0357g/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/passform/dcIVTjFp3kP0357g/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/passform/dcIVTjFp3kP0357g/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create pass - Passform Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Create a pass for a given template with a random passId. The pass ID will be a Base58 string that is 8 characters\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Passform Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.passform.io/api-reference/passes/create-pass\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://passform.mintlify.app/_mintlify/api/og/v2?division=passes\u0026amp;title=Create+pass\u0026amp;description=Create+a+pass+for+a+given+template+with+a+random+passId.+The+pass+ID+will+be+a+Base58+string+that+is+8+characters\u0026amp;theme=6de1795354b2e2a3f6ca671d\u0026amp;signature=5fa76cb232e48a67d02a54792bf49d37c1c06bdffbf0a7ffdca9badf0f3788cc\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Create pass - Passform Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Create a pass for a given template with a random passId. The pass ID will be a Base58 string that is 8 characters\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://passform.mintlify.app/_mintlify/api/og/v2?division=passes\u0026amp;title=Create+pass\u0026amp;description=Create+a+pass+for+a+given+template+with+a+random+passId.+The+pass+ID+will+be+a+Base58+string+that+is+8+characters\u0026amp;theme=6de1795354b2e2a3f6ca671d\u0026amp;signature=5fa76cb232e48a67d02a54792bf49d37c1c06bdffbf0a7ffdca9badf0f3788cc\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/passform/dcIVTjFp3kP0357g/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Passform Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#009485\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.passform.io/api-reference/passes/create-pass\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/passes/create-pass.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.passform.io/#organization\",\"name\":\"Passform Docs\",\"url\":\"https://docs.passform.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/passform/pcWZEUYGXmyjRGIQ/logo/logo-black.png?fit=max\u0026auto=format\u0026n=pcWZEUYGXmyjRGIQ\u0026q=85\u0026s=246ff0edaaabc72a37df70791750c3f5\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.passform.io#website\",\"name\":\"Passform Docs\",\"url\":\"https://docs.passform.io\",\"publisher\":{\"@id\":\"https://docs.passform.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.passform.io/api-reference/passes/create-pass#webpage\",\"url\":\"https://docs.passform.io/api-reference/passes/create-pass\",\"name\":\"Create pass\",\"description\":\"Create a pass for a given template with a random passId. The pass ID will be a Base58 string that is 8 characters\",\"dateModified\":\"2026-10-07T22:26:06.502Z\",\"isPartOf\":{\"@id\":\"https://docs.passform.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.passform.io/api-reference/passes/create-pass#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.passform.io/api-reference/passes/create-pass#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://docs.passform.io/api-reference/api-welcome-message\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"passes\",\"item\":\"https://docs.passform.io/api-reference/passes/get-pass-google-wallet-url\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Create pass\",\"item\":\"https://docs.passform.io/api-reference/passes/create-pass\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.passform.io/api-reference/passes/create-pass#apireference\",\"headline\":\"Create pass\",\"name\":\"Create pass\",\"description\":\"Create a pass for a given template with a random passId. The pass ID will be a Base58 string that is 8 characters\",\"url\":\"https://docs.passform.io/api-reference/passes/create-pass\",\"mainEntityOfPage\":{\"@id\":\"https://docs.passform.io/api-reference/passes/create-pass#webpage\"},\"dateModified\":\"2026-10-07T22:26:06.502Z\",\"publisher\":{\"@id\":\"https://docs.passform.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.passform.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Passform Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Passform Docs","nav":{"global":{"anchors":[{"anchor":"Support","icon":"envelope","href":"mailto:support@passform.io"},{"anchor":"LinkedIn","icon":"linkedin","href":"https://linkedin.com/company/passform-io"}]},"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"API reference","groups":[{"group":"Overview","pages":[{"title":"Introduction","href":"/api-reference/introduction"}]},{"group":"Endpoints","pages":[{"group":"API Reference","pages":[{"title":"API welcome message","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /","href":"/api-reference/api-welcome-message"}]},{"group":"accounts","pages":[{"title":"Get account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/account","href":"/api-reference/accounts/get-account"},{"title":"Invite account member","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/account/invite","href":"/api-reference/accounts/invite-account-member"},{"title":"Accept account invite","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/account/accept","href":"/api-reference/accounts/accept-account-invite"}]},{"group":"memberships","pages":[{"title":"Get membership member","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/memberships/members/{memberId}","href":"/api-reference/memberships/get-membership-member"}]},{"group":"passes","pages":[{"title":"Get pass Google Wallet URL","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/pass/{accountId}/{templateId}/{passId}/google","href":"/api-reference/passes/get-pass-google-wallet-url"},{"title":"Get pass Apple Wallet file","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/pass/{accountId}/{templateId}/{passId}/apple","href":"/api-reference/passes/get-pass-apple-wallet-file"},{"title":"Get Apple Wallet bundle","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/pass/{accountId}/bundle/apple","href":"/api-reference/passes/get-apple-wallet-bundle"},{"title":"Get Google Wallet bundle","description":"Generate a single Google Pay save URL for multiple passes and redirect to it, with limit of 10 passes per bundle.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/pass/{accountId}/bundle/google","href":"/api-reference/passes/get-google-wallet-bundle"},{"title":"Create pass","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/pass/{templateId}","href":"/api-reference/passes/create-pass"},{"title":"List passes","description":"List passes for a template with pagination and sorting","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/pass/{templateId}/passes","href":"/api-reference/passes/list-passes"},{"title":"Get pass","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/pass/{templateId}/{passId}","href":"/api-reference/passes/get-pass"},{"title":"Upsert pass","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/pass/{templateId}/{passId}","href":"/api-reference/passes/upsert-pass"},{"title":"Notify pass","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/pass/{templateId}/{passId}/notify","href":"/api-reference/passes/notify-pass"},{"title":"Update pass metadata","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/pass/{templateId}/{passId}/metadata","href":"/api-reference/passes/update-pass-metadata"},{"title":"Move pass to another template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/pass/{templateId}/{passId}/move","href":"/api-reference/passes/move-pass-to-another-template"}]},{"group":"templates","pages":[{"title":"List templates","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/templates","href":"/api-reference/templates/list-templates"},{"title":"Get template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/templates/{templateId}","href":"/api-reference/templates/get-template"},{"title":"Upsert template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/templates/{templateId}","href":"/api-reference/templates/upsert-template"},{"title":"Archive template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/templates/{templateId}/archive","href":"/api-reference/templates/archive-template"},{"title":"Upload template images","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/templates/{templateId}/images","href":"/api-reference/templates/upload-template-images"},{"title":"List templates (paged)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/templates/list","href":"/api-reference/templates/list-templates-paged"}]},{"group":"user","pages":[{"title":"Update user","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/user","href":"/api-reference/user/update-user"}]}]}]}]},"basePath":"","title":"Create pass - Passform Docs","buildId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","deploymentId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DCDCdBVX.js","utils-ME8dDnLe.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-0e84ACsd.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-wgRBj-ia.js","snippetPresets-C11Sgb-o.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-C0lapOpP.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-ZeRQV8fF.js","shallow-BupWh095.js","getApiPlaygroundDisplay-BnYQO2Ss.js","CodeSnippet-RKKOc8c_.js","CodeSnippets-Drf_m8wS.js","Page-Bevw23-4.js","getPastedJson-u6QiPzNZ.js","icon-Bb-CBSxO.js","MethodPill-F7l5AI7V.js","DuplicateIcon-IiAXkdSg.js","createIcon-FliI8EBc.js","DynamicMarkdown-B62XqCSI.js","SectionHeading-Dj31pT03.js","axios-vUo_bRtp.js","Markdown-BOgQCTwD.js","clsx-BIWXJmsZ.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DKZWslLH.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-UDqbR6xh.js"]}