ReferencePasses

Bundles

6 operations. Send Authorization: Bearer $PASSBOOK_KEY. Markdown

GET/api/v1/bundles
passes:readSDK pb.bundles.list

Query

cursorstring · max 512
limitinteger · ≥ 1 · ≤ 200
passIdstring · max 64

Returns

200

Errors

CodeStatusFix
BUNDLE_DUPLICATE_PASSList each pass id once.
BUNDLE_EMPTYAdd at least one pass to the bundle.
BUNDLE_MODE_MISMATCHPut only passes of the bundle's mode in it.
BUNDLE_NOT_FOUNDCheck the id with GET /api/v1/bundles.
BUNDLE_TOO_MANYSend at most 10 passes per bundle.
DELIVERY_STALEReview the recipient and try again.
EMAIL_INVALIDSend a valid address in the email field.
FORBIDDENUse a key with the scope the operation lists, or ask an org admin.
INVALID_API_KEYCreate a new key in the console and update PASSBOOK_KEY.
LINK_NOT_FOUNDRequest a fresh link, for example with POST /api/v1/bundles/{id}/rotate-link.
MISSING_SCOPECreate a key with the scope the operation lists under security.
NO_RECIPIENTSet the holder's email with PATCH /api/v1/passes/{id}, then send again.
ORG_REQUIREDSend orgId with the request, or use a key scoped to one organization.
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.
RECIPIENT_NOT_HOLDERSend to the holder's email, or change it with PATCH /api/v1/passes/{id}.
UNAUTHENTICATEDSend Authorization: Bearer $PASSBOOK_KEY.
VALIDATIONFix each field in issues and resend.
POST/api/v1/bundles
passes:writeSDK pb.bundles.create

Body

orgIdstring · max 64Required
passIdsstring · max 64[]Required
namestring · max 80Required
holderEmailstring · max 254
sendEmailboolean

Returns

201

Errors

CodeStatusFix
BUNDLE_DUPLICATE_PASSList each pass id once.
BUNDLE_EMPTYAdd at least one pass to the bundle.
BUNDLE_MODE_MISMATCHPut only passes of the bundle's mode in it.
BUNDLE_NOT_FOUNDCheck the id with GET /api/v1/bundles.
BUNDLE_TOO_MANYSend at most 10 passes per bundle.
DELIVERY_STALEReview the recipient and try again.
EMAIL_INVALIDSend a valid address in the email field.
FORBIDDENUse a key with the scope the operation lists, or ask an org admin.
INVALID_API_KEYCreate a new key in the console and update PASSBOOK_KEY.
LINK_NOT_FOUNDRequest a fresh link, for example with POST /api/v1/bundles/{id}/rotate-link.
MISSING_SCOPECreate a key with the scope the operation lists under security.
NO_RECIPIENTSet the holder's email with PATCH /api/v1/passes/{id}, then send again.
ORG_REQUIREDSend orgId with the request, or use a key scoped to one organization.
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.
RECIPIENT_NOT_HOLDERSend to the holder's email, or change it with PATCH /api/v1/passes/{id}.
UNAUTHENTICATEDSend Authorization: Bearer $PASSBOOK_KEY.
VALIDATIONFix each field in issues and resend.
GET/api/v1/bundles/{id}
passes:readSDK pb.bundles.retrieve

Path

idstring · max 64Required

Returns

200

Errors

CodeStatusFix
BUNDLE_DUPLICATE_PASSList each pass id once.
BUNDLE_EMPTYAdd at least one pass to the bundle.
BUNDLE_MODE_MISMATCHPut only passes of the bundle's mode in it.
BUNDLE_NOT_FOUNDCheck the id with GET /api/v1/bundles.
BUNDLE_TOO_MANYSend at most 10 passes per bundle.
DELIVERY_STALEReview the recipient and try again.
EMAIL_INVALIDSend a valid address in the email field.
FORBIDDENUse a key with the scope the operation lists, or ask an org admin.
INVALID_API_KEYCreate a new key in the console and update PASSBOOK_KEY.
LINK_NOT_FOUNDRequest a fresh link, for example with POST /api/v1/bundles/{id}/rotate-link.
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.
NO_RECIPIENTSet the holder's email with PATCH /api/v1/passes/{id}, then send again.
ORG_REQUIREDSend orgId with the request, or use a key scoped to one organization.
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.
RECIPIENT_NOT_HOLDERSend to the holder's email, or change it with PATCH /api/v1/passes/{id}.
UNAUTHENTICATEDSend Authorization: Bearer $PASSBOOK_KEY.
VALIDATIONFix each field in issues and resend.
DEL/api/v1/bundles/{id}
passes:writeSDK pb.bundles.delete

Path

idstring · max 64Required

Returns

200

Errors

CodeStatusFix
BUNDLE_DUPLICATE_PASSList each pass id once.
BUNDLE_EMPTYAdd at least one pass to the bundle.
BUNDLE_MODE_MISMATCHPut only passes of the bundle's mode in it.
BUNDLE_NOT_FOUNDCheck the id with GET /api/v1/bundles.
BUNDLE_TOO_MANYSend at most 10 passes per bundle.
DELIVERY_STALEReview the recipient and try again.
EMAIL_INVALIDSend a valid address in the email field.
FORBIDDENUse a key with the scope the operation lists, or ask an org admin.
INVALID_API_KEYCreate a new key in the console and update PASSBOOK_KEY.
LINK_NOT_FOUNDRequest a fresh link, for example with POST /api/v1/bundles/{id}/rotate-link.
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.
NO_RECIPIENTSet the holder's email with PATCH /api/v1/passes/{id}, then send again.
ORG_REQUIREDSend orgId with the request, or use a key scoped to one organization.
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.
RECIPIENT_NOT_HOLDERSend to the holder's email, or change it with PATCH /api/v1/passes/{id}.
UNAUTHENTICATEDSend Authorization: Bearer $PASSBOOK_KEY.
VALIDATIONFix each field in issues and resend.
POST/api/v1/bundles/{id}/send-email
passes:writeIdempotent with keySDK pb.bundles.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

Returns

202

Errors

CodeStatusFix
BUNDLE_DUPLICATE_PASSList each pass id once.
BUNDLE_EMPTYAdd at least one pass to the bundle.
BUNDLE_MODE_MISMATCHPut only passes of the bundle's mode in it.
BUNDLE_NOT_FOUNDCheck the id with GET /api/v1/bundles.
BUNDLE_TOO_MANYSend at most 10 passes per bundle.
DELIVERY_STALEReview the recipient and try again.
EMAIL_INVALIDSend a valid address in the email field.
FORBIDDENUse a key with the scope the operation lists, or ask an org admin.
INVALID_API_KEYCreate a new key in the console and update PASSBOOK_KEY.
LINK_NOT_FOUNDRequest a fresh link, for example with POST /api/v1/bundles/{id}/rotate-link.
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.
NO_RECIPIENTSet the holder's email with PATCH /api/v1/passes/{id}, then send again.
ORG_REQUIREDSend orgId with the request, or use a key scoped to one organization.
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.
RECIPIENT_NOT_HOLDERSend to the holder's email, or change it with PATCH /api/v1/passes/{id}.
UNAUTHENTICATEDSend Authorization: Bearer $PASSBOOK_KEY.
VALIDATIONFix each field in issues and resend.
POST/api/v1/bundles/{id}/rotate-link
passes:writeSDK pb.bundles.rotateLink

Path

idstring · max 64Required

Returns

200

Errors

CodeStatusFix
BUNDLE_DUPLICATE_PASSList each pass id once.
BUNDLE_EMPTYAdd at least one pass to the bundle.
BUNDLE_MODE_MISMATCHPut only passes of the bundle's mode in it.
BUNDLE_NOT_FOUNDCheck the id with GET /api/v1/bundles.
BUNDLE_TOO_MANYSend at most 10 passes per bundle.
DELIVERY_STALEReview the recipient and try again.
EMAIL_INVALIDSend a valid address in the email field.
FORBIDDENUse a key with the scope the operation lists, or ask an org admin.
INVALID_API_KEYCreate a new key in the console and update PASSBOOK_KEY.
LINK_NOT_FOUNDRequest a fresh link, for example with POST /api/v1/bundles/{id}/rotate-link.
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.
NO_RECIPIENTSet the holder's email with PATCH /api/v1/passes/{id}, then send again.
ORG_REQUIREDSend orgId with the request, or use a key scoped to one organization.
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.
RECIPIENT_NOT_HOLDERSend to the holder's email, or change it with PATCH /api/v1/passes/{id}.
UNAUTHENTICATEDSend Authorization: Bearer $PASSBOOK_KEY.
VALIDATIONFix each field in issues and resend.