ReferencePasses
Bundles
6 operations. Send Authorization: Bearer $PASSBOOK_KEY. Markdown
GET
/api/v1/bundlespasses:readSDK pb.bundles.list
Query
cursorstring · max 512
limitinteger · ≥ 1 · ≤ 200
passIdstring · max 64
Returns
200
Errors
| Code | Status | Fix |
|---|---|---|
| BUNDLE_DUPLICATE_PASS | List each pass id once. | |
| BUNDLE_EMPTY | Add at least one pass to the bundle. | |
| BUNDLE_MODE_MISMATCH | Put only passes of the bundle's mode in it. | |
| BUNDLE_NOT_FOUND | Check the id with GET /api/v1/bundles. | |
| BUNDLE_TOO_MANY | Send at most 10 passes per bundle. | |
| DELIVERY_STALE | Review the recipient and try again. | |
| EMAIL_INVALID | Send a valid address in the email field. | |
| FORBIDDEN | Use a key with the scope the operation lists, or ask an org admin. | |
| INVALID_API_KEY | Create a new key in the console and update PASSBOOK_KEY. | |
| LINK_NOT_FOUND | Request a fresh link, for example with POST /api/v1/bundles/{id}/rotate-link. | |
| MISSING_SCOPE | Create a key with the scope the operation lists under security. | |
| NO_RECIPIENT | Set the holder's email with PATCH /api/v1/passes/{id}, then send again. | |
| ORG_REQUIRED | Send orgId with the request, or use a key scoped to one organization. | |
| PASS_NOT_FOUND | Check the id with GET /api/v1/passes and the key's mode. | |
| RATE_LIMITED | Wait for Retry-After seconds, then retry. Back off on repeats. | |
| RECIPIENT_NOT_HOLDER | Send to the holder's email, or change it with PATCH /api/v1/passes/{id}. | |
| UNAUTHENTICATED | Send Authorization: Bearer $PASSBOOK_KEY. | |
| VALIDATION | Fix each field in issues and resend. |
POST
/api/v1/bundlespasses:writeSDK pb.bundles.create
Body
orgIdstring · max 64Required
passIdsstring · max 64[]Required
namestring · max 80Required
holderEmailstring · max 254
sendEmailboolean
Returns
201
Errors
| Code | Status | Fix |
|---|---|---|
| BUNDLE_DUPLICATE_PASS | List each pass id once. | |
| BUNDLE_EMPTY | Add at least one pass to the bundle. | |
| BUNDLE_MODE_MISMATCH | Put only passes of the bundle's mode in it. | |
| BUNDLE_NOT_FOUND | Check the id with GET /api/v1/bundles. | |
| BUNDLE_TOO_MANY | Send at most 10 passes per bundle. | |
| DELIVERY_STALE | Review the recipient and try again. | |
| EMAIL_INVALID | Send a valid address in the email field. | |
| FORBIDDEN | Use a key with the scope the operation lists, or ask an org admin. | |
| INVALID_API_KEY | Create a new key in the console and update PASSBOOK_KEY. | |
| LINK_NOT_FOUND | Request a fresh link, for example with POST /api/v1/bundles/{id}/rotate-link. | |
| MISSING_SCOPE | Create a key with the scope the operation lists under security. | |
| NO_RECIPIENT | Set the holder's email with PATCH /api/v1/passes/{id}, then send again. | |
| ORG_REQUIRED | Send orgId with the request, or use a key scoped to one organization. | |
| PASS_NOT_FOUND | Check the id with GET /api/v1/passes and the key's mode. | |
| RATE_LIMITED | Wait for Retry-After seconds, then retry. Back off on repeats. | |
| RECIPIENT_NOT_HOLDER | Send to the holder's email, or change it with PATCH /api/v1/passes/{id}. | |
| UNAUTHENTICATED | Send Authorization: Bearer $PASSBOOK_KEY. | |
| VALIDATION | Fix each field in issues and resend. |
GET
/api/v1/bundles/{id}passes:readSDK pb.bundles.retrieve
Path
idstring · max 64Required
Returns
200
Errors
| Code | Status | Fix |
|---|---|---|
| BUNDLE_DUPLICATE_PASS | List each pass id once. | |
| BUNDLE_EMPTY | Add at least one pass to the bundle. | |
| BUNDLE_MODE_MISMATCH | Put only passes of the bundle's mode in it. | |
| BUNDLE_NOT_FOUND | Check the id with GET /api/v1/bundles. | |
| BUNDLE_TOO_MANY | Send at most 10 passes per bundle. | |
| DELIVERY_STALE | Review the recipient and try again. | |
| EMAIL_INVALID | Send a valid address in the email field. | |
| FORBIDDEN | Use a key with the scope the operation lists, or ask an org admin. | |
| INVALID_API_KEY | Create a new key in the console and update PASSBOOK_KEY. | |
| LINK_NOT_FOUND | Request a fresh link, for example with POST /api/v1/bundles/{id}/rotate-link. | |
| MISSING_SCOPE | Create a key with the scope the operation lists under security. | |
| NOT_FOUND | Check the id, and that the key's mode (test or live) matches the object. | |
| NO_RECIPIENT | Set the holder's email with PATCH /api/v1/passes/{id}, then send again. | |
| ORG_REQUIRED | Send orgId with the request, or use a key scoped to one organization. | |
| PASS_NOT_FOUND | Check the id with GET /api/v1/passes and the key's mode. | |
| RATE_LIMITED | Wait for Retry-After seconds, then retry. Back off on repeats. | |
| RECIPIENT_NOT_HOLDER | Send to the holder's email, or change it with PATCH /api/v1/passes/{id}. | |
| UNAUTHENTICATED | Send Authorization: Bearer $PASSBOOK_KEY. | |
| VALIDATION | Fix each field in issues and resend. |
DEL
/api/v1/bundles/{id}passes:writeSDK pb.bundles.delete
Path
idstring · max 64Required
Returns
200
Errors
| Code | Status | Fix |
|---|---|---|
| BUNDLE_DUPLICATE_PASS | List each pass id once. | |
| BUNDLE_EMPTY | Add at least one pass to the bundle. | |
| BUNDLE_MODE_MISMATCH | Put only passes of the bundle's mode in it. | |
| BUNDLE_NOT_FOUND | Check the id with GET /api/v1/bundles. | |
| BUNDLE_TOO_MANY | Send at most 10 passes per bundle. | |
| DELIVERY_STALE | Review the recipient and try again. | |
| EMAIL_INVALID | Send a valid address in the email field. | |
| FORBIDDEN | Use a key with the scope the operation lists, or ask an org admin. | |
| INVALID_API_KEY | Create a new key in the console and update PASSBOOK_KEY. | |
| LINK_NOT_FOUND | Request a fresh link, for example with POST /api/v1/bundles/{id}/rotate-link. | |
| MISSING_SCOPE | Create a key with the scope the operation lists under security. | |
| NOT_FOUND | Check the id, and that the key's mode (test or live) matches the object. | |
| NO_RECIPIENT | Set the holder's email with PATCH /api/v1/passes/{id}, then send again. | |
| ORG_REQUIRED | Send orgId with the request, or use a key scoped to one organization. | |
| PASS_NOT_FOUND | Check the id with GET /api/v1/passes and the key's mode. | |
| RATE_LIMITED | Wait for Retry-After seconds, then retry. Back off on repeats. | |
| RECIPIENT_NOT_HOLDER | Send to the holder's email, or change it with PATCH /api/v1/passes/{id}. | |
| UNAUTHENTICATED | Send Authorization: Bearer $PASSBOOK_KEY. | |
| VALIDATION | Fix each field in issues and resend. |
POST
/api/v1/bundles/{id}/send-emailpasses: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
| Code | Status | Fix |
|---|---|---|
| BUNDLE_DUPLICATE_PASS | List each pass id once. | |
| BUNDLE_EMPTY | Add at least one pass to the bundle. | |
| BUNDLE_MODE_MISMATCH | Put only passes of the bundle's mode in it. | |
| BUNDLE_NOT_FOUND | Check the id with GET /api/v1/bundles. | |
| BUNDLE_TOO_MANY | Send at most 10 passes per bundle. | |
| DELIVERY_STALE | Review the recipient and try again. | |
| EMAIL_INVALID | Send a valid address in the email field. | |
| FORBIDDEN | Use a key with the scope the operation lists, or ask an org admin. | |
| INVALID_API_KEY | Create a new key in the console and update PASSBOOK_KEY. | |
| LINK_NOT_FOUND | Request a fresh link, for example with POST /api/v1/bundles/{id}/rotate-link. | |
| MISSING_SCOPE | Create a key with the scope the operation lists under security. | |
| NOT_FOUND | Check the id, and that the key's mode (test or live) matches the object. | |
| NO_RECIPIENT | Set the holder's email with PATCH /api/v1/passes/{id}, then send again. | |
| ORG_REQUIRED | Send orgId with the request, or use a key scoped to one organization. | |
| PASS_NOT_FOUND | Check the id with GET /api/v1/passes and the key's mode. | |
| RATE_LIMITED | Wait for Retry-After seconds, then retry. Back off on repeats. | |
| RECIPIENT_NOT_HOLDER | Send to the holder's email, or change it with PATCH /api/v1/passes/{id}. | |
| UNAUTHENTICATED | Send Authorization: Bearer $PASSBOOK_KEY. | |
| VALIDATION | Fix each field in issues and resend. |
POST
/api/v1/bundles/{id}/rotate-linkpasses:writeSDK pb.bundles.rotateLink
Path
idstring · max 64Required
Returns
200
Errors
| Code | Status | Fix |
|---|---|---|
| BUNDLE_DUPLICATE_PASS | List each pass id once. | |
| BUNDLE_EMPTY | Add at least one pass to the bundle. | |
| BUNDLE_MODE_MISMATCH | Put only passes of the bundle's mode in it. | |
| BUNDLE_NOT_FOUND | Check the id with GET /api/v1/bundles. | |
| BUNDLE_TOO_MANY | Send at most 10 passes per bundle. | |
| DELIVERY_STALE | Review the recipient and try again. | |
| EMAIL_INVALID | Send a valid address in the email field. | |
| FORBIDDEN | Use a key with the scope the operation lists, or ask an org admin. | |
| INVALID_API_KEY | Create a new key in the console and update PASSBOOK_KEY. | |
| LINK_NOT_FOUND | Request a fresh link, for example with POST /api/v1/bundles/{id}/rotate-link. | |
| MISSING_SCOPE | Create a key with the scope the operation lists under security. | |
| NOT_FOUND | Check the id, and that the key's mode (test or live) matches the object. | |
| NO_RECIPIENT | Set the holder's email with PATCH /api/v1/passes/{id}, then send again. | |
| ORG_REQUIRED | Send orgId with the request, or use a key scoped to one organization. | |
| PASS_NOT_FOUND | Check the id with GET /api/v1/passes and the key's mode. | |
| RATE_LIMITED | Wait for Retry-After seconds, then retry. Back off on repeats. | |
| RECIPIENT_NOT_HOLDER | Send to the holder's email, or change it with PATCH /api/v1/passes/{id}. | |
| UNAUTHENTICATED | Send Authorization: Bearer $PASSBOOK_KEY. | |
| VALIDATION | Fix each field in issues and resend. |