ReferencePasses

Print jobs

3 operations. Send Authorization: Bearer $PASSBOOK_KEY. Markdown

POST/api/v1/passes/bulk-print
passes:writeSDK pb.printJobs.create

Body

idsstring · max 64[]Required
orgIdstring · max 64Required

Returns

202

Errors

CodeStatusFix
ASSET_DIMENSIONSResize the image to the size named in issues and upload it again.
ASSET_NOT_FOUNDCheck the image name or id and that it belongs to this organization.
ASSET_NOT_PNGRe-export the image as a standard RGB or RGBA PNG and upload it again.
ASSET_SIZECompress the image below 1 MB and upload it again.
ASSET_SLOTUse a slot name from the pass type's image slots in the request path.
BULK_RUN_ACTIVEWait for the running job to finish, then start the new one.
BUNDLE_TOO_LARGESplit the passes across smaller bundles.
CONNECTION_ORGUse a connection id from your own organization's GET /api/v1/connections.
CONNECTION_TRANSFER_PENDINGWait for the transfer to finish, then send the request again.
CREATE_STALELook the pass up by externalId with GET /api/v1/passes and update it instead of creating it again.
CREDENTIAL_REF_KEYSET_CONFIG_UNAVAILABLERetry with backoff; if it persists, send the requestId to support.
CREDENTIAL_REF_KEYSET_UNAVAILABLERetry with backoff; if it persists, send the requestId to support.
DELIVERY_STALEReview the recipient and try again.
DEVICE_TOKEN_UNAVAILABLERetry the request; if it persists, send the requestId to support.
EMAIL_INVALIDSend a valid address in the email field.
EXTERNAL_ID_TAKENSend a new externalId, or PATCH the existing pass.
FORBIDDENUse a key with the scope the operation lists, or ask an org admin.
IDEMPOTENCY_IN_PROGRESSWait a moment and resend the identical request.
IDEMPOTENCY_KEY_INVALIDSend a unique string of 1 to 200 characters, such as a UUID.
IDEMPOTENCY_KEY_REUSEDUse a new key for a new request; resend the identical request to replay.
IF_MATCH_INVALIDSend the version from the last GET, for example If-Match: 3.
IMPORT_BUSYWait for it to finish with GET /api/v1/pass-imports/{id}, then retry.
IMPORT_COLUMN_MISSINGAdd the column to the file, or change the mapping, then check again.
IMPORT_EXPIREDUpload the file again with POST /api/v1/pass-imports.
IMPORT_FILE_GONEUpload it again.
IMPORT_HAS_ERRORSFix the rows listed in GET /api/v1/pass-imports/{id}/errors.csv, or skip them, then commit again.
IMPORT_HEADER_TOO_LONGShorten the header and upload the file again.
IMPORT_ID_TAKENCheck the import again with POST /api/v1/pass-imports/{id}/check, then commit.
IMPORT_NOT_FOUNDCheck the id with GET /api/v1/pass-imports.
IMPORT_PASS_CHANGEDRemove the pass on its own with POST /api/v1/passes/{id}/remove.
IMPORT_PLAN_INVALIDFix the mapping entries named in issues and check again.
IMPORT_ROW_UNRESERVEDRetry the commit; if it persists, send the requestId to support.
IMPORT_STATECheck its state with GET /api/v1/pass-imports/{id} and call the action that state allows.
INVALID_API_KEYCreate a new key in the console and update PASSBOOK_KEY.
INVALID_INPUTFix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them.
JOIN_NOT_READYPublish the template, then enable the link with PUT /api/v1/join-links/{templateId}.
MATCH_NEEDS_TEMPLATESend orgId and templateId with the input filter.
MEMBER_PHOTO_CHANGEDFetch the pass with GET /api/v1/passes/{id} and save the photo again.
MEMBER_PHOTO_DIMENSIONSCrop the photo to a 270 by 270 pixel square and upload it again.
MEMBER_PHOTO_ENCODINGSend the photo as a PNG or JPEG file.
MEMBER_PHOTO_NOT_FOUNDAdd one with PUT /api/v1/passes/{id}/member-photo.
MEMBER_PHOTO_STYLEUse a template of that style, or remove the strip image.
MISSING_SCOPECreate a key with the scope the operation lists under security.
MODE_MISMATCHUse objects and a key of the same mode.
NEW_CODE_UNSUPPORTEDReissue the pass with POST /api/v1/passes/bulk-reissue instead of requesting a new code.
NO_RECIPIENTSet the holder's email with PATCH /api/v1/passes/{id}, then send again.
ORG_ACCESS_CHANGEDCheck access with GET /api/v1/api-keys/me, then send the request again.
ORG_FORBIDDENUse a key scoped to this organization, or a platform key for platform-wide lists.
ORG_MIXEDSend ids from one organization per request.
ORG_NOT_FOUNDCheck orgId with GET /api/v1/orgs.
ORG_REQUIREDSend orgId with the request, or use a key scoped to one organization.
PASS_CONFLICTFetch the pass with GET /api/v1/passes/{id} and send the request again.
PASS_CONNECTION_MISMATCHLink it with PUT /api/v1/passes/{id}/connection, then send the request again.
PASS_FILE_MISSINGRebuild it with POST /api/v1/passes/{id}/refresh.
PASS_INPUT_INVALIDFix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them.
PASS_INVALIDFix the problems named in issues in the template or inputs.
PASS_NOT_ACTIVERestore or unvoid the pass first, or use an active one.
PASS_NOT_FOUNDCheck the id with GET /api/v1/passes and the key's mode.
PASS_REF_TAKENUse a different ref, or update the existing pass.
PASS_REISSUE_REQUIREDReissue it with POST /api/v1/passes/bulk-reissue.
PASS_REMOVEDRestore it with POST /api/v1/passes/{id}/restore, then send the request again.
PASS_TRANSFER_NOT_FOUNDCheck the transfer id.
PASS_TRANSFER_PENDINGTry again shortly.
RATE_LIMITEDWait for Retry-After seconds, then retry. Back off on repeats.
RECIPIENT_NOT_HOLDERSend to the holder's email, or change it with PATCH /api/v1/passes/{id}.
SCAN_EVENT_NOT_FOUNDCheck the event id with GET /api/v1/scan/events.
SCAN_WINDOW_INVALIDSet an end after the start, or fix the template's dates.
SERIAL_TAKENSend a different serial, or leave it out to have one generated.
SESSION_REQUIREDDo it in the console, or sign in as the account that started it.
STAMPS_ABOVE_MAXRaise the template's stamp maximum, or redeem stamps first.
STAMPS_CARD_FULLRedeem the reward, then add stamps.
STAMPS_NONEUse a template with stamps.
STAMPS_NO_REWARDAdd stamps until the card is full, then redeem.
TEMPLATE_NOT_FOUNDCheck the id with GET /api/v1/templates and the key's mode.
TEMPLATE_RELEASE_CONFLICTSend the request again to use the current release.
TEMPLATE_RELEASE_REQUIREDApprove a release with POST /api/v1/templates/{id}/candidates/{candidateId}/approve.
TERM_MANAGEDChange the term in the connected system.
TERM_NONERenew only passes whose template defines a term.
TERM_NOT_STARTEDRenew after the term starts.
UNAUTHENTICATEDSend Authorization: Bearer $PASSBOOK_KEY.
VALIDATIONFix each field in issues and resend.
VERSION_NOT_FOUNDCheck the version with GET /api/v1/passes/{id}.
VERSION_PURGEDRequest a newer version.
WORKFLOW_STARTSend the request again.
GET/api/v1/passes/bulk-print/{jobId}
passes:readSDK pb.printJobs.retrieve

Path

jobIdstring · ^[A-Za-z0-9_-]{16,64}$Required

Returns

200

Errors

CodeStatusFix
ASSET_DIMENSIONSResize the image to the size named in issues and upload it again.
ASSET_NOT_FOUNDCheck the image name or id and that it belongs to this organization.
ASSET_NOT_PNGRe-export the image as a standard RGB or RGBA PNG and upload it again.
ASSET_SIZECompress the image below 1 MB and upload it again.
ASSET_SLOTUse a slot name from the pass type's image slots in the request path.
BULK_RUN_ACTIVEWait for the running job to finish, then start the new one.
BUNDLE_TOO_LARGESplit the passes across smaller bundles.
CONNECTION_ORGUse a connection id from your own organization's GET /api/v1/connections.
CONNECTION_TRANSFER_PENDINGWait for the transfer to finish, then send the request again.
CREATE_STALELook the pass up by externalId with GET /api/v1/passes and update it instead of creating it again.
CREDENTIAL_REF_KEYSET_CONFIG_UNAVAILABLERetry with backoff; if it persists, send the requestId to support.
CREDENTIAL_REF_KEYSET_UNAVAILABLERetry with backoff; if it persists, send the requestId to support.
DELIVERY_STALEReview the recipient and try again.
DEVICE_TOKEN_UNAVAILABLERetry the request; if it persists, send the requestId to support.
EMAIL_INVALIDSend a valid address in the email field.
EXTERNAL_ID_TAKENSend a new externalId, or PATCH the existing pass.
FORBIDDENUse a key with the scope the operation lists, or ask an org admin.
IDEMPOTENCY_IN_PROGRESSWait a moment and resend the identical request.
IDEMPOTENCY_KEY_INVALIDSend a unique string of 1 to 200 characters, such as a UUID.
IDEMPOTENCY_KEY_REUSEDUse a new key for a new request; resend the identical request to replay.
IF_MATCH_INVALIDSend the version from the last GET, for example If-Match: 3.
IMPORT_BUSYWait for it to finish with GET /api/v1/pass-imports/{id}, then retry.
IMPORT_COLUMN_MISSINGAdd the column to the file, or change the mapping, then check again.
IMPORT_EXPIREDUpload the file again with POST /api/v1/pass-imports.
IMPORT_FILE_GONEUpload it again.
IMPORT_HAS_ERRORSFix the rows listed in GET /api/v1/pass-imports/{id}/errors.csv, or skip them, then commit again.
IMPORT_HEADER_TOO_LONGShorten the header and upload the file again.
IMPORT_ID_TAKENCheck the import again with POST /api/v1/pass-imports/{id}/check, then commit.
IMPORT_NOT_FOUNDCheck the id with GET /api/v1/pass-imports.
IMPORT_PASS_CHANGEDRemove the pass on its own with POST /api/v1/passes/{id}/remove.
IMPORT_PLAN_INVALIDFix the mapping entries named in issues and check again.
IMPORT_ROW_UNRESERVEDRetry the commit; if it persists, send the requestId to support.
IMPORT_STATECheck its state with GET /api/v1/pass-imports/{id} and call the action that state allows.
INVALID_API_KEYCreate a new key in the console and update PASSBOOK_KEY.
INVALID_INPUTFix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them.
JOIN_NOT_READYPublish the template, then enable the link with PUT /api/v1/join-links/{templateId}.
MATCH_NEEDS_TEMPLATESend orgId and templateId with the input filter.
MEMBER_PHOTO_CHANGEDFetch the pass with GET /api/v1/passes/{id} and save the photo again.
MEMBER_PHOTO_DIMENSIONSCrop the photo to a 270 by 270 pixel square and upload it again.
MEMBER_PHOTO_ENCODINGSend the photo as a PNG or JPEG file.
MEMBER_PHOTO_NOT_FOUNDAdd one with PUT /api/v1/passes/{id}/member-photo.
MEMBER_PHOTO_STYLEUse a template of that style, or remove the strip image.
MISSING_SCOPECreate a key with the scope the operation lists under security.
MODE_MISMATCHUse objects and a key of the same mode.
NEW_CODE_UNSUPPORTEDReissue the pass with POST /api/v1/passes/bulk-reissue instead of requesting a new code.
NOT_FOUNDCheck the id, and that the key's mode (test or live) matches the object.
NO_RECIPIENTSet the holder's email with PATCH /api/v1/passes/{id}, then send again.
ORG_ACCESS_CHANGEDCheck access with GET /api/v1/api-keys/me, then send the request again.
ORG_FORBIDDENUse a key scoped to this organization, or a platform key for platform-wide lists.
ORG_MIXEDSend ids from one organization per request.
ORG_NOT_FOUNDCheck orgId with GET /api/v1/orgs.
ORG_REQUIREDSend orgId with the request, or use a key scoped to one organization.
PASS_CONFLICTFetch the pass with GET /api/v1/passes/{id} and send the request again.
PASS_CONNECTION_MISMATCHLink it with PUT /api/v1/passes/{id}/connection, then send the request again.
PASS_FILE_MISSINGRebuild it with POST /api/v1/passes/{id}/refresh.
PASS_INPUT_INVALIDFix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them.
PASS_INVALIDFix the problems named in issues in the template or inputs.
PASS_NOT_ACTIVERestore or unvoid the pass first, or use an active one.
PASS_NOT_FOUNDCheck the id with GET /api/v1/passes and the key's mode.
PASS_REF_TAKENUse a different ref, or update the existing pass.
PASS_REISSUE_REQUIREDReissue it with POST /api/v1/passes/bulk-reissue.
PASS_REMOVEDRestore it with POST /api/v1/passes/{id}/restore, then send the request again.
PASS_TRANSFER_NOT_FOUNDCheck the transfer id.
PASS_TRANSFER_PENDINGTry again shortly.
RATE_LIMITEDWait for Retry-After seconds, then retry. Back off on repeats.
RECIPIENT_NOT_HOLDERSend to the holder's email, or change it with PATCH /api/v1/passes/{id}.
SCAN_EVENT_NOT_FOUNDCheck the event id with GET /api/v1/scan/events.
SCAN_WINDOW_INVALIDSet an end after the start, or fix the template's dates.
SERIAL_TAKENSend a different serial, or leave it out to have one generated.
SESSION_REQUIREDDo it in the console, or sign in as the account that started it.
STAMPS_ABOVE_MAXRaise the template's stamp maximum, or redeem stamps first.
STAMPS_CARD_FULLRedeem the reward, then add stamps.
STAMPS_NONEUse a template with stamps.
STAMPS_NO_REWARDAdd stamps until the card is full, then redeem.
TEMPLATE_NOT_FOUNDCheck the id with GET /api/v1/templates and the key's mode.
TEMPLATE_RELEASE_CONFLICTSend the request again to use the current release.
TEMPLATE_RELEASE_REQUIREDApprove a release with POST /api/v1/templates/{id}/candidates/{candidateId}/approve.
TERM_MANAGEDChange the term in the connected system.
TERM_NONERenew only passes whose template defines a term.
TERM_NOT_STARTEDRenew after the term starts.
UNAUTHENTICATEDSend Authorization: Bearer $PASSBOOK_KEY.
VALIDATIONFix each field in issues and resend.
VERSION_NOT_FOUNDCheck the version with GET /api/v1/passes/{id}.
VERSION_PURGEDRequest a newer version.
WORKFLOW_STARTSend the request again.
GET/api/v1/passes/bulk-print/{jobId}/pdf
passes:readSDK pb.printJobs.downloadPdf

Path

jobIdstring · ^[A-Za-z0-9_-]{16,64}$Required

Returns

200

Errors

CodeStatusFix
ASSET_DIMENSIONSResize the image to the size named in issues and upload it again.
ASSET_NOT_FOUNDCheck the image name or id and that it belongs to this organization.
ASSET_NOT_PNGRe-export the image as a standard RGB or RGBA PNG and upload it again.
ASSET_SIZECompress the image below 1 MB and upload it again.
ASSET_SLOTUse a slot name from the pass type's image slots in the request path.
BULK_RUN_ACTIVEWait for the running job to finish, then start the new one.
BUNDLE_TOO_LARGESplit the passes across smaller bundles.
CONNECTION_ORGUse a connection id from your own organization's GET /api/v1/connections.
CONNECTION_TRANSFER_PENDINGWait for the transfer to finish, then send the request again.
CREATE_STALELook the pass up by externalId with GET /api/v1/passes and update it instead of creating it again.
CREDENTIAL_REF_KEYSET_CONFIG_UNAVAILABLERetry with backoff; if it persists, send the requestId to support.
CREDENTIAL_REF_KEYSET_UNAVAILABLERetry with backoff; if it persists, send the requestId to support.
DELIVERY_STALEReview the recipient and try again.
DEVICE_TOKEN_UNAVAILABLERetry the request; if it persists, send the requestId to support.
EMAIL_INVALIDSend a valid address in the email field.
EXTERNAL_ID_TAKENSend a new externalId, or PATCH the existing pass.
FORBIDDENUse a key with the scope the operation lists, or ask an org admin.
IDEMPOTENCY_IN_PROGRESSWait a moment and resend the identical request.
IDEMPOTENCY_KEY_INVALIDSend a unique string of 1 to 200 characters, such as a UUID.
IDEMPOTENCY_KEY_REUSEDUse a new key for a new request; resend the identical request to replay.
IF_MATCH_INVALIDSend the version from the last GET, for example If-Match: 3.
IMPORT_BUSYWait for it to finish with GET /api/v1/pass-imports/{id}, then retry.
IMPORT_COLUMN_MISSINGAdd the column to the file, or change the mapping, then check again.
IMPORT_EXPIREDUpload the file again with POST /api/v1/pass-imports.
IMPORT_FILE_GONEUpload it again.
IMPORT_HAS_ERRORSFix the rows listed in GET /api/v1/pass-imports/{id}/errors.csv, or skip them, then commit again.
IMPORT_HEADER_TOO_LONGShorten the header and upload the file again.
IMPORT_ID_TAKENCheck the import again with POST /api/v1/pass-imports/{id}/check, then commit.
IMPORT_NOT_FOUNDCheck the id with GET /api/v1/pass-imports.
IMPORT_PASS_CHANGEDRemove the pass on its own with POST /api/v1/passes/{id}/remove.
IMPORT_PLAN_INVALIDFix the mapping entries named in issues and check again.
IMPORT_ROW_UNRESERVEDRetry the commit; if it persists, send the requestId to support.
IMPORT_STATECheck its state with GET /api/v1/pass-imports/{id} and call the action that state allows.
INVALID_API_KEYCreate a new key in the console and update PASSBOOK_KEY.
INVALID_INPUTFix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them.
JOIN_NOT_READYPublish the template, then enable the link with PUT /api/v1/join-links/{templateId}.
MATCH_NEEDS_TEMPLATESend orgId and templateId with the input filter.
MEMBER_PHOTO_CHANGEDFetch the pass with GET /api/v1/passes/{id} and save the photo again.
MEMBER_PHOTO_DIMENSIONSCrop the photo to a 270 by 270 pixel square and upload it again.
MEMBER_PHOTO_ENCODINGSend the photo as a PNG or JPEG file.
MEMBER_PHOTO_NOT_FOUNDAdd one with PUT /api/v1/passes/{id}/member-photo.
MEMBER_PHOTO_STYLEUse a template of that style, or remove the strip image.
MISSING_SCOPECreate a key with the scope the operation lists under security.
MODE_MISMATCHUse objects and a key of the same mode.
NEW_CODE_UNSUPPORTEDReissue the pass with POST /api/v1/passes/bulk-reissue instead of requesting a new code.
NOT_FOUNDCheck the id, and that the key's mode (test or live) matches the object.
NO_RECIPIENTSet the holder's email with PATCH /api/v1/passes/{id}, then send again.
ORG_ACCESS_CHANGEDCheck access with GET /api/v1/api-keys/me, then send the request again.
ORG_FORBIDDENUse a key scoped to this organization, or a platform key for platform-wide lists.
ORG_MIXEDSend ids from one organization per request.
ORG_NOT_FOUNDCheck orgId with GET /api/v1/orgs.
ORG_REQUIREDSend orgId with the request, or use a key scoped to one organization.
PASS_CONFLICTFetch the pass with GET /api/v1/passes/{id} and send the request again.
PASS_CONNECTION_MISMATCHLink it with PUT /api/v1/passes/{id}/connection, then send the request again.
PASS_FILE_MISSINGRebuild it with POST /api/v1/passes/{id}/refresh.
PASS_INPUT_INVALIDFix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them.
PASS_INVALIDFix the problems named in issues in the template or inputs.
PASS_NOT_ACTIVERestore or unvoid the pass first, or use an active one.
PASS_NOT_FOUNDCheck the id with GET /api/v1/passes and the key's mode.
PASS_REF_TAKENUse a different ref, or update the existing pass.
PASS_REISSUE_REQUIREDReissue it with POST /api/v1/passes/bulk-reissue.
PASS_REMOVEDRestore it with POST /api/v1/passes/{id}/restore, then send the request again.
PASS_TRANSFER_NOT_FOUNDCheck the transfer id.
PASS_TRANSFER_PENDINGTry again shortly.
RATE_LIMITEDWait for Retry-After seconds, then retry. Back off on repeats.
RECIPIENT_NOT_HOLDERSend to the holder's email, or change it with PATCH /api/v1/passes/{id}.
SCAN_EVENT_NOT_FOUNDCheck the event id with GET /api/v1/scan/events.
SCAN_WINDOW_INVALIDSet an end after the start, or fix the template's dates.
SERIAL_TAKENSend a different serial, or leave it out to have one generated.
SESSION_REQUIREDDo it in the console, or sign in as the account that started it.
STAMPS_ABOVE_MAXRaise the template's stamp maximum, or redeem stamps first.
STAMPS_CARD_FULLRedeem the reward, then add stamps.
STAMPS_NONEUse a template with stamps.
STAMPS_NO_REWARDAdd stamps until the card is full, then redeem.
TEMPLATE_NOT_FOUNDCheck the id with GET /api/v1/templates and the key's mode.
TEMPLATE_RELEASE_CONFLICTSend the request again to use the current release.
TEMPLATE_RELEASE_REQUIREDApprove a release with POST /api/v1/templates/{id}/candidates/{candidateId}/approve.
TERM_MANAGEDChange the term in the connected system.
TERM_NONERenew only passes whose template defines a term.
TERM_NOT_STARTEDRenew after the term starts.
UNAUTHENTICATEDSend Authorization: Bearer $PASSBOOK_KEY.
VALIDATIONFix each field in issues and resend.
VERSION_NOT_FOUNDCheck the version with GET /api/v1/passes/{id}.
VERSION_PURGEDRequest a newer version.
WORKFLOW_STARTSend the request again.