ReferencePasses

Passes

43 operations. Send Authorization: Bearer $PASSBOOK_KEY. Markdown

GET/api/v1/passes

Lists passes, newest first. Filter by template, status, holder email or externalId; page with cursor.

passes:readSDK pb.passes.list

Query

templateIdstring · max 64
connectionIdstring · max 64
importIdstring · max 64
status"active" | "voided" | "removed"
holderEmailstring · max 254
holderState"unassigned" | "waiting" | "owned"
onDevice"true" | "false"
qstring · max 200
externalIdstring · max 200
scanstring · max 200
matchstring · max 2000
cursorstring · max 512
limitinteger · ≥ 1 · ≤ 200

Returns

200 PassPage

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.
POST/api/v1/passes

Creates a pass from a template. input holds the template's fields; see sample on the template. Send an Idempotency-Key header to retry safely. Set sendEmail with holderEmail to email the pass.

passes:writeIdempotent with keySDK pb.passes.create

Headers

Idempotency-Keystring · max 200

1 to 200 characters. A retry with the same key and body returns the first result.

Body

templateIdstring · max 64Required
inputobjectRequired

The template's fields. GET /templates/{id}/input-schema returns the schema.

mode"live" | "test"
templateVersionstring
releaseIdstring · max 64
releaseGenerationinteger
identityIdstring · max 64
holderEmailstring · max 254
externalIdstring · max 200

Your own key for the pass, any time. Filter with GET /passes?externalId=. Unique per org and mode only if the template says so.

serialstring · ^[A-Za-z0-9._~-]{1,100}$

Sets the Wallet serial. Honored only on the organization's own signing identity; the platform identity picks its own.

connectionIdstring · max 64

Binds the pass to a connection. Send with externalRef.

externalRefstring · max 500

The upstream record id, for passes created by a connection. Send with connectionId.

sendEmailboolean

Returns

201 PassDetail

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/{id}

One pass with its fields, links and channels.

passes:readSDK pb.passes.retrieve

Path

idstring · max 64Required

Returns

200 PassDetail

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.
PATCH/api/v1/passes/{id}

Changes a pass's fields. Send If-Match with the current version; a stale version is 412 VERSION_CONFLICT. Installed passes update in Wallet.

passes:writeSDK pb.passes.update

Path

idstring · max 64Required

Body

inputobject
templateVersionstring
externalIdstring | null · max 200
resetToConnectionstring[]
notifyboolean

Returns

200 PassDetail

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_CONFLICTGET the pass, apply your change to it, and resend with the new version.
VERSION_NOT_FOUNDCheck the version with GET /api/v1/passes/{id}.
VERSION_PURGEDRequest a newer version.
WORKFLOW_STARTSend the request again.
DEL/api/v1/passes/{id}

Deletes the pass record. To take a pass out of Wallet and keep the record, use remove.

passes:writeSDK pb.passes.delete

Path

idstring · max 64Required

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.
POST/api/v1/passes/{id}/void

Voids a pass. Wallet shows it as void and scans are refused. Undo with unvoid.

passes:writeSDK pb.passes.void

Path

idstring · max 64Required

Returns

200 PassSummary

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.
POST/api/v1/passes/{id}/unvoid

Undoes a void.

passes:writeSDK pb.passes.unvoid

Path

idstring · max 64Required

Returns

200 PassSummary

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.
POST/api/v1/passes/{id}/refresh
passes:writeSDK pb.passes.refresh

Path

idstring · 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.
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.
POST/api/v1/passes/{id}/rotate-link

Replaces the download and public links. The old links stop working.

passes:writeSDK pb.passes.rotateLink

Path

idstring · max 64Required

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.
POST/api/v1/passes/{id}/new-code

Mints a new scan code. The old code stops working.

passes:writeSDK pb.passes.rotateCode

Path

idstring · max 64Required

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.
POST/api/v1/passes/{id}/resend-email

Emails the pass link to the holder, or to to when given. Send an Idempotency-Key header to retry safely.

passes:writeIdempotent with keySDK pb.passes.sendEmail

Path

idstring · max 64Required

Headers

Idempotency-Keystring · max 200

1 to 200 characters. A retry with the same key and body returns the first result.

Body

tostring · max 254
attachboolean

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.
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.
POST/api/v1/passes/photos/match
passes:writeSDK pb.passes.matchPhotos

Body

keysstring · max 200[]Required
orgIdstring · max 64

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.
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.
POST/api/v1/passes/{id}/renew
passes:writeSDK pb.passes.renew

Path

idstring · max 64Required

Returns

200 PassDetail

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.
POST/api/v1/passes/bulk
passes:writeIdempotent with keySDK pb.passes.bulkApply

Headers

Idempotency-Keystring · max 200

1 to 200 characters. A retry with the same key and body returns the first result.

Body

action"void" | "send_email" | "remove"Required
idsstring · max 64[]Required
messagestring · max 200
orgIdstring · max 64

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.
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.
POST/api/v1/passes/bulk-reissue
passes:writeSDK pb.passes.bulkReissue

Body

templateIdstring · max 64
versionstring
orgIdstring · max 64
cause"template_upgrade" | "resign"
identityIdstring · max 64

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.
POST/api/v1/passes/bulk/channels
passes:writeSDK pb.passes.bulkUpdateChannels

Body

action"on" | "off" | "reset"Required
channels"mobile" | "apple" | "google" | "samsung" | "paper" | "nfc"[]Required
idsstring · max 64[]Required
notifyboolean
replaceCodesboolean
dryRunboolean
orgIdstring · max 64

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.
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.
POST/api/v1/passes/{id}/remove

Removes the pass from Wallet by publishing a voided, expired final version. The record stays; undo with restore. message shows on the lock screen.

passes:writeSDK pb.passes.remove

Path

idstring · max 64Required

Body

messagestring · max 200

Returns

200 PassSummary

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.
POST/api/v1/passes/{id}/restore

Undoes a removal and publishes the pass again.

passes:writeSDK pb.passes.restore

Path

idstring · max 64Required

Returns

200 PassSummary

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/wallet-providers/passes/{id}
passes:readSDK pb.passes.retrieveProviderStatus

Path

idstring · max 64Required

Returns

200

Errors

CodeStatusFix
FORBIDDENUse a key with the scope the operation lists, or ask an org admin.
GOOGLE_CALLBACK_INVALIDSend callbacks only from Google; check the callback URL set in Google Wallet.
GOOGLE_CALLBACK_UNAVAILABLERetry with backoff; Google resends failed callbacks.
GOOGLE_ISSUER_NOT_OWNEDShare an issuer your Google account owns, then send the request again.
GOOGLE_ISSUER_NOT_SHAREDShare the issuer in the Google Pay and Wallet console, then send the request again.
GOOGLE_UNAVAILABLESend the request again in a minute.
IAM_BAD_ACCOUNTSend the request again; contact support if it repeats.
IAM_BAD_KEYSend the request again; contact support if it repeats.
INVALID_API_KEYCreate a new key in the console and update PASSBOOK_KEY.
MISSING_SCOPECreate a key with the scope the operation lists under security.
NOT_FOUNDCheck the id, and that the key's mode (test or live) matches the object.
ORG_NOT_FOUNDCheck orgId with GET /api/v1/orgs.
PASS_NOT_FOUNDCheck the id with GET /api/v1/passes and the key's mode.
RATE_LIMITEDWait for Retry-After seconds, then retry. Back off on repeats.
SAMSUNG_FIELDS_INVALIDSend callbacks only from Samsung Wallet; check the callback setup.
SAMSUNG_UNAUTHENTICATEDCheck the Samsung Wallet partner credentials stored for the organization.
SAMSUNG_UNAVAILABLERetry with backoff.
TEMPLATE_MODE_MISMATCHUse a key of the template's mode.
TEMPLATE_SELF_APPROVALHave a different member approve the candidate.
UNAUTHENTICATEDSend Authorization: Bearer $PASSBOOK_KEY.
VALIDATIONFix each field in issues and resend.
WALLET_ACCOUNT_CONFLICTFetch it again and send your change.
WALLET_ACCOUNT_INSTANCES_ACTIVERetire all provider instances, then revoke the account.
WALLET_ACCOUNT_MOVEDList accounts with GET /api/v1/wallet-providers/accounts and use the current one.
WALLET_ART_MISMATCHReplace the image with one at the size shown in issues.
WALLET_CREDENTIALS_INVALIDFix the credentials named in issues and send them again.
WALLET_CREDENTIALS_UNAVAILABLERetry with backoff.
WALLET_ENROLMENT_HELDAsk the platform owner to release the hold.
WALLET_ENROLMENT_PREREQUISITEFinish the steps listed in the response, then retry.
WALLET_IDENTITY_IMMUTABLECreate a new account for the new identity.
WALLET_IMAGE_NOT_FOUNDRebuild the wallet projection and use the new image URL.
WALLET_ISSUER_CLAIMEDUse a different issuer.
WALLET_ISSUER_EXISTSAttach it as a shared issuer instead.
WALLET_ISSUER_NOT_WAITINGCheck the issuer status before completing it.
WALLET_KEY_HELDMove the credential to the new key, then send the request again.
WALLET_MODE_MISMATCHUse a key of the same mode as the request.
WALLET_OFFER_NOT_FOUNDRequest a new offer for the pass.
WALLET_PLATFORM_CREDENTIAL_MISSINGAsk the platform owner to add it, then send the request again.
WALLET_PROJECTION_BLOCKEDFix the problems the response lists and build the projection again.
WALLET_PROJECTION_CONFLICTFetch the candidate again and send your request.
WALLET_PROJECTION_NOT_FOUNDCheck the id and create a candidate if it expired.
WALLET_PROJECTION_SCHEMACreate a new candidate from the current release.
WALLET_PROJECTION_UNSUPPORTEDRemove the unsupported features or release without this provider.
WALLET_RUN_BUSYSend the request again in a minute.
WALLET_VERIFICATION_CONFLICTWait for it to finish, then verify again if needed.

Activity

GET/api/v1/passes/{id}/events
passes:readSDK pb.passes.activity.list

Path

idstring · max 64Required

Query

cursorstring · max 512
limitinteger · ≥ 1 · ≤ 200
kindstring · max 600
group"delivery" | "devices" | "changes" | "scans"

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.

Assets

GET/api/v1/passes/{id}/assets
passes:readSDK pb.passes.assets.list

Path

idstring · max 64Required

Query

cursorstring · max 512

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.
PUT/api/v1/passes/{id}/assets/{name}
passes:writeSDK pb.passes.assets.upload

Path

idstring · max 64Required
namestring · ^[a-zA-Z]+(?:@[23]x)?\.png$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.
DEL/api/v1/passes/{id}/assets/{name}
passes:writeSDK pb.passes.assets.delete

Path

idstring · max 64Required
namestring · ^[a-zA-Z]+(?:@[23]x)?\.png$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.

Channels

GET/api/v1/passes/{id}/channels
passes:readSDK pb.passes.channels.retrieve

Path

idstring · max 64Required

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.
PUT/api/v1/passes/{id}/channels
passes:writeSDK pb.passes.channels.update

Path

idstring · max 64Required

Body

channelsobjectRequired
mobile"on" | "off" | null
apple"on" | "off" | null
google"on" | "off" | null
samsung"on" | "off" | null
paper"on" | "off" | null
nfc"on" | "off" | null
notifyboolean
replaceCodesboolean
orgIdstring · max 64

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.

Check In Rules

GET/api/v1/passes/{id}/check-in
passes:readSDK pb.passes.checkInRules.retrieve

Path

idstring · max 64Required

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.
PUT/api/v1/passes/{id}/check-in
passes:writeSDK pb.passes.checkInRules.update

Path

idstring · max 64Required

Body

rulesobjectRequired
mode"single" | "daily" | "unlimited" | "in_out"
eventIdstring | null · max 64
validFrominteger | null · ≥ 0
validUntilinteger | null · ≥ 0
durationMinutesinteger | null · ≥ 1 · ≤ 5256000
durationFrom"first_scan" | "issued"
daysinteger | null · ≥ 1 · ≤ 366

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.

Connection

PUT/api/v1/passes/{id}/connection
passes:writeSDK pb.passes.connection.update

Path

idstring · max 64Required

Body

connectionIdstring | null · max 64Required
externalRefstring | null · max 500Required
resetFieldSourcesboolean

Returns

200 PassDetail

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.

Devices

GET/api/v1/passes/{id}/devices
passes:readSDK pb.passes.devices.list

Path

idstring · max 64Required

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.

Member Photo

GET/api/v1/passes/{id}/member-photo
passes:readSDK pb.passes.memberPhoto.retrieve

Path

idstring · max 64Required

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.
PUT/api/v1/passes/{id}/member-photo
passes:writeSDK pb.passes.memberPhoto.upload

Path

idstring · max 64Required

Body

pngstring · max 1400000Required
includeInPassboolean

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.
PATCH/api/v1/passes/{id}/member-photo
passes:writeSDK pb.passes.memberPhoto.update

Path

idstring · max 64Required

Body

includeInPassbooleanRequired

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.
DEL/api/v1/passes/{id}/member-photo
passes:writeSDK pb.passes.memberPhoto.delete

Path

idstring · max 64Required

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/{id}/member-photo/image
passes:readSDK pb.passes.memberPhoto.download

Path

idstring · max 64Required

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.

Prints

GET/api/v1/passes/{id}/prints
passes:readSDK pb.passes.prints.list

Path

idstring · max 64Required

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.
POST/api/v1/passes/{id}/prints
passes:writeSDK pb.passes.prints.create

Path

idstring · max 64Required

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.
POST/api/v1/passes/{id}/prints/{printId}/void
passes:writeSDK pb.passes.prints.void

Path

idstring · max 64Required
printIdstring · max 64Required

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/{id}/print
passes:readSDK pb.passes.prints.retrievePage

Path

idstring · max 64Required

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/{id}/print/pdf
passes:readSDK pb.passes.prints.downloadPdf

Path

idstring · max 64Required

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/{id}/print/assets/{name}
passes:readSDK pb.passes.prints.downloadAsset

Path

idstring · max 64Required
namestring · max 200Required

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.

Stamps

POST/api/v1/passes/{id}/stamps
passes:writeSDK pb.passes.stamps.apply

Path

idstring · max 64Required

Returns

200 PassDetail

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.

Versions

GET/api/v1/passes/{id}/versions/{version}
passes:readSDK pb.passes.versions.retrieve

Path

idstring · max 64Required
versioninteger | null

Returns

200 PassDetail

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/{id}/diff
passes:readSDK pb.passes.versions.diff

Path

idstring · max 64Required

Query

frominteger | null
tointeger | null

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.