Passes
43 operations. Send Authorization: Bearer $PASSBOOK_KEY. Markdown
/api/v1/passesLists passes, newest first. Filter by template, status, holder email or externalId; page with cursor.
Query
Returns
200 PassPage
Errors
| Code | Status | Fix |
|---|---|---|
| ASSET_DIMENSIONS | Resize the image to the size named in issues and upload it again. | |
| ASSET_NOT_FOUND | Check the image name or id and that it belongs to this organization. | |
| ASSET_NOT_PNG | Re-export the image as a standard RGB or RGBA PNG and upload it again. | |
| ASSET_SIZE | Compress the image below 1 MB and upload it again. | |
| ASSET_SLOT | Use a slot name from the pass type's image slots in the request path. | |
| BULK_RUN_ACTIVE | Wait for the running job to finish, then start the new one. | |
| BUNDLE_TOO_LARGE | Split the passes across smaller bundles. | |
| CONNECTION_ORG | Use a connection id from your own organization's GET /api/v1/connections. | |
| CONNECTION_TRANSFER_PENDING | Wait for the transfer to finish, then send the request again. | |
| CREATE_STALE | Look the pass up by externalId with GET /api/v1/passes and update it instead of creating it again. | |
| CREDENTIAL_REF_KEYSET_CONFIG_UNAVAILABLE | Retry with backoff; if it persists, send the requestId to support. | |
| CREDENTIAL_REF_KEYSET_UNAVAILABLE | Retry with backoff; if it persists, send the requestId to support. | |
| DELIVERY_STALE | Review the recipient and try again. | |
| DEVICE_TOKEN_UNAVAILABLE | Retry the request; if it persists, send the requestId to support. | |
| EMAIL_INVALID | Send a valid address in the email field. | |
| EXTERNAL_ID_TAKEN | Send a new externalId, or PATCH the existing pass. | |
| FORBIDDEN | Use a key with the scope the operation lists, or ask an org admin. | |
| IDEMPOTENCY_IN_PROGRESS | Wait a moment and resend the identical request. | |
| IDEMPOTENCY_KEY_INVALID | Send a unique string of 1 to 200 characters, such as a UUID. | |
| IDEMPOTENCY_KEY_REUSED | Use a new key for a new request; resend the identical request to replay. | |
| IF_MATCH_INVALID | Send the version from the last GET, for example If-Match: 3. | |
| IMPORT_BUSY | Wait for it to finish with GET /api/v1/pass-imports/{id}, then retry. | |
| IMPORT_COLUMN_MISSING | Add the column to the file, or change the mapping, then check again. | |
| IMPORT_EXPIRED | Upload the file again with POST /api/v1/pass-imports. | |
| IMPORT_FILE_GONE | Upload it again. | |
| IMPORT_HAS_ERRORS | Fix the rows listed in GET /api/v1/pass-imports/{id}/errors.csv, or skip them, then commit again. | |
| IMPORT_HEADER_TOO_LONG | Shorten the header and upload the file again. | |
| IMPORT_ID_TAKEN | Check the import again with POST /api/v1/pass-imports/{id}/check, then commit. | |
| IMPORT_NOT_FOUND | Check the id with GET /api/v1/pass-imports. | |
| IMPORT_PASS_CHANGED | Remove the pass on its own with POST /api/v1/passes/{id}/remove. | |
| IMPORT_PLAN_INVALID | Fix the mapping entries named in issues and check again. | |
| IMPORT_ROW_UNRESERVED | Retry the commit; if it persists, send the requestId to support. | |
| IMPORT_STATE | Check its state with GET /api/v1/pass-imports/{id} and call the action that state allows. | |
| INVALID_API_KEY | Create a new key in the console and update PASSBOOK_KEY. | |
| INVALID_INPUT | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| JOIN_NOT_READY | Publish the template, then enable the link with PUT /api/v1/join-links/{templateId}. | |
| MATCH_NEEDS_TEMPLATE | Send orgId and templateId with the input filter. | |
| MEMBER_PHOTO_CHANGED | Fetch the pass with GET /api/v1/passes/{id} and save the photo again. | |
| MEMBER_PHOTO_DIMENSIONS | Crop the photo to a 270 by 270 pixel square and upload it again. | |
| MEMBER_PHOTO_ENCODING | Send the photo as a PNG or JPEG file. | |
| MEMBER_PHOTO_NOT_FOUND | Add one with PUT /api/v1/passes/{id}/member-photo. | |
| MEMBER_PHOTO_STYLE | Use a template of that style, or remove the strip image. | |
| MISSING_SCOPE | Create a key with the scope the operation lists under security. | |
| MODE_MISMATCH | Use objects and a key of the same mode. | |
| NEW_CODE_UNSUPPORTED | Reissue the pass with POST /api/v1/passes/bulk-reissue instead of requesting a new code. | |
| NO_RECIPIENT | Set the holder's email with PATCH /api/v1/passes/{id}, then send again. | |
| ORG_ACCESS_CHANGED | Check access with GET /api/v1/api-keys/me, then send the request again. | |
| ORG_FORBIDDEN | Use a key scoped to this organization, or a platform key for platform-wide lists. | |
| ORG_MIXED | Send ids from one organization per request. | |
| ORG_NOT_FOUND | Check orgId with GET /api/v1/orgs. | |
| ORG_REQUIRED | Send orgId with the request, or use a key scoped to one organization. | |
| PASS_CONFLICT | Fetch the pass with GET /api/v1/passes/{id} and send the request again. | |
| PASS_CONNECTION_MISMATCH | Link it with PUT /api/v1/passes/{id}/connection, then send the request again. | |
| PASS_FILE_MISSING | Rebuild it with POST /api/v1/passes/{id}/refresh. | |
| PASS_INPUT_INVALID | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| PASS_INVALID | Fix the problems named in issues in the template or inputs. | |
| PASS_NOT_ACTIVE | Restore or unvoid the pass first, or use an active one. | |
| PASS_NOT_FOUND | Check the id with GET /api/v1/passes and the key's mode. | |
| PASS_REF_TAKEN | Use a different ref, or update the existing pass. | |
| PASS_REISSUE_REQUIRED | Reissue it with POST /api/v1/passes/bulk-reissue. | |
| PASS_REMOVED | Restore it with POST /api/v1/passes/{id}/restore, then send the request again. | |
| PASS_TRANSFER_NOT_FOUND | Check the transfer id. | |
| PASS_TRANSFER_PENDING | Try again shortly. | |
| 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}. | |
| SCAN_EVENT_NOT_FOUND | Check the event id with GET /api/v1/scan/events. | |
| SCAN_WINDOW_INVALID | Set an end after the start, or fix the template's dates. | |
| SERIAL_TAKEN | Send a different serial, or leave it out to have one generated. | |
| SESSION_REQUIRED | Do it in the console, or sign in as the account that started it. | |
| STAMPS_ABOVE_MAX | Raise the template's stamp maximum, or redeem stamps first. | |
| STAMPS_CARD_FULL | Redeem the reward, then add stamps. | |
| STAMPS_NONE | Use a template with stamps. | |
| STAMPS_NO_REWARD | Add stamps until the card is full, then redeem. | |
| TEMPLATE_NOT_FOUND | Check the id with GET /api/v1/templates and the key's mode. | |
| TEMPLATE_RELEASE_CONFLICT | Send the request again to use the current release. | |
| TEMPLATE_RELEASE_REQUIRED | Approve a release with POST /api/v1/templates/{id}/candidates/{candidateId}/approve. | |
| TERM_MANAGED | Change the term in the connected system. | |
| TERM_NONE | Renew only passes whose template defines a term. | |
| TERM_NOT_STARTED | Renew after the term starts. | |
| UNAUTHENTICATED | Send Authorization: Bearer $PASSBOOK_KEY. | |
| VALIDATION | Fix each field in issues and resend. | |
| VERSION_NOT_FOUND | Check the version with GET /api/v1/passes/{id}. | |
| VERSION_PURGED | Request a newer version. | |
| WORKFLOW_START | Send the request again. |
/api/v1/passesCreates 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.
Headers
1 to 200 characters. A retry with the same key and body returns the first result.
Body
The template's fields. GET /templates/{id}/input-schema returns the schema.
Your own key for the pass, any time. Filter with GET /passes?externalId=. Unique per org and mode only if the template says so.
Sets the Wallet serial. Honored only on the organization's own signing identity; the platform identity picks its own.
Binds the pass to a connection. Send with externalRef.
The upstream record id, for passes created by a connection. Send with connectionId.
Returns
201 PassDetail
Errors
| Code | Status | Fix |
|---|---|---|
| ASSET_DIMENSIONS | Resize the image to the size named in issues and upload it again. | |
| ASSET_NOT_FOUND | Check the image name or id and that it belongs to this organization. | |
| ASSET_NOT_PNG | Re-export the image as a standard RGB or RGBA PNG and upload it again. | |
| ASSET_SIZE | Compress the image below 1 MB and upload it again. | |
| ASSET_SLOT | Use a slot name from the pass type's image slots in the request path. | |
| BULK_RUN_ACTIVE | Wait for the running job to finish, then start the new one. | |
| BUNDLE_TOO_LARGE | Split the passes across smaller bundles. | |
| CONNECTION_ORG | Use a connection id from your own organization's GET /api/v1/connections. | |
| CONNECTION_TRANSFER_PENDING | Wait for the transfer to finish, then send the request again. | |
| CREATE_STALE | Look the pass up by externalId with GET /api/v1/passes and update it instead of creating it again. | |
| CREDENTIAL_REF_KEYSET_CONFIG_UNAVAILABLE | Retry with backoff; if it persists, send the requestId to support. | |
| CREDENTIAL_REF_KEYSET_UNAVAILABLE | Retry with backoff; if it persists, send the requestId to support. | |
| DELIVERY_STALE | Review the recipient and try again. | |
| DEVICE_TOKEN_UNAVAILABLE | Retry the request; if it persists, send the requestId to support. | |
| EMAIL_INVALID | Send a valid address in the email field. | |
| EXTERNAL_ID_TAKEN | Send a new externalId, or PATCH the existing pass. | |
| FORBIDDEN | Use a key with the scope the operation lists, or ask an org admin. | |
| IDEMPOTENCY_IN_PROGRESS | Wait a moment and resend the identical request. | |
| IDEMPOTENCY_KEY_INVALID | Send a unique string of 1 to 200 characters, such as a UUID. | |
| IDEMPOTENCY_KEY_REUSED | Use a new key for a new request; resend the identical request to replay. | |
| IF_MATCH_INVALID | Send the version from the last GET, for example If-Match: 3. | |
| IMPORT_BUSY | Wait for it to finish with GET /api/v1/pass-imports/{id}, then retry. | |
| IMPORT_COLUMN_MISSING | Add the column to the file, or change the mapping, then check again. | |
| IMPORT_EXPIRED | Upload the file again with POST /api/v1/pass-imports. | |
| IMPORT_FILE_GONE | Upload it again. | |
| IMPORT_HAS_ERRORS | Fix the rows listed in GET /api/v1/pass-imports/{id}/errors.csv, or skip them, then commit again. | |
| IMPORT_HEADER_TOO_LONG | Shorten the header and upload the file again. | |
| IMPORT_ID_TAKEN | Check the import again with POST /api/v1/pass-imports/{id}/check, then commit. | |
| IMPORT_NOT_FOUND | Check the id with GET /api/v1/pass-imports. | |
| IMPORT_PASS_CHANGED | Remove the pass on its own with POST /api/v1/passes/{id}/remove. | |
| IMPORT_PLAN_INVALID | Fix the mapping entries named in issues and check again. | |
| IMPORT_ROW_UNRESERVED | Retry the commit; if it persists, send the requestId to support. | |
| IMPORT_STATE | Check its state with GET /api/v1/pass-imports/{id} and call the action that state allows. | |
| INVALID_API_KEY | Create a new key in the console and update PASSBOOK_KEY. | |
| INVALID_INPUT | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| JOIN_NOT_READY | Publish the template, then enable the link with PUT /api/v1/join-links/{templateId}. | |
| MATCH_NEEDS_TEMPLATE | Send orgId and templateId with the input filter. | |
| MEMBER_PHOTO_CHANGED | Fetch the pass with GET /api/v1/passes/{id} and save the photo again. | |
| MEMBER_PHOTO_DIMENSIONS | Crop the photo to a 270 by 270 pixel square and upload it again. | |
| MEMBER_PHOTO_ENCODING | Send the photo as a PNG or JPEG file. | |
| MEMBER_PHOTO_NOT_FOUND | Add one with PUT /api/v1/passes/{id}/member-photo. | |
| MEMBER_PHOTO_STYLE | Use a template of that style, or remove the strip image. | |
| MISSING_SCOPE | Create a key with the scope the operation lists under security. | |
| MODE_MISMATCH | Use objects and a key of the same mode. | |
| NEW_CODE_UNSUPPORTED | Reissue the pass with POST /api/v1/passes/bulk-reissue instead of requesting a new code. | |
| NO_RECIPIENT | Set the holder's email with PATCH /api/v1/passes/{id}, then send again. | |
| ORG_ACCESS_CHANGED | Check access with GET /api/v1/api-keys/me, then send the request again. | |
| ORG_FORBIDDEN | Use a key scoped to this organization, or a platform key for platform-wide lists. | |
| ORG_MIXED | Send ids from one organization per request. | |
| ORG_NOT_FOUND | Check orgId with GET /api/v1/orgs. | |
| ORG_REQUIRED | Send orgId with the request, or use a key scoped to one organization. | |
| PASS_CONFLICT | Fetch the pass with GET /api/v1/passes/{id} and send the request again. | |
| PASS_CONNECTION_MISMATCH | Link it with PUT /api/v1/passes/{id}/connection, then send the request again. | |
| PASS_FILE_MISSING | Rebuild it with POST /api/v1/passes/{id}/refresh. | |
| PASS_INPUT_INVALID | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| PASS_INVALID | Fix the problems named in issues in the template or inputs. | |
| PASS_NOT_ACTIVE | Restore or unvoid the pass first, or use an active one. | |
| PASS_NOT_FOUND | Check the id with GET /api/v1/passes and the key's mode. | |
| PASS_REF_TAKEN | Use a different ref, or update the existing pass. | |
| PASS_REISSUE_REQUIRED | Reissue it with POST /api/v1/passes/bulk-reissue. | |
| PASS_REMOVED | Restore it with POST /api/v1/passes/{id}/restore, then send the request again. | |
| PASS_TRANSFER_NOT_FOUND | Check the transfer id. | |
| PASS_TRANSFER_PENDING | Try again shortly. | |
| 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}. | |
| SCAN_EVENT_NOT_FOUND | Check the event id with GET /api/v1/scan/events. | |
| SCAN_WINDOW_INVALID | Set an end after the start, or fix the template's dates. | |
| SERIAL_TAKEN | Send a different serial, or leave it out to have one generated. | |
| SESSION_REQUIRED | Do it in the console, or sign in as the account that started it. | |
| STAMPS_ABOVE_MAX | Raise the template's stamp maximum, or redeem stamps first. | |
| STAMPS_CARD_FULL | Redeem the reward, then add stamps. | |
| STAMPS_NONE | Use a template with stamps. | |
| STAMPS_NO_REWARD | Add stamps until the card is full, then redeem. | |
| TEMPLATE_NOT_FOUND | Check the id with GET /api/v1/templates and the key's mode. | |
| TEMPLATE_RELEASE_CONFLICT | Send the request again to use the current release. | |
| TEMPLATE_RELEASE_REQUIRED | Approve a release with POST /api/v1/templates/{id}/candidates/{candidateId}/approve. | |
| TERM_MANAGED | Change the term in the connected system. | |
| TERM_NONE | Renew only passes whose template defines a term. | |
| TERM_NOT_STARTED | Renew after the term starts. | |
| UNAUTHENTICATED | Send Authorization: Bearer $PASSBOOK_KEY. | |
| VALIDATION | Fix each field in issues and resend. | |
| VERSION_NOT_FOUND | Check the version with GET /api/v1/passes/{id}. | |
| VERSION_PURGED | Request a newer version. | |
| WORKFLOW_START | Send the request again. |
/api/v1/passes/{id}One pass with its fields, links and channels.
Path
Returns
200 PassDetail
Errors
| Code | Status | Fix |
|---|---|---|
| ASSET_DIMENSIONS | Resize the image to the size named in issues and upload it again. | |
| ASSET_NOT_FOUND | Check the image name or id and that it belongs to this organization. | |
| ASSET_NOT_PNG | Re-export the image as a standard RGB or RGBA PNG and upload it again. | |
| ASSET_SIZE | Compress the image below 1 MB and upload it again. | |
| ASSET_SLOT | Use a slot name from the pass type's image slots in the request path. | |
| BULK_RUN_ACTIVE | Wait for the running job to finish, then start the new one. | |
| BUNDLE_TOO_LARGE | Split the passes across smaller bundles. | |
| CONNECTION_ORG | Use a connection id from your own organization's GET /api/v1/connections. | |
| CONNECTION_TRANSFER_PENDING | Wait for the transfer to finish, then send the request again. | |
| CREATE_STALE | Look the pass up by externalId with GET /api/v1/passes and update it instead of creating it again. | |
| CREDENTIAL_REF_KEYSET_CONFIG_UNAVAILABLE | Retry with backoff; if it persists, send the requestId to support. | |
| CREDENTIAL_REF_KEYSET_UNAVAILABLE | Retry with backoff; if it persists, send the requestId to support. | |
| DELIVERY_STALE | Review the recipient and try again. | |
| DEVICE_TOKEN_UNAVAILABLE | Retry the request; if it persists, send the requestId to support. | |
| EMAIL_INVALID | Send a valid address in the email field. | |
| EXTERNAL_ID_TAKEN | Send a new externalId, or PATCH the existing pass. | |
| FORBIDDEN | Use a key with the scope the operation lists, or ask an org admin. | |
| IDEMPOTENCY_IN_PROGRESS | Wait a moment and resend the identical request. | |
| IDEMPOTENCY_KEY_INVALID | Send a unique string of 1 to 200 characters, such as a UUID. | |
| IDEMPOTENCY_KEY_REUSED | Use a new key for a new request; resend the identical request to replay. | |
| IF_MATCH_INVALID | Send the version from the last GET, for example If-Match: 3. | |
| IMPORT_BUSY | Wait for it to finish with GET /api/v1/pass-imports/{id}, then retry. | |
| IMPORT_COLUMN_MISSING | Add the column to the file, or change the mapping, then check again. | |
| IMPORT_EXPIRED | Upload the file again with POST /api/v1/pass-imports. | |
| IMPORT_FILE_GONE | Upload it again. | |
| IMPORT_HAS_ERRORS | Fix the rows listed in GET /api/v1/pass-imports/{id}/errors.csv, or skip them, then commit again. | |
| IMPORT_HEADER_TOO_LONG | Shorten the header and upload the file again. | |
| IMPORT_ID_TAKEN | Check the import again with POST /api/v1/pass-imports/{id}/check, then commit. | |
| IMPORT_NOT_FOUND | Check the id with GET /api/v1/pass-imports. | |
| IMPORT_PASS_CHANGED | Remove the pass on its own with POST /api/v1/passes/{id}/remove. | |
| IMPORT_PLAN_INVALID | Fix the mapping entries named in issues and check again. | |
| IMPORT_ROW_UNRESERVED | Retry the commit; if it persists, send the requestId to support. | |
| IMPORT_STATE | Check its state with GET /api/v1/pass-imports/{id} and call the action that state allows. | |
| INVALID_API_KEY | Create a new key in the console and update PASSBOOK_KEY. | |
| INVALID_INPUT | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| JOIN_NOT_READY | Publish the template, then enable the link with PUT /api/v1/join-links/{templateId}. | |
| MATCH_NEEDS_TEMPLATE | Send orgId and templateId with the input filter. | |
| MEMBER_PHOTO_CHANGED | Fetch the pass with GET /api/v1/passes/{id} and save the photo again. | |
| MEMBER_PHOTO_DIMENSIONS | Crop the photo to a 270 by 270 pixel square and upload it again. | |
| MEMBER_PHOTO_ENCODING | Send the photo as a PNG or JPEG file. | |
| MEMBER_PHOTO_NOT_FOUND | Add one with PUT /api/v1/passes/{id}/member-photo. | |
| MEMBER_PHOTO_STYLE | Use a template of that style, or remove the strip image. | |
| MISSING_SCOPE | Create a key with the scope the operation lists under security. | |
| MODE_MISMATCH | Use objects and a key of the same mode. | |
| NEW_CODE_UNSUPPORTED | Reissue the pass with POST /api/v1/passes/bulk-reissue instead of requesting a new code. | |
| 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_ACCESS_CHANGED | Check access with GET /api/v1/api-keys/me, then send the request again. | |
| ORG_FORBIDDEN | Use a key scoped to this organization, or a platform key for platform-wide lists. | |
| ORG_MIXED | Send ids from one organization per request. | |
| ORG_NOT_FOUND | Check orgId with GET /api/v1/orgs. | |
| ORG_REQUIRED | Send orgId with the request, or use a key scoped to one organization. | |
| PASS_CONFLICT | Fetch the pass with GET /api/v1/passes/{id} and send the request again. | |
| PASS_CONNECTION_MISMATCH | Link it with PUT /api/v1/passes/{id}/connection, then send the request again. | |
| PASS_FILE_MISSING | Rebuild it with POST /api/v1/passes/{id}/refresh. | |
| PASS_INPUT_INVALID | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| PASS_INVALID | Fix the problems named in issues in the template or inputs. | |
| PASS_NOT_ACTIVE | Restore or unvoid the pass first, or use an active one. | |
| PASS_NOT_FOUND | Check the id with GET /api/v1/passes and the key's mode. | |
| PASS_REF_TAKEN | Use a different ref, or update the existing pass. | |
| PASS_REISSUE_REQUIRED | Reissue it with POST /api/v1/passes/bulk-reissue. | |
| PASS_REMOVED | Restore it with POST /api/v1/passes/{id}/restore, then send the request again. | |
| PASS_TRANSFER_NOT_FOUND | Check the transfer id. | |
| PASS_TRANSFER_PENDING | Try again shortly. | |
| 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}. | |
| SCAN_EVENT_NOT_FOUND | Check the event id with GET /api/v1/scan/events. | |
| SCAN_WINDOW_INVALID | Set an end after the start, or fix the template's dates. | |
| SERIAL_TAKEN | Send a different serial, or leave it out to have one generated. | |
| SESSION_REQUIRED | Do it in the console, or sign in as the account that started it. | |
| STAMPS_ABOVE_MAX | Raise the template's stamp maximum, or redeem stamps first. | |
| STAMPS_CARD_FULL | Redeem the reward, then add stamps. | |
| STAMPS_NONE | Use a template with stamps. | |
| STAMPS_NO_REWARD | Add stamps until the card is full, then redeem. | |
| TEMPLATE_NOT_FOUND | Check the id with GET /api/v1/templates and the key's mode. | |
| TEMPLATE_RELEASE_CONFLICT | Send the request again to use the current release. | |
| TEMPLATE_RELEASE_REQUIRED | Approve a release with POST /api/v1/templates/{id}/candidates/{candidateId}/approve. | |
| TERM_MANAGED | Change the term in the connected system. | |
| TERM_NONE | Renew only passes whose template defines a term. | |
| TERM_NOT_STARTED | Renew after the term starts. | |
| UNAUTHENTICATED | Send Authorization: Bearer $PASSBOOK_KEY. | |
| VALIDATION | Fix each field in issues and resend. | |
| VERSION_NOT_FOUND | Check the version with GET /api/v1/passes/{id}. | |
| VERSION_PURGED | Request a newer version. | |
| WORKFLOW_START | Send the request again. |
/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.
Path
Body
Returns
200 PassDetail
Errors
| Code | Status | Fix |
|---|---|---|
| ASSET_DIMENSIONS | Resize the image to the size named in issues and upload it again. | |
| ASSET_NOT_FOUND | Check the image name or id and that it belongs to this organization. | |
| ASSET_NOT_PNG | Re-export the image as a standard RGB or RGBA PNG and upload it again. | |
| ASSET_SIZE | Compress the image below 1 MB and upload it again. | |
| ASSET_SLOT | Use a slot name from the pass type's image slots in the request path. | |
| BULK_RUN_ACTIVE | Wait for the running job to finish, then start the new one. | |
| BUNDLE_TOO_LARGE | Split the passes across smaller bundles. | |
| CONNECTION_ORG | Use a connection id from your own organization's GET /api/v1/connections. | |
| CONNECTION_TRANSFER_PENDING | Wait for the transfer to finish, then send the request again. | |
| CREATE_STALE | Look the pass up by externalId with GET /api/v1/passes and update it instead of creating it again. | |
| CREDENTIAL_REF_KEYSET_CONFIG_UNAVAILABLE | Retry with backoff; if it persists, send the requestId to support. | |
| CREDENTIAL_REF_KEYSET_UNAVAILABLE | Retry with backoff; if it persists, send the requestId to support. | |
| DELIVERY_STALE | Review the recipient and try again. | |
| DEVICE_TOKEN_UNAVAILABLE | Retry the request; if it persists, send the requestId to support. | |
| EMAIL_INVALID | Send a valid address in the email field. | |
| EXTERNAL_ID_TAKEN | Send a new externalId, or PATCH the existing pass. | |
| FORBIDDEN | Use a key with the scope the operation lists, or ask an org admin. | |
| IDEMPOTENCY_IN_PROGRESS | Wait a moment and resend the identical request. | |
| IDEMPOTENCY_KEY_INVALID | Send a unique string of 1 to 200 characters, such as a UUID. | |
| IDEMPOTENCY_KEY_REUSED | Use a new key for a new request; resend the identical request to replay. | |
| IF_MATCH_INVALID | Send the version from the last GET, for example If-Match: 3. | |
| IMPORT_BUSY | Wait for it to finish with GET /api/v1/pass-imports/{id}, then retry. | |
| IMPORT_COLUMN_MISSING | Add the column to the file, or change the mapping, then check again. | |
| IMPORT_EXPIRED | Upload the file again with POST /api/v1/pass-imports. | |
| IMPORT_FILE_GONE | Upload it again. | |
| IMPORT_HAS_ERRORS | Fix the rows listed in GET /api/v1/pass-imports/{id}/errors.csv, or skip them, then commit again. | |
| IMPORT_HEADER_TOO_LONG | Shorten the header and upload the file again. | |
| IMPORT_ID_TAKEN | Check the import again with POST /api/v1/pass-imports/{id}/check, then commit. | |
| IMPORT_NOT_FOUND | Check the id with GET /api/v1/pass-imports. | |
| IMPORT_PASS_CHANGED | Remove the pass on its own with POST /api/v1/passes/{id}/remove. | |
| IMPORT_PLAN_INVALID | Fix the mapping entries named in issues and check again. | |
| IMPORT_ROW_UNRESERVED | Retry the commit; if it persists, send the requestId to support. | |
| IMPORT_STATE | Check its state with GET /api/v1/pass-imports/{id} and call the action that state allows. | |
| INVALID_API_KEY | Create a new key in the console and update PASSBOOK_KEY. | |
| INVALID_INPUT | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| JOIN_NOT_READY | Publish the template, then enable the link with PUT /api/v1/join-links/{templateId}. | |
| MATCH_NEEDS_TEMPLATE | Send orgId and templateId with the input filter. | |
| MEMBER_PHOTO_CHANGED | Fetch the pass with GET /api/v1/passes/{id} and save the photo again. | |
| MEMBER_PHOTO_DIMENSIONS | Crop the photo to a 270 by 270 pixel square and upload it again. | |
| MEMBER_PHOTO_ENCODING | Send the photo as a PNG or JPEG file. | |
| MEMBER_PHOTO_NOT_FOUND | Add one with PUT /api/v1/passes/{id}/member-photo. | |
| MEMBER_PHOTO_STYLE | Use a template of that style, or remove the strip image. | |
| MISSING_SCOPE | Create a key with the scope the operation lists under security. | |
| MODE_MISMATCH | Use objects and a key of the same mode. | |
| NEW_CODE_UNSUPPORTED | Reissue the pass with POST /api/v1/passes/bulk-reissue instead of requesting a new code. | |
| 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_ACCESS_CHANGED | Check access with GET /api/v1/api-keys/me, then send the request again. | |
| ORG_FORBIDDEN | Use a key scoped to this organization, or a platform key for platform-wide lists. | |
| ORG_MIXED | Send ids from one organization per request. | |
| ORG_NOT_FOUND | Check orgId with GET /api/v1/orgs. | |
| ORG_REQUIRED | Send orgId with the request, or use a key scoped to one organization. | |
| PASS_CONFLICT | Fetch the pass with GET /api/v1/passes/{id} and send the request again. | |
| PASS_CONNECTION_MISMATCH | Link it with PUT /api/v1/passes/{id}/connection, then send the request again. | |
| PASS_FILE_MISSING | Rebuild it with POST /api/v1/passes/{id}/refresh. | |
| PASS_INPUT_INVALID | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| PASS_INVALID | Fix the problems named in issues in the template or inputs. | |
| PASS_NOT_ACTIVE | Restore or unvoid the pass first, or use an active one. | |
| PASS_NOT_FOUND | Check the id with GET /api/v1/passes and the key's mode. | |
| PASS_REF_TAKEN | Use a different ref, or update the existing pass. | |
| PASS_REISSUE_REQUIRED | Reissue it with POST /api/v1/passes/bulk-reissue. | |
| PASS_REMOVED | Restore it with POST /api/v1/passes/{id}/restore, then send the request again. | |
| PASS_TRANSFER_NOT_FOUND | Check the transfer id. | |
| PASS_TRANSFER_PENDING | Try again shortly. | |
| 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}. | |
| SCAN_EVENT_NOT_FOUND | Check the event id with GET /api/v1/scan/events. | |
| SCAN_WINDOW_INVALID | Set an end after the start, or fix the template's dates. | |
| SERIAL_TAKEN | Send a different serial, or leave it out to have one generated. | |
| SESSION_REQUIRED | Do it in the console, or sign in as the account that started it. | |
| STAMPS_ABOVE_MAX | Raise the template's stamp maximum, or redeem stamps first. | |
| STAMPS_CARD_FULL | Redeem the reward, then add stamps. | |
| STAMPS_NONE | Use a template with stamps. | |
| STAMPS_NO_REWARD | Add stamps until the card is full, then redeem. | |
| TEMPLATE_NOT_FOUND | Check the id with GET /api/v1/templates and the key's mode. | |
| TEMPLATE_RELEASE_CONFLICT | Send the request again to use the current release. | |
| TEMPLATE_RELEASE_REQUIRED | Approve a release with POST /api/v1/templates/{id}/candidates/{candidateId}/approve. | |
| TERM_MANAGED | Change the term in the connected system. | |
| TERM_NONE | Renew only passes whose template defines a term. | |
| TERM_NOT_STARTED | Renew after the term starts. | |
| UNAUTHENTICATED | Send Authorization: Bearer $PASSBOOK_KEY. | |
| VALIDATION | Fix each field in issues and resend. | |
| VERSION_CONFLICT | GET the pass, apply your change to it, and resend with the new version. | |
| VERSION_NOT_FOUND | Check the version with GET /api/v1/passes/{id}. | |
| VERSION_PURGED | Request a newer version. | |
| WORKFLOW_START | Send the request again. |
/api/v1/passes/{id}Deletes the pass record. To take a pass out of Wallet and keep the record, use remove.
Path
Returns
200
Errors
| Code | Status | Fix |
|---|---|---|
| ASSET_DIMENSIONS | Resize the image to the size named in issues and upload it again. | |
| ASSET_NOT_FOUND | Check the image name or id and that it belongs to this organization. | |
| ASSET_NOT_PNG | Re-export the image as a standard RGB or RGBA PNG and upload it again. | |
| ASSET_SIZE | Compress the image below 1 MB and upload it again. | |
| ASSET_SLOT | Use a slot name from the pass type's image slots in the request path. | |
| BULK_RUN_ACTIVE | Wait for the running job to finish, then start the new one. | |
| BUNDLE_TOO_LARGE | Split the passes across smaller bundles. | |
| CONNECTION_ORG | Use a connection id from your own organization's GET /api/v1/connections. | |
| CONNECTION_TRANSFER_PENDING | Wait for the transfer to finish, then send the request again. | |
| CREATE_STALE | Look the pass up by externalId with GET /api/v1/passes and update it instead of creating it again. | |
| CREDENTIAL_REF_KEYSET_CONFIG_UNAVAILABLE | Retry with backoff; if it persists, send the requestId to support. | |
| CREDENTIAL_REF_KEYSET_UNAVAILABLE | Retry with backoff; if it persists, send the requestId to support. | |
| DELIVERY_STALE | Review the recipient and try again. | |
| DEVICE_TOKEN_UNAVAILABLE | Retry the request; if it persists, send the requestId to support. | |
| EMAIL_INVALID | Send a valid address in the email field. | |
| EXTERNAL_ID_TAKEN | Send a new externalId, or PATCH the existing pass. | |
| FORBIDDEN | Use a key with the scope the operation lists, or ask an org admin. | |
| IDEMPOTENCY_IN_PROGRESS | Wait a moment and resend the identical request. | |
| IDEMPOTENCY_KEY_INVALID | Send a unique string of 1 to 200 characters, such as a UUID. | |
| IDEMPOTENCY_KEY_REUSED | Use a new key for a new request; resend the identical request to replay. | |
| IF_MATCH_INVALID | Send the version from the last GET, for example If-Match: 3. | |
| IMPORT_BUSY | Wait for it to finish with GET /api/v1/pass-imports/{id}, then retry. | |
| IMPORT_COLUMN_MISSING | Add the column to the file, or change the mapping, then check again. | |
| IMPORT_EXPIRED | Upload the file again with POST /api/v1/pass-imports. | |
| IMPORT_FILE_GONE | Upload it again. | |
| IMPORT_HAS_ERRORS | Fix the rows listed in GET /api/v1/pass-imports/{id}/errors.csv, or skip them, then commit again. | |
| IMPORT_HEADER_TOO_LONG | Shorten the header and upload the file again. | |
| IMPORT_ID_TAKEN | Check the import again with POST /api/v1/pass-imports/{id}/check, then commit. | |
| IMPORT_NOT_FOUND | Check the id with GET /api/v1/pass-imports. | |
| IMPORT_PASS_CHANGED | Remove the pass on its own with POST /api/v1/passes/{id}/remove. | |
| IMPORT_PLAN_INVALID | Fix the mapping entries named in issues and check again. | |
| IMPORT_ROW_UNRESERVED | Retry the commit; if it persists, send the requestId to support. | |
| IMPORT_STATE | Check its state with GET /api/v1/pass-imports/{id} and call the action that state allows. | |
| INVALID_API_KEY | Create a new key in the console and update PASSBOOK_KEY. | |
| INVALID_INPUT | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| JOIN_NOT_READY | Publish the template, then enable the link with PUT /api/v1/join-links/{templateId}. | |
| MATCH_NEEDS_TEMPLATE | Send orgId and templateId with the input filter. | |
| MEMBER_PHOTO_CHANGED | Fetch the pass with GET /api/v1/passes/{id} and save the photo again. | |
| MEMBER_PHOTO_DIMENSIONS | Crop the photo to a 270 by 270 pixel square and upload it again. | |
| MEMBER_PHOTO_ENCODING | Send the photo as a PNG or JPEG file. | |
| MEMBER_PHOTO_NOT_FOUND | Add one with PUT /api/v1/passes/{id}/member-photo. | |
| MEMBER_PHOTO_STYLE | Use a template of that style, or remove the strip image. | |
| MISSING_SCOPE | Create a key with the scope the operation lists under security. | |
| MODE_MISMATCH | Use objects and a key of the same mode. | |
| NEW_CODE_UNSUPPORTED | Reissue the pass with POST /api/v1/passes/bulk-reissue instead of requesting a new code. | |
| 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_ACCESS_CHANGED | Check access with GET /api/v1/api-keys/me, then send the request again. | |
| ORG_FORBIDDEN | Use a key scoped to this organization, or a platform key for platform-wide lists. | |
| ORG_MIXED | Send ids from one organization per request. | |
| ORG_NOT_FOUND | Check orgId with GET /api/v1/orgs. | |
| ORG_REQUIRED | Send orgId with the request, or use a key scoped to one organization. | |
| PASS_CONFLICT | Fetch the pass with GET /api/v1/passes/{id} and send the request again. | |
| PASS_CONNECTION_MISMATCH | Link it with PUT /api/v1/passes/{id}/connection, then send the request again. | |
| PASS_FILE_MISSING | Rebuild it with POST /api/v1/passes/{id}/refresh. | |
| PASS_INPUT_INVALID | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| PASS_INVALID | Fix the problems named in issues in the template or inputs. | |
| PASS_NOT_ACTIVE | Restore or unvoid the pass first, or use an active one. | |
| PASS_NOT_FOUND | Check the id with GET /api/v1/passes and the key's mode. | |
| PASS_REF_TAKEN | Use a different ref, or update the existing pass. | |
| PASS_REISSUE_REQUIRED | Reissue it with POST /api/v1/passes/bulk-reissue. | |
| PASS_REMOVED | Restore it with POST /api/v1/passes/{id}/restore, then send the request again. | |
| PASS_TRANSFER_NOT_FOUND | Check the transfer id. | |
| PASS_TRANSFER_PENDING | Try again shortly. | |
| 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}. | |
| SCAN_EVENT_NOT_FOUND | Check the event id with GET /api/v1/scan/events. | |
| SCAN_WINDOW_INVALID | Set an end after the start, or fix the template's dates. | |
| SERIAL_TAKEN | Send a different serial, or leave it out to have one generated. | |
| SESSION_REQUIRED | Do it in the console, or sign in as the account that started it. | |
| STAMPS_ABOVE_MAX | Raise the template's stamp maximum, or redeem stamps first. | |
| STAMPS_CARD_FULL | Redeem the reward, then add stamps. | |
| STAMPS_NONE | Use a template with stamps. | |
| STAMPS_NO_REWARD | Add stamps until the card is full, then redeem. | |
| TEMPLATE_NOT_FOUND | Check the id with GET /api/v1/templates and the key's mode. | |
| TEMPLATE_RELEASE_CONFLICT | Send the request again to use the current release. | |
| TEMPLATE_RELEASE_REQUIRED | Approve a release with POST /api/v1/templates/{id}/candidates/{candidateId}/approve. | |
| TERM_MANAGED | Change the term in the connected system. | |
| TERM_NONE | Renew only passes whose template defines a term. | |
| TERM_NOT_STARTED | Renew after the term starts. | |
| UNAUTHENTICATED | Send Authorization: Bearer $PASSBOOK_KEY. | |
| VALIDATION | Fix each field in issues and resend. | |
| VERSION_NOT_FOUND | Check the version with GET /api/v1/passes/{id}. | |
| VERSION_PURGED | Request a newer version. | |
| WORKFLOW_START | Send the request again. |
/api/v1/passes/{id}/voidVoids a pass. Wallet shows it as void and scans are refused. Undo with unvoid.
Path
Returns
200 PassSummary
Errors
| Code | Status | Fix |
|---|---|---|
| ASSET_DIMENSIONS | Resize the image to the size named in issues and upload it again. | |
| ASSET_NOT_FOUND | Check the image name or id and that it belongs to this organization. | |
| ASSET_NOT_PNG | Re-export the image as a standard RGB or RGBA PNG and upload it again. | |
| ASSET_SIZE | Compress the image below 1 MB and upload it again. | |
| ASSET_SLOT | Use a slot name from the pass type's image slots in the request path. | |
| BULK_RUN_ACTIVE | Wait for the running job to finish, then start the new one. | |
| BUNDLE_TOO_LARGE | Split the passes across smaller bundles. | |
| CONNECTION_ORG | Use a connection id from your own organization's GET /api/v1/connections. | |
| CONNECTION_TRANSFER_PENDING | Wait for the transfer to finish, then send the request again. | |
| CREATE_STALE | Look the pass up by externalId with GET /api/v1/passes and update it instead of creating it again. | |
| CREDENTIAL_REF_KEYSET_CONFIG_UNAVAILABLE | Retry with backoff; if it persists, send the requestId to support. | |
| CREDENTIAL_REF_KEYSET_UNAVAILABLE | Retry with backoff; if it persists, send the requestId to support. | |
| DELIVERY_STALE | Review the recipient and try again. | |
| DEVICE_TOKEN_UNAVAILABLE | Retry the request; if it persists, send the requestId to support. | |
| EMAIL_INVALID | Send a valid address in the email field. | |
| EXTERNAL_ID_TAKEN | Send a new externalId, or PATCH the existing pass. | |
| FORBIDDEN | Use a key with the scope the operation lists, or ask an org admin. | |
| IDEMPOTENCY_IN_PROGRESS | Wait a moment and resend the identical request. | |
| IDEMPOTENCY_KEY_INVALID | Send a unique string of 1 to 200 characters, such as a UUID. | |
| IDEMPOTENCY_KEY_REUSED | Use a new key for a new request; resend the identical request to replay. | |
| IF_MATCH_INVALID | Send the version from the last GET, for example If-Match: 3. | |
| IMPORT_BUSY | Wait for it to finish with GET /api/v1/pass-imports/{id}, then retry. | |
| IMPORT_COLUMN_MISSING | Add the column to the file, or change the mapping, then check again. | |
| IMPORT_EXPIRED | Upload the file again with POST /api/v1/pass-imports. | |
| IMPORT_FILE_GONE | Upload it again. | |
| IMPORT_HAS_ERRORS | Fix the rows listed in GET /api/v1/pass-imports/{id}/errors.csv, or skip them, then commit again. | |
| IMPORT_HEADER_TOO_LONG | Shorten the header and upload the file again. | |
| IMPORT_ID_TAKEN | Check the import again with POST /api/v1/pass-imports/{id}/check, then commit. | |
| IMPORT_NOT_FOUND | Check the id with GET /api/v1/pass-imports. | |
| IMPORT_PASS_CHANGED | Remove the pass on its own with POST /api/v1/passes/{id}/remove. | |
| IMPORT_PLAN_INVALID | Fix the mapping entries named in issues and check again. | |
| IMPORT_ROW_UNRESERVED | Retry the commit; if it persists, send the requestId to support. | |
| IMPORT_STATE | Check its state with GET /api/v1/pass-imports/{id} and call the action that state allows. | |
| INVALID_API_KEY | Create a new key in the console and update PASSBOOK_KEY. | |
| INVALID_INPUT | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| JOIN_NOT_READY | Publish the template, then enable the link with PUT /api/v1/join-links/{templateId}. | |
| MATCH_NEEDS_TEMPLATE | Send orgId and templateId with the input filter. | |
| MEMBER_PHOTO_CHANGED | Fetch the pass with GET /api/v1/passes/{id} and save the photo again. | |
| MEMBER_PHOTO_DIMENSIONS | Crop the photo to a 270 by 270 pixel square and upload it again. | |
| MEMBER_PHOTO_ENCODING | Send the photo as a PNG or JPEG file. | |
| MEMBER_PHOTO_NOT_FOUND | Add one with PUT /api/v1/passes/{id}/member-photo. | |
| MEMBER_PHOTO_STYLE | Use a template of that style, or remove the strip image. | |
| MISSING_SCOPE | Create a key with the scope the operation lists under security. | |
| MODE_MISMATCH | Use objects and a key of the same mode. | |
| NEW_CODE_UNSUPPORTED | Reissue the pass with POST /api/v1/passes/bulk-reissue instead of requesting a new code. | |
| 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_ACCESS_CHANGED | Check access with GET /api/v1/api-keys/me, then send the request again. | |
| ORG_FORBIDDEN | Use a key scoped to this organization, or a platform key for platform-wide lists. | |
| ORG_MIXED | Send ids from one organization per request. | |
| ORG_NOT_FOUND | Check orgId with GET /api/v1/orgs. | |
| ORG_REQUIRED | Send orgId with the request, or use a key scoped to one organization. | |
| PASS_CONFLICT | Fetch the pass with GET /api/v1/passes/{id} and send the request again. | |
| PASS_CONNECTION_MISMATCH | Link it with PUT /api/v1/passes/{id}/connection, then send the request again. | |
| PASS_FILE_MISSING | Rebuild it with POST /api/v1/passes/{id}/refresh. | |
| PASS_INPUT_INVALID | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| PASS_INVALID | Fix the problems named in issues in the template or inputs. | |
| PASS_NOT_ACTIVE | Restore or unvoid the pass first, or use an active one. | |
| PASS_NOT_FOUND | Check the id with GET /api/v1/passes and the key's mode. | |
| PASS_REF_TAKEN | Use a different ref, or update the existing pass. | |
| PASS_REISSUE_REQUIRED | Reissue it with POST /api/v1/passes/bulk-reissue. | |
| PASS_REMOVED | Restore it with POST /api/v1/passes/{id}/restore, then send the request again. | |
| PASS_TRANSFER_NOT_FOUND | Check the transfer id. | |
| PASS_TRANSFER_PENDING | Try again shortly. | |
| 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}. | |
| SCAN_EVENT_NOT_FOUND | Check the event id with GET /api/v1/scan/events. | |
| SCAN_WINDOW_INVALID | Set an end after the start, or fix the template's dates. | |
| SERIAL_TAKEN | Send a different serial, or leave it out to have one generated. | |
| SESSION_REQUIRED | Do it in the console, or sign in as the account that started it. | |
| STAMPS_ABOVE_MAX | Raise the template's stamp maximum, or redeem stamps first. | |
| STAMPS_CARD_FULL | Redeem the reward, then add stamps. | |
| STAMPS_NONE | Use a template with stamps. | |
| STAMPS_NO_REWARD | Add stamps until the card is full, then redeem. | |
| TEMPLATE_NOT_FOUND | Check the id with GET /api/v1/templates and the key's mode. | |
| TEMPLATE_RELEASE_CONFLICT | Send the request again to use the current release. | |
| TEMPLATE_RELEASE_REQUIRED | Approve a release with POST /api/v1/templates/{id}/candidates/{candidateId}/approve. | |
| TERM_MANAGED | Change the term in the connected system. | |
| TERM_NONE | Renew only passes whose template defines a term. | |
| TERM_NOT_STARTED | Renew after the term starts. | |
| UNAUTHENTICATED | Send Authorization: Bearer $PASSBOOK_KEY. | |
| VALIDATION | Fix each field in issues and resend. | |
| VERSION_NOT_FOUND | Check the version with GET /api/v1/passes/{id}. | |
| VERSION_PURGED | Request a newer version. | |
| WORKFLOW_START | Send the request again. |
/api/v1/passes/{id}/unvoidUndoes a void.
Path
Returns
200 PassSummary
Errors
| Code | Status | Fix |
|---|---|---|
| ASSET_DIMENSIONS | Resize the image to the size named in issues and upload it again. | |
| ASSET_NOT_FOUND | Check the image name or id and that it belongs to this organization. | |
| ASSET_NOT_PNG | Re-export the image as a standard RGB or RGBA PNG and upload it again. | |
| ASSET_SIZE | Compress the image below 1 MB and upload it again. | |
| ASSET_SLOT | Use a slot name from the pass type's image slots in the request path. | |
| BULK_RUN_ACTIVE | Wait for the running job to finish, then start the new one. | |
| BUNDLE_TOO_LARGE | Split the passes across smaller bundles. | |
| CONNECTION_ORG | Use a connection id from your own organization's GET /api/v1/connections. | |
| CONNECTION_TRANSFER_PENDING | Wait for the transfer to finish, then send the request again. | |
| CREATE_STALE | Look the pass up by externalId with GET /api/v1/passes and update it instead of creating it again. | |
| CREDENTIAL_REF_KEYSET_CONFIG_UNAVAILABLE | Retry with backoff; if it persists, send the requestId to support. | |
| CREDENTIAL_REF_KEYSET_UNAVAILABLE | Retry with backoff; if it persists, send the requestId to support. | |
| DELIVERY_STALE | Review the recipient and try again. | |
| DEVICE_TOKEN_UNAVAILABLE | Retry the request; if it persists, send the requestId to support. | |
| EMAIL_INVALID | Send a valid address in the email field. | |
| EXTERNAL_ID_TAKEN | Send a new externalId, or PATCH the existing pass. | |
| FORBIDDEN | Use a key with the scope the operation lists, or ask an org admin. | |
| IDEMPOTENCY_IN_PROGRESS | Wait a moment and resend the identical request. | |
| IDEMPOTENCY_KEY_INVALID | Send a unique string of 1 to 200 characters, such as a UUID. | |
| IDEMPOTENCY_KEY_REUSED | Use a new key for a new request; resend the identical request to replay. | |
| IF_MATCH_INVALID | Send the version from the last GET, for example If-Match: 3. | |
| IMPORT_BUSY | Wait for it to finish with GET /api/v1/pass-imports/{id}, then retry. | |
| IMPORT_COLUMN_MISSING | Add the column to the file, or change the mapping, then check again. | |
| IMPORT_EXPIRED | Upload the file again with POST /api/v1/pass-imports. | |
| IMPORT_FILE_GONE | Upload it again. | |
| IMPORT_HAS_ERRORS | Fix the rows listed in GET /api/v1/pass-imports/{id}/errors.csv, or skip them, then commit again. | |
| IMPORT_HEADER_TOO_LONG | Shorten the header and upload the file again. | |
| IMPORT_ID_TAKEN | Check the import again with POST /api/v1/pass-imports/{id}/check, then commit. | |
| IMPORT_NOT_FOUND | Check the id with GET /api/v1/pass-imports. | |
| IMPORT_PASS_CHANGED | Remove the pass on its own with POST /api/v1/passes/{id}/remove. | |
| IMPORT_PLAN_INVALID | Fix the mapping entries named in issues and check again. | |
| IMPORT_ROW_UNRESERVED | Retry the commit; if it persists, send the requestId to support. | |
| IMPORT_STATE | Check its state with GET /api/v1/pass-imports/{id} and call the action that state allows. | |
| INVALID_API_KEY | Create a new key in the console and update PASSBOOK_KEY. | |
| INVALID_INPUT | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| JOIN_NOT_READY | Publish the template, then enable the link with PUT /api/v1/join-links/{templateId}. | |
| MATCH_NEEDS_TEMPLATE | Send orgId and templateId with the input filter. | |
| MEMBER_PHOTO_CHANGED | Fetch the pass with GET /api/v1/passes/{id} and save the photo again. | |
| MEMBER_PHOTO_DIMENSIONS | Crop the photo to a 270 by 270 pixel square and upload it again. | |
| MEMBER_PHOTO_ENCODING | Send the photo as a PNG or JPEG file. | |
| MEMBER_PHOTO_NOT_FOUND | Add one with PUT /api/v1/passes/{id}/member-photo. | |
| MEMBER_PHOTO_STYLE | Use a template of that style, or remove the strip image. | |
| MISSING_SCOPE | Create a key with the scope the operation lists under security. | |
| MODE_MISMATCH | Use objects and a key of the same mode. | |
| NEW_CODE_UNSUPPORTED | Reissue the pass with POST /api/v1/passes/bulk-reissue instead of requesting a new code. | |
| 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_ACCESS_CHANGED | Check access with GET /api/v1/api-keys/me, then send the request again. | |
| ORG_FORBIDDEN | Use a key scoped to this organization, or a platform key for platform-wide lists. | |
| ORG_MIXED | Send ids from one organization per request. | |
| ORG_NOT_FOUND | Check orgId with GET /api/v1/orgs. | |
| ORG_REQUIRED | Send orgId with the request, or use a key scoped to one organization. | |
| PASS_CONFLICT | Fetch the pass with GET /api/v1/passes/{id} and send the request again. | |
| PASS_CONNECTION_MISMATCH | Link it with PUT /api/v1/passes/{id}/connection, then send the request again. | |
| PASS_FILE_MISSING | Rebuild it with POST /api/v1/passes/{id}/refresh. | |
| PASS_INPUT_INVALID | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| PASS_INVALID | Fix the problems named in issues in the template or inputs. | |
| PASS_NOT_ACTIVE | Restore or unvoid the pass first, or use an active one. | |
| PASS_NOT_FOUND | Check the id with GET /api/v1/passes and the key's mode. | |
| PASS_REF_TAKEN | Use a different ref, or update the existing pass. | |
| PASS_REISSUE_REQUIRED | Reissue it with POST /api/v1/passes/bulk-reissue. | |
| PASS_REMOVED | Restore it with POST /api/v1/passes/{id}/restore, then send the request again. | |
| PASS_TRANSFER_NOT_FOUND | Check the transfer id. | |
| PASS_TRANSFER_PENDING | Try again shortly. | |
| 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}. | |
| SCAN_EVENT_NOT_FOUND | Check the event id with GET /api/v1/scan/events. | |
| SCAN_WINDOW_INVALID | Set an end after the start, or fix the template's dates. | |
| SERIAL_TAKEN | Send a different serial, or leave it out to have one generated. | |
| SESSION_REQUIRED | Do it in the console, or sign in as the account that started it. | |
| STAMPS_ABOVE_MAX | Raise the template's stamp maximum, or redeem stamps first. | |
| STAMPS_CARD_FULL | Redeem the reward, then add stamps. | |
| STAMPS_NONE | Use a template with stamps. | |
| STAMPS_NO_REWARD | Add stamps until the card is full, then redeem. | |
| TEMPLATE_NOT_FOUND | Check the id with GET /api/v1/templates and the key's mode. | |
| TEMPLATE_RELEASE_CONFLICT | Send the request again to use the current release. | |
| TEMPLATE_RELEASE_REQUIRED | Approve a release with POST /api/v1/templates/{id}/candidates/{candidateId}/approve. | |
| TERM_MANAGED | Change the term in the connected system. | |
| TERM_NONE | Renew only passes whose template defines a term. | |
| TERM_NOT_STARTED | Renew after the term starts. | |
| UNAUTHENTICATED | Send Authorization: Bearer $PASSBOOK_KEY. | |
| VALIDATION | Fix each field in issues and resend. | |
| VERSION_NOT_FOUND | Check the version with GET /api/v1/passes/{id}. | |
| VERSION_PURGED | Request a newer version. | |
| WORKFLOW_START | Send the request again. |
/api/v1/passes/{id}/refreshPath
Returns
202
Errors
| Code | Status | Fix |
|---|---|---|
| ASSET_DIMENSIONS | Resize the image to the size named in issues and upload it again. | |
| ASSET_NOT_FOUND | Check the image name or id and that it belongs to this organization. | |
| ASSET_NOT_PNG | Re-export the image as a standard RGB or RGBA PNG and upload it again. | |
| ASSET_SIZE | Compress the image below 1 MB and upload it again. | |
| ASSET_SLOT | Use a slot name from the pass type's image slots in the request path. | |
| BULK_RUN_ACTIVE | Wait for the running job to finish, then start the new one. | |
| BUNDLE_TOO_LARGE | Split the passes across smaller bundles. | |
| CONNECTION_ORG | Use a connection id from your own organization's GET /api/v1/connections. | |
| CONNECTION_TRANSFER_PENDING | Wait for the transfer to finish, then send the request again. | |
| CREATE_STALE | Look the pass up by externalId with GET /api/v1/passes and update it instead of creating it again. | |
| CREDENTIAL_REF_KEYSET_CONFIG_UNAVAILABLE | Retry with backoff; if it persists, send the requestId to support. | |
| CREDENTIAL_REF_KEYSET_UNAVAILABLE | Retry with backoff; if it persists, send the requestId to support. | |
| DELIVERY_STALE | Review the recipient and try again. | |
| DEVICE_TOKEN_UNAVAILABLE | Retry the request; if it persists, send the requestId to support. | |
| EMAIL_INVALID | Send a valid address in the email field. | |
| EXTERNAL_ID_TAKEN | Send a new externalId, or PATCH the existing pass. | |
| FORBIDDEN | Use a key with the scope the operation lists, or ask an org admin. | |
| IDEMPOTENCY_IN_PROGRESS | Wait a moment and resend the identical request. | |
| IDEMPOTENCY_KEY_INVALID | Send a unique string of 1 to 200 characters, such as a UUID. | |
| IDEMPOTENCY_KEY_REUSED | Use a new key for a new request; resend the identical request to replay. | |
| IF_MATCH_INVALID | Send the version from the last GET, for example If-Match: 3. | |
| IMPORT_BUSY | Wait for it to finish with GET /api/v1/pass-imports/{id}, then retry. | |
| IMPORT_COLUMN_MISSING | Add the column to the file, or change the mapping, then check again. | |
| IMPORT_EXPIRED | Upload the file again with POST /api/v1/pass-imports. | |
| IMPORT_FILE_GONE | Upload it again. | |
| IMPORT_HAS_ERRORS | Fix the rows listed in GET /api/v1/pass-imports/{id}/errors.csv, or skip them, then commit again. | |
| IMPORT_HEADER_TOO_LONG | Shorten the header and upload the file again. | |
| IMPORT_ID_TAKEN | Check the import again with POST /api/v1/pass-imports/{id}/check, then commit. | |
| IMPORT_NOT_FOUND | Check the id with GET /api/v1/pass-imports. | |
| IMPORT_PASS_CHANGED | Remove the pass on its own with POST /api/v1/passes/{id}/remove. | |
| IMPORT_PLAN_INVALID | Fix the mapping entries named in issues and check again. | |
| IMPORT_ROW_UNRESERVED | Retry the commit; if it persists, send the requestId to support. | |
| IMPORT_STATE | Check its state with GET /api/v1/pass-imports/{id} and call the action that state allows. | |
| INVALID_API_KEY | Create a new key in the console and update PASSBOOK_KEY. | |
| INVALID_INPUT | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| JOIN_NOT_READY | Publish the template, then enable the link with PUT /api/v1/join-links/{templateId}. | |
| MATCH_NEEDS_TEMPLATE | Send orgId and templateId with the input filter. | |
| MEMBER_PHOTO_CHANGED | Fetch the pass with GET /api/v1/passes/{id} and save the photo again. | |
| MEMBER_PHOTO_DIMENSIONS | Crop the photo to a 270 by 270 pixel square and upload it again. | |
| MEMBER_PHOTO_ENCODING | Send the photo as a PNG or JPEG file. | |
| MEMBER_PHOTO_NOT_FOUND | Add one with PUT /api/v1/passes/{id}/member-photo. | |
| MEMBER_PHOTO_STYLE | Use a template of that style, or remove the strip image. | |
| MISSING_SCOPE | Create a key with the scope the operation lists under security. | |
| MODE_MISMATCH | Use objects and a key of the same mode. | |
| NEW_CODE_UNSUPPORTED | Reissue the pass with POST /api/v1/passes/bulk-reissue instead of requesting a new code. | |
| 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_ACCESS_CHANGED | Check access with GET /api/v1/api-keys/me, then send the request again. | |
| ORG_FORBIDDEN | Use a key scoped to this organization, or a platform key for platform-wide lists. | |
| ORG_MIXED | Send ids from one organization per request. | |
| ORG_NOT_FOUND | Check orgId with GET /api/v1/orgs. | |
| ORG_REQUIRED | Send orgId with the request, or use a key scoped to one organization. | |
| PASS_CONFLICT | Fetch the pass with GET /api/v1/passes/{id} and send the request again. | |
| PASS_CONNECTION_MISMATCH | Link it with PUT /api/v1/passes/{id}/connection, then send the request again. | |
| PASS_FILE_MISSING | Rebuild it with POST /api/v1/passes/{id}/refresh. | |
| PASS_INPUT_INVALID | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| PASS_INVALID | Fix the problems named in issues in the template or inputs. | |
| PASS_NOT_ACTIVE | Restore or unvoid the pass first, or use an active one. | |
| PASS_NOT_FOUND | Check the id with GET /api/v1/passes and the key's mode. | |
| PASS_REF_TAKEN | Use a different ref, or update the existing pass. | |
| PASS_REISSUE_REQUIRED | Reissue it with POST /api/v1/passes/bulk-reissue. | |
| PASS_REMOVED | Restore it with POST /api/v1/passes/{id}/restore, then send the request again. | |
| PASS_TRANSFER_NOT_FOUND | Check the transfer id. | |
| PASS_TRANSFER_PENDING | Try again shortly. | |
| 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}. | |
| SCAN_EVENT_NOT_FOUND | Check the event id with GET /api/v1/scan/events. | |
| SCAN_WINDOW_INVALID | Set an end after the start, or fix the template's dates. | |
| SERIAL_TAKEN | Send a different serial, or leave it out to have one generated. | |
| SESSION_REQUIRED | Do it in the console, or sign in as the account that started it. | |
| STAMPS_ABOVE_MAX | Raise the template's stamp maximum, or redeem stamps first. | |
| STAMPS_CARD_FULL | Redeem the reward, then add stamps. | |
| STAMPS_NONE | Use a template with stamps. | |
| STAMPS_NO_REWARD | Add stamps until the card is full, then redeem. | |
| TEMPLATE_NOT_FOUND | Check the id with GET /api/v1/templates and the key's mode. | |
| TEMPLATE_RELEASE_CONFLICT | Send the request again to use the current release. | |
| TEMPLATE_RELEASE_REQUIRED | Approve a release with POST /api/v1/templates/{id}/candidates/{candidateId}/approve. | |
| TERM_MANAGED | Change the term in the connected system. | |
| TERM_NONE | Renew only passes whose template defines a term. | |
| TERM_NOT_STARTED | Renew after the term starts. | |
| UNAUTHENTICATED | Send Authorization: Bearer $PASSBOOK_KEY. | |
| VALIDATION | Fix each field in issues and resend. | |
| VERSION_NOT_FOUND | Check the version with GET /api/v1/passes/{id}. | |
| VERSION_PURGED | Request a newer version. | |
| WORKFLOW_START | Send the request again. |
/api/v1/passes/{id}/rotate-linkReplaces the download and public links. The old links stop working.
Path
Returns
200
Errors
| Code | Status | Fix |
|---|---|---|
| ASSET_DIMENSIONS | Resize the image to the size named in issues and upload it again. | |
| ASSET_NOT_FOUND | Check the image name or id and that it belongs to this organization. | |
| ASSET_NOT_PNG | Re-export the image as a standard RGB or RGBA PNG and upload it again. | |
| ASSET_SIZE | Compress the image below 1 MB and upload it again. | |
| ASSET_SLOT | Use a slot name from the pass type's image slots in the request path. | |
| BULK_RUN_ACTIVE | Wait for the running job to finish, then start the new one. | |
| BUNDLE_TOO_LARGE | Split the passes across smaller bundles. | |
| CONNECTION_ORG | Use a connection id from your own organization's GET /api/v1/connections. | |
| CONNECTION_TRANSFER_PENDING | Wait for the transfer to finish, then send the request again. | |
| CREATE_STALE | Look the pass up by externalId with GET /api/v1/passes and update it instead of creating it again. | |
| CREDENTIAL_REF_KEYSET_CONFIG_UNAVAILABLE | Retry with backoff; if it persists, send the requestId to support. | |
| CREDENTIAL_REF_KEYSET_UNAVAILABLE | Retry with backoff; if it persists, send the requestId to support. | |
| DELIVERY_STALE | Review the recipient and try again. | |
| DEVICE_TOKEN_UNAVAILABLE | Retry the request; if it persists, send the requestId to support. | |
| EMAIL_INVALID | Send a valid address in the email field. | |
| EXTERNAL_ID_TAKEN | Send a new externalId, or PATCH the existing pass. | |
| FORBIDDEN | Use a key with the scope the operation lists, or ask an org admin. | |
| IDEMPOTENCY_IN_PROGRESS | Wait a moment and resend the identical request. | |
| IDEMPOTENCY_KEY_INVALID | Send a unique string of 1 to 200 characters, such as a UUID. | |
| IDEMPOTENCY_KEY_REUSED | Use a new key for a new request; resend the identical request to replay. | |
| IF_MATCH_INVALID | Send the version from the last GET, for example If-Match: 3. | |
| IMPORT_BUSY | Wait for it to finish with GET /api/v1/pass-imports/{id}, then retry. | |
| IMPORT_COLUMN_MISSING | Add the column to the file, or change the mapping, then check again. | |
| IMPORT_EXPIRED | Upload the file again with POST /api/v1/pass-imports. | |
| IMPORT_FILE_GONE | Upload it again. | |
| IMPORT_HAS_ERRORS | Fix the rows listed in GET /api/v1/pass-imports/{id}/errors.csv, or skip them, then commit again. | |
| IMPORT_HEADER_TOO_LONG | Shorten the header and upload the file again. | |
| IMPORT_ID_TAKEN | Check the import again with POST /api/v1/pass-imports/{id}/check, then commit. | |
| IMPORT_NOT_FOUND | Check the id with GET /api/v1/pass-imports. | |
| IMPORT_PASS_CHANGED | Remove the pass on its own with POST /api/v1/passes/{id}/remove. | |
| IMPORT_PLAN_INVALID | Fix the mapping entries named in issues and check again. | |
| IMPORT_ROW_UNRESERVED | Retry the commit; if it persists, send the requestId to support. | |
| IMPORT_STATE | Check its state with GET /api/v1/pass-imports/{id} and call the action that state allows. | |
| INVALID_API_KEY | Create a new key in the console and update PASSBOOK_KEY. | |
| INVALID_INPUT | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| JOIN_NOT_READY | Publish the template, then enable the link with PUT /api/v1/join-links/{templateId}. | |
| MATCH_NEEDS_TEMPLATE | Send orgId and templateId with the input filter. | |
| MEMBER_PHOTO_CHANGED | Fetch the pass with GET /api/v1/passes/{id} and save the photo again. | |
| MEMBER_PHOTO_DIMENSIONS | Crop the photo to a 270 by 270 pixel square and upload it again. | |
| MEMBER_PHOTO_ENCODING | Send the photo as a PNG or JPEG file. | |
| MEMBER_PHOTO_NOT_FOUND | Add one with PUT /api/v1/passes/{id}/member-photo. | |
| MEMBER_PHOTO_STYLE | Use a template of that style, or remove the strip image. | |
| MISSING_SCOPE | Create a key with the scope the operation lists under security. | |
| MODE_MISMATCH | Use objects and a key of the same mode. | |
| NEW_CODE_UNSUPPORTED | Reissue the pass with POST /api/v1/passes/bulk-reissue instead of requesting a new code. | |
| 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_ACCESS_CHANGED | Check access with GET /api/v1/api-keys/me, then send the request again. | |
| ORG_FORBIDDEN | Use a key scoped to this organization, or a platform key for platform-wide lists. | |
| ORG_MIXED | Send ids from one organization per request. | |
| ORG_NOT_FOUND | Check orgId with GET /api/v1/orgs. | |
| ORG_REQUIRED | Send orgId with the request, or use a key scoped to one organization. | |
| PASS_CONFLICT | Fetch the pass with GET /api/v1/passes/{id} and send the request again. | |
| PASS_CONNECTION_MISMATCH | Link it with PUT /api/v1/passes/{id}/connection, then send the request again. | |
| PASS_FILE_MISSING | Rebuild it with POST /api/v1/passes/{id}/refresh. | |
| PASS_INPUT_INVALID | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| PASS_INVALID | Fix the problems named in issues in the template or inputs. | |
| PASS_NOT_ACTIVE | Restore or unvoid the pass first, or use an active one. | |
| PASS_NOT_FOUND | Check the id with GET /api/v1/passes and the key's mode. | |
| PASS_REF_TAKEN | Use a different ref, or update the existing pass. | |
| PASS_REISSUE_REQUIRED | Reissue it with POST /api/v1/passes/bulk-reissue. | |
| PASS_REMOVED | Restore it with POST /api/v1/passes/{id}/restore, then send the request again. | |
| PASS_TRANSFER_NOT_FOUND | Check the transfer id. | |
| PASS_TRANSFER_PENDING | Try again shortly. | |
| 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}. | |
| SCAN_EVENT_NOT_FOUND | Check the event id with GET /api/v1/scan/events. | |
| SCAN_WINDOW_INVALID | Set an end after the start, or fix the template's dates. | |
| SERIAL_TAKEN | Send a different serial, or leave it out to have one generated. | |
| SESSION_REQUIRED | Do it in the console, or sign in as the account that started it. | |
| STAMPS_ABOVE_MAX | Raise the template's stamp maximum, or redeem stamps first. | |
| STAMPS_CARD_FULL | Redeem the reward, then add stamps. | |
| STAMPS_NONE | Use a template with stamps. | |
| STAMPS_NO_REWARD | Add stamps until the card is full, then redeem. | |
| TEMPLATE_NOT_FOUND | Check the id with GET /api/v1/templates and the key's mode. | |
| TEMPLATE_RELEASE_CONFLICT | Send the request again to use the current release. | |
| TEMPLATE_RELEASE_REQUIRED | Approve a release with POST /api/v1/templates/{id}/candidates/{candidateId}/approve. | |
| TERM_MANAGED | Change the term in the connected system. | |
| TERM_NONE | Renew only passes whose template defines a term. | |
| TERM_NOT_STARTED | Renew after the term starts. | |
| UNAUTHENTICATED | Send Authorization: Bearer $PASSBOOK_KEY. | |
| VALIDATION | Fix each field in issues and resend. | |
| VERSION_NOT_FOUND | Check the version with GET /api/v1/passes/{id}. | |
| VERSION_PURGED | Request a newer version. | |
| WORKFLOW_START | Send the request again. |
/api/v1/passes/{id}/new-codeMints a new scan code. The old code stops working.
Path
Returns
200
Errors
| Code | Status | Fix |
|---|---|---|
| ASSET_DIMENSIONS | Resize the image to the size named in issues and upload it again. | |
| ASSET_NOT_FOUND | Check the image name or id and that it belongs to this organization. | |
| ASSET_NOT_PNG | Re-export the image as a standard RGB or RGBA PNG and upload it again. | |
| ASSET_SIZE | Compress the image below 1 MB and upload it again. | |
| ASSET_SLOT | Use a slot name from the pass type's image slots in the request path. | |
| BULK_RUN_ACTIVE | Wait for the running job to finish, then start the new one. | |
| BUNDLE_TOO_LARGE | Split the passes across smaller bundles. | |
| CONNECTION_ORG | Use a connection id from your own organization's GET /api/v1/connections. | |
| CONNECTION_TRANSFER_PENDING | Wait for the transfer to finish, then send the request again. | |
| CREATE_STALE | Look the pass up by externalId with GET /api/v1/passes and update it instead of creating it again. | |
| CREDENTIAL_REF_KEYSET_CONFIG_UNAVAILABLE | Retry with backoff; if it persists, send the requestId to support. | |
| CREDENTIAL_REF_KEYSET_UNAVAILABLE | Retry with backoff; if it persists, send the requestId to support. | |
| DELIVERY_STALE | Review the recipient and try again. | |
| DEVICE_TOKEN_UNAVAILABLE | Retry the request; if it persists, send the requestId to support. | |
| EMAIL_INVALID | Send a valid address in the email field. | |
| EXTERNAL_ID_TAKEN | Send a new externalId, or PATCH the existing pass. | |
| FORBIDDEN | Use a key with the scope the operation lists, or ask an org admin. | |
| IDEMPOTENCY_IN_PROGRESS | Wait a moment and resend the identical request. | |
| IDEMPOTENCY_KEY_INVALID | Send a unique string of 1 to 200 characters, such as a UUID. | |
| IDEMPOTENCY_KEY_REUSED | Use a new key for a new request; resend the identical request to replay. | |
| IF_MATCH_INVALID | Send the version from the last GET, for example If-Match: 3. | |
| IMPORT_BUSY | Wait for it to finish with GET /api/v1/pass-imports/{id}, then retry. | |
| IMPORT_COLUMN_MISSING | Add the column to the file, or change the mapping, then check again. | |
| IMPORT_EXPIRED | Upload the file again with POST /api/v1/pass-imports. | |
| IMPORT_FILE_GONE | Upload it again. | |
| IMPORT_HAS_ERRORS | Fix the rows listed in GET /api/v1/pass-imports/{id}/errors.csv, or skip them, then commit again. | |
| IMPORT_HEADER_TOO_LONG | Shorten the header and upload the file again. | |
| IMPORT_ID_TAKEN | Check the import again with POST /api/v1/pass-imports/{id}/check, then commit. | |
| IMPORT_NOT_FOUND | Check the id with GET /api/v1/pass-imports. | |
| IMPORT_PASS_CHANGED | Remove the pass on its own with POST /api/v1/passes/{id}/remove. | |
| IMPORT_PLAN_INVALID | Fix the mapping entries named in issues and check again. | |
| IMPORT_ROW_UNRESERVED | Retry the commit; if it persists, send the requestId to support. | |
| IMPORT_STATE | Check its state with GET /api/v1/pass-imports/{id} and call the action that state allows. | |
| INVALID_API_KEY | Create a new key in the console and update PASSBOOK_KEY. | |
| INVALID_INPUT | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| JOIN_NOT_READY | Publish the template, then enable the link with PUT /api/v1/join-links/{templateId}. | |
| MATCH_NEEDS_TEMPLATE | Send orgId and templateId with the input filter. | |
| MEMBER_PHOTO_CHANGED | Fetch the pass with GET /api/v1/passes/{id} and save the photo again. | |
| MEMBER_PHOTO_DIMENSIONS | Crop the photo to a 270 by 270 pixel square and upload it again. | |
| MEMBER_PHOTO_ENCODING | Send the photo as a PNG or JPEG file. | |
| MEMBER_PHOTO_NOT_FOUND | Add one with PUT /api/v1/passes/{id}/member-photo. | |
| MEMBER_PHOTO_STYLE | Use a template of that style, or remove the strip image. | |
| MISSING_SCOPE | Create a key with the scope the operation lists under security. | |
| MODE_MISMATCH | Use objects and a key of the same mode. | |
| NEW_CODE_UNSUPPORTED | Reissue the pass with POST /api/v1/passes/bulk-reissue instead of requesting a new code. | |
| 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_ACCESS_CHANGED | Check access with GET /api/v1/api-keys/me, then send the request again. | |
| ORG_FORBIDDEN | Use a key scoped to this organization, or a platform key for platform-wide lists. | |
| ORG_MIXED | Send ids from one organization per request. | |
| ORG_NOT_FOUND | Check orgId with GET /api/v1/orgs. | |
| ORG_REQUIRED | Send orgId with the request, or use a key scoped to one organization. | |
| PASS_CONFLICT | Fetch the pass with GET /api/v1/passes/{id} and send the request again. | |
| PASS_CONNECTION_MISMATCH | Link it with PUT /api/v1/passes/{id}/connection, then send the request again. | |
| PASS_FILE_MISSING | Rebuild it with POST /api/v1/passes/{id}/refresh. | |
| PASS_INPUT_INVALID | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| PASS_INVALID | Fix the problems named in issues in the template or inputs. | |
| PASS_NOT_ACTIVE | Restore or unvoid the pass first, or use an active one. | |
| PASS_NOT_FOUND | Check the id with GET /api/v1/passes and the key's mode. | |
| PASS_REF_TAKEN | Use a different ref, or update the existing pass. | |
| PASS_REISSUE_REQUIRED | Reissue it with POST /api/v1/passes/bulk-reissue. | |
| PASS_REMOVED | Restore it with POST /api/v1/passes/{id}/restore, then send the request again. | |
| PASS_TRANSFER_NOT_FOUND | Check the transfer id. | |
| PASS_TRANSFER_PENDING | Try again shortly. | |
| 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}. | |
| SCAN_EVENT_NOT_FOUND | Check the event id with GET /api/v1/scan/events. | |
| SCAN_WINDOW_INVALID | Set an end after the start, or fix the template's dates. | |
| SERIAL_TAKEN | Send a different serial, or leave it out to have one generated. | |
| SESSION_REQUIRED | Do it in the console, or sign in as the account that started it. | |
| STAMPS_ABOVE_MAX | Raise the template's stamp maximum, or redeem stamps first. | |
| STAMPS_CARD_FULL | Redeem the reward, then add stamps. | |
| STAMPS_NONE | Use a template with stamps. | |
| STAMPS_NO_REWARD | Add stamps until the card is full, then redeem. | |
| TEMPLATE_NOT_FOUND | Check the id with GET /api/v1/templates and the key's mode. | |
| TEMPLATE_RELEASE_CONFLICT | Send the request again to use the current release. | |
| TEMPLATE_RELEASE_REQUIRED | Approve a release with POST /api/v1/templates/{id}/candidates/{candidateId}/approve. | |
| TERM_MANAGED | Change the term in the connected system. | |
| TERM_NONE | Renew only passes whose template defines a term. | |
| TERM_NOT_STARTED | Renew after the term starts. | |
| UNAUTHENTICATED | Send Authorization: Bearer $PASSBOOK_KEY. | |
| VALIDATION | Fix each field in issues and resend. | |
| VERSION_NOT_FOUND | Check the version with GET /api/v1/passes/{id}. | |
| VERSION_PURGED | Request a newer version. | |
| WORKFLOW_START | Send the request again. |
/api/v1/passes/{id}/resend-emailEmails the pass link to the holder, or to to when given. Send an Idempotency-Key header to retry safely.
Path
Headers
1 to 200 characters. A retry with the same key and body returns the first result.
Body
Returns
202
Errors
| Code | Status | Fix |
|---|---|---|
| ASSET_DIMENSIONS | Resize the image to the size named in issues and upload it again. | |
| ASSET_NOT_FOUND | Check the image name or id and that it belongs to this organization. | |
| ASSET_NOT_PNG | Re-export the image as a standard RGB or RGBA PNG and upload it again. | |
| ASSET_SIZE | Compress the image below 1 MB and upload it again. | |
| ASSET_SLOT | Use a slot name from the pass type's image slots in the request path. | |
| BULK_RUN_ACTIVE | Wait for the running job to finish, then start the new one. | |
| BUNDLE_TOO_LARGE | Split the passes across smaller bundles. | |
| CONNECTION_ORG | Use a connection id from your own organization's GET /api/v1/connections. | |
| CONNECTION_TRANSFER_PENDING | Wait for the transfer to finish, then send the request again. | |
| CREATE_STALE | Look the pass up by externalId with GET /api/v1/passes and update it instead of creating it again. | |
| CREDENTIAL_REF_KEYSET_CONFIG_UNAVAILABLE | Retry with backoff; if it persists, send the requestId to support. | |
| CREDENTIAL_REF_KEYSET_UNAVAILABLE | Retry with backoff; if it persists, send the requestId to support. | |
| DELIVERY_STALE | Review the recipient and try again. | |
| DEVICE_TOKEN_UNAVAILABLE | Retry the request; if it persists, send the requestId to support. | |
| EMAIL_INVALID | Send a valid address in the email field. | |
| EXTERNAL_ID_TAKEN | Send a new externalId, or PATCH the existing pass. | |
| FORBIDDEN | Use a key with the scope the operation lists, or ask an org admin. | |
| IDEMPOTENCY_IN_PROGRESS | Wait a moment and resend the identical request. | |
| IDEMPOTENCY_KEY_INVALID | Send a unique string of 1 to 200 characters, such as a UUID. | |
| IDEMPOTENCY_KEY_REUSED | Use a new key for a new request; resend the identical request to replay. | |
| IF_MATCH_INVALID | Send the version from the last GET, for example If-Match: 3. | |
| IMPORT_BUSY | Wait for it to finish with GET /api/v1/pass-imports/{id}, then retry. | |
| IMPORT_COLUMN_MISSING | Add the column to the file, or change the mapping, then check again. | |
| IMPORT_EXPIRED | Upload the file again with POST /api/v1/pass-imports. | |
| IMPORT_FILE_GONE | Upload it again. | |
| IMPORT_HAS_ERRORS | Fix the rows listed in GET /api/v1/pass-imports/{id}/errors.csv, or skip them, then commit again. | |
| IMPORT_HEADER_TOO_LONG | Shorten the header and upload the file again. | |
| IMPORT_ID_TAKEN | Check the import again with POST /api/v1/pass-imports/{id}/check, then commit. | |
| IMPORT_NOT_FOUND | Check the id with GET /api/v1/pass-imports. | |
| IMPORT_PASS_CHANGED | Remove the pass on its own with POST /api/v1/passes/{id}/remove. | |
| IMPORT_PLAN_INVALID | Fix the mapping entries named in issues and check again. | |
| IMPORT_ROW_UNRESERVED | Retry the commit; if it persists, send the requestId to support. | |
| IMPORT_STATE | Check its state with GET /api/v1/pass-imports/{id} and call the action that state allows. | |
| INVALID_API_KEY | Create a new key in the console and update PASSBOOK_KEY. | |
| INVALID_INPUT | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| JOIN_NOT_READY | Publish the template, then enable the link with PUT /api/v1/join-links/{templateId}. | |
| MATCH_NEEDS_TEMPLATE | Send orgId and templateId with the input filter. | |
| MEMBER_PHOTO_CHANGED | Fetch the pass with GET /api/v1/passes/{id} and save the photo again. | |
| MEMBER_PHOTO_DIMENSIONS | Crop the photo to a 270 by 270 pixel square and upload it again. | |
| MEMBER_PHOTO_ENCODING | Send the photo as a PNG or JPEG file. | |
| MEMBER_PHOTO_NOT_FOUND | Add one with PUT /api/v1/passes/{id}/member-photo. | |
| MEMBER_PHOTO_STYLE | Use a template of that style, or remove the strip image. | |
| MISSING_SCOPE | Create a key with the scope the operation lists under security. | |
| MODE_MISMATCH | Use objects and a key of the same mode. | |
| NEW_CODE_UNSUPPORTED | Reissue the pass with POST /api/v1/passes/bulk-reissue instead of requesting a new code. | |
| 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_ACCESS_CHANGED | Check access with GET /api/v1/api-keys/me, then send the request again. | |
| ORG_FORBIDDEN | Use a key scoped to this organization, or a platform key for platform-wide lists. | |
| ORG_MIXED | Send ids from one organization per request. | |
| ORG_NOT_FOUND | Check orgId with GET /api/v1/orgs. | |
| ORG_REQUIRED | Send orgId with the request, or use a key scoped to one organization. | |
| PASS_CONFLICT | Fetch the pass with GET /api/v1/passes/{id} and send the request again. | |
| PASS_CONNECTION_MISMATCH | Link it with PUT /api/v1/passes/{id}/connection, then send the request again. | |
| PASS_FILE_MISSING | Rebuild it with POST /api/v1/passes/{id}/refresh. | |
| PASS_INPUT_INVALID | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| PASS_INVALID | Fix the problems named in issues in the template or inputs. | |
| PASS_NOT_ACTIVE | Restore or unvoid the pass first, or use an active one. | |
| PASS_NOT_FOUND | Check the id with GET /api/v1/passes and the key's mode. | |
| PASS_REF_TAKEN | Use a different ref, or update the existing pass. | |
| PASS_REISSUE_REQUIRED | Reissue it with POST /api/v1/passes/bulk-reissue. | |
| PASS_REMOVED | Restore it with POST /api/v1/passes/{id}/restore, then send the request again. | |
| PASS_TRANSFER_NOT_FOUND | Check the transfer id. | |
| PASS_TRANSFER_PENDING | Try again shortly. | |
| 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}. | |
| SCAN_EVENT_NOT_FOUND | Check the event id with GET /api/v1/scan/events. | |
| SCAN_WINDOW_INVALID | Set an end after the start, or fix the template's dates. | |
| SERIAL_TAKEN | Send a different serial, or leave it out to have one generated. | |
| SESSION_REQUIRED | Do it in the console, or sign in as the account that started it. | |
| STAMPS_ABOVE_MAX | Raise the template's stamp maximum, or redeem stamps first. | |
| STAMPS_CARD_FULL | Redeem the reward, then add stamps. | |
| STAMPS_NONE | Use a template with stamps. | |
| STAMPS_NO_REWARD | Add stamps until the card is full, then redeem. | |
| TEMPLATE_NOT_FOUND | Check the id with GET /api/v1/templates and the key's mode. | |
| TEMPLATE_RELEASE_CONFLICT | Send the request again to use the current release. | |
| TEMPLATE_RELEASE_REQUIRED | Approve a release with POST /api/v1/templates/{id}/candidates/{candidateId}/approve. | |
| TERM_MANAGED | Change the term in the connected system. | |
| TERM_NONE | Renew only passes whose template defines a term. | |
| TERM_NOT_STARTED | Renew after the term starts. | |
| UNAUTHENTICATED | Send Authorization: Bearer $PASSBOOK_KEY. | |
| VALIDATION | Fix each field in issues and resend. | |
| VERSION_NOT_FOUND | Check the version with GET /api/v1/passes/{id}. | |
| VERSION_PURGED | Request a newer version. | |
| WORKFLOW_START | Send the request again. |
/api/v1/passes/photos/matchBody
Returns
200
Errors
| Code | Status | Fix |
|---|---|---|
| ASSET_DIMENSIONS | Resize the image to the size named in issues and upload it again. | |
| ASSET_NOT_FOUND | Check the image name or id and that it belongs to this organization. | |
| ASSET_NOT_PNG | Re-export the image as a standard RGB or RGBA PNG and upload it again. | |
| ASSET_SIZE | Compress the image below 1 MB and upload it again. | |
| ASSET_SLOT | Use a slot name from the pass type's image slots in the request path. | |
| BULK_RUN_ACTIVE | Wait for the running job to finish, then start the new one. | |
| BUNDLE_TOO_LARGE | Split the passes across smaller bundles. | |
| CONNECTION_ORG | Use a connection id from your own organization's GET /api/v1/connections. | |
| CONNECTION_TRANSFER_PENDING | Wait for the transfer to finish, then send the request again. | |
| CREATE_STALE | Look the pass up by externalId with GET /api/v1/passes and update it instead of creating it again. | |
| CREDENTIAL_REF_KEYSET_CONFIG_UNAVAILABLE | Retry with backoff; if it persists, send the requestId to support. | |
| CREDENTIAL_REF_KEYSET_UNAVAILABLE | Retry with backoff; if it persists, send the requestId to support. | |
| DELIVERY_STALE | Review the recipient and try again. | |
| DEVICE_TOKEN_UNAVAILABLE | Retry the request; if it persists, send the requestId to support. | |
| EMAIL_INVALID | Send a valid address in the email field. | |
| EXTERNAL_ID_TAKEN | Send a new externalId, or PATCH the existing pass. | |
| FORBIDDEN | Use a key with the scope the operation lists, or ask an org admin. | |
| IDEMPOTENCY_IN_PROGRESS | Wait a moment and resend the identical request. | |
| IDEMPOTENCY_KEY_INVALID | Send a unique string of 1 to 200 characters, such as a UUID. | |
| IDEMPOTENCY_KEY_REUSED | Use a new key for a new request; resend the identical request to replay. | |
| IF_MATCH_INVALID | Send the version from the last GET, for example If-Match: 3. | |
| IMPORT_BUSY | Wait for it to finish with GET /api/v1/pass-imports/{id}, then retry. | |
| IMPORT_COLUMN_MISSING | Add the column to the file, or change the mapping, then check again. | |
| IMPORT_EXPIRED | Upload the file again with POST /api/v1/pass-imports. | |
| IMPORT_FILE_GONE | Upload it again. | |
| IMPORT_HAS_ERRORS | Fix the rows listed in GET /api/v1/pass-imports/{id}/errors.csv, or skip them, then commit again. | |
| IMPORT_HEADER_TOO_LONG | Shorten the header and upload the file again. | |
| IMPORT_ID_TAKEN | Check the import again with POST /api/v1/pass-imports/{id}/check, then commit. | |
| IMPORT_NOT_FOUND | Check the id with GET /api/v1/pass-imports. | |
| IMPORT_PASS_CHANGED | Remove the pass on its own with POST /api/v1/passes/{id}/remove. | |
| IMPORT_PLAN_INVALID | Fix the mapping entries named in issues and check again. | |
| IMPORT_ROW_UNRESERVED | Retry the commit; if it persists, send the requestId to support. | |
| IMPORT_STATE | Check its state with GET /api/v1/pass-imports/{id} and call the action that state allows. | |
| INVALID_API_KEY | Create a new key in the console and update PASSBOOK_KEY. | |
| INVALID_INPUT | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| JOIN_NOT_READY | Publish the template, then enable the link with PUT /api/v1/join-links/{templateId}. | |
| MATCH_NEEDS_TEMPLATE | Send orgId and templateId with the input filter. | |
| MEMBER_PHOTO_CHANGED | Fetch the pass with GET /api/v1/passes/{id} and save the photo again. | |
| MEMBER_PHOTO_DIMENSIONS | Crop the photo to a 270 by 270 pixel square and upload it again. | |
| MEMBER_PHOTO_ENCODING | Send the photo as a PNG or JPEG file. | |
| MEMBER_PHOTO_NOT_FOUND | Add one with PUT /api/v1/passes/{id}/member-photo. | |
| MEMBER_PHOTO_STYLE | Use a template of that style, or remove the strip image. | |
| MISSING_SCOPE | Create a key with the scope the operation lists under security. | |
| MODE_MISMATCH | Use objects and a key of the same mode. | |
| NEW_CODE_UNSUPPORTED | Reissue the pass with POST /api/v1/passes/bulk-reissue instead of requesting a new code. | |
| NO_RECIPIENT | Set the holder's email with PATCH /api/v1/passes/{id}, then send again. | |
| ORG_ACCESS_CHANGED | Check access with GET /api/v1/api-keys/me, then send the request again. | |
| ORG_FORBIDDEN | Use a key scoped to this organization, or a platform key for platform-wide lists. | |
| ORG_MIXED | Send ids from one organization per request. | |
| ORG_NOT_FOUND | Check orgId with GET /api/v1/orgs. | |
| ORG_REQUIRED | Send orgId with the request, or use a key scoped to one organization. | |
| PASS_CONFLICT | Fetch the pass with GET /api/v1/passes/{id} and send the request again. | |
| PASS_CONNECTION_MISMATCH | Link it with PUT /api/v1/passes/{id}/connection, then send the request again. | |
| PASS_FILE_MISSING | Rebuild it with POST /api/v1/passes/{id}/refresh. | |
| PASS_INPUT_INVALID | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| PASS_INVALID | Fix the problems named in issues in the template or inputs. | |
| PASS_NOT_ACTIVE | Restore or unvoid the pass first, or use an active one. | |
| PASS_NOT_FOUND | Check the id with GET /api/v1/passes and the key's mode. | |
| PASS_REF_TAKEN | Use a different ref, or update the existing pass. | |
| PASS_REISSUE_REQUIRED | Reissue it with POST /api/v1/passes/bulk-reissue. | |
| PASS_REMOVED | Restore it with POST /api/v1/passes/{id}/restore, then send the request again. | |
| PASS_TRANSFER_NOT_FOUND | Check the transfer id. | |
| PASS_TRANSFER_PENDING | Try again shortly. | |
| 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}. | |
| SCAN_EVENT_NOT_FOUND | Check the event id with GET /api/v1/scan/events. | |
| SCAN_WINDOW_INVALID | Set an end after the start, or fix the template's dates. | |
| SERIAL_TAKEN | Send a different serial, or leave it out to have one generated. | |
| SESSION_REQUIRED | Do it in the console, or sign in as the account that started it. | |
| STAMPS_ABOVE_MAX | Raise the template's stamp maximum, or redeem stamps first. | |
| STAMPS_CARD_FULL | Redeem the reward, then add stamps. | |
| STAMPS_NONE | Use a template with stamps. | |
| STAMPS_NO_REWARD | Add stamps until the card is full, then redeem. | |
| TEMPLATE_NOT_FOUND | Check the id with GET /api/v1/templates and the key's mode. | |
| TEMPLATE_RELEASE_CONFLICT | Send the request again to use the current release. | |
| TEMPLATE_RELEASE_REQUIRED | Approve a release with POST /api/v1/templates/{id}/candidates/{candidateId}/approve. | |
| TERM_MANAGED | Change the term in the connected system. | |
| TERM_NONE | Renew only passes whose template defines a term. | |
| TERM_NOT_STARTED | Renew after the term starts. | |
| UNAUTHENTICATED | Send Authorization: Bearer $PASSBOOK_KEY. | |
| VALIDATION | Fix each field in issues and resend. | |
| VERSION_NOT_FOUND | Check the version with GET /api/v1/passes/{id}. | |
| VERSION_PURGED | Request a newer version. | |
| WORKFLOW_START | Send the request again. |
/api/v1/passes/{id}/renewPath
Returns
200 PassDetail
Errors
| Code | Status | Fix |
|---|---|---|
| ASSET_DIMENSIONS | Resize the image to the size named in issues and upload it again. | |
| ASSET_NOT_FOUND | Check the image name or id and that it belongs to this organization. | |
| ASSET_NOT_PNG | Re-export the image as a standard RGB or RGBA PNG and upload it again. | |
| ASSET_SIZE | Compress the image below 1 MB and upload it again. | |
| ASSET_SLOT | Use a slot name from the pass type's image slots in the request path. | |
| BULK_RUN_ACTIVE | Wait for the running job to finish, then start the new one. | |
| BUNDLE_TOO_LARGE | Split the passes across smaller bundles. | |
| CONNECTION_ORG | Use a connection id from your own organization's GET /api/v1/connections. | |
| CONNECTION_TRANSFER_PENDING | Wait for the transfer to finish, then send the request again. | |
| CREATE_STALE | Look the pass up by externalId with GET /api/v1/passes and update it instead of creating it again. | |
| CREDENTIAL_REF_KEYSET_CONFIG_UNAVAILABLE | Retry with backoff; if it persists, send the requestId to support. | |
| CREDENTIAL_REF_KEYSET_UNAVAILABLE | Retry with backoff; if it persists, send the requestId to support. | |
| DELIVERY_STALE | Review the recipient and try again. | |
| DEVICE_TOKEN_UNAVAILABLE | Retry the request; if it persists, send the requestId to support. | |
| EMAIL_INVALID | Send a valid address in the email field. | |
| EXTERNAL_ID_TAKEN | Send a new externalId, or PATCH the existing pass. | |
| FORBIDDEN | Use a key with the scope the operation lists, or ask an org admin. | |
| IDEMPOTENCY_IN_PROGRESS | Wait a moment and resend the identical request. | |
| IDEMPOTENCY_KEY_INVALID | Send a unique string of 1 to 200 characters, such as a UUID. | |
| IDEMPOTENCY_KEY_REUSED | Use a new key for a new request; resend the identical request to replay. | |
| IF_MATCH_INVALID | Send the version from the last GET, for example If-Match: 3. | |
| IMPORT_BUSY | Wait for it to finish with GET /api/v1/pass-imports/{id}, then retry. | |
| IMPORT_COLUMN_MISSING | Add the column to the file, or change the mapping, then check again. | |
| IMPORT_EXPIRED | Upload the file again with POST /api/v1/pass-imports. | |
| IMPORT_FILE_GONE | Upload it again. | |
| IMPORT_HAS_ERRORS | Fix the rows listed in GET /api/v1/pass-imports/{id}/errors.csv, or skip them, then commit again. | |
| IMPORT_HEADER_TOO_LONG | Shorten the header and upload the file again. | |
| IMPORT_ID_TAKEN | Check the import again with POST /api/v1/pass-imports/{id}/check, then commit. | |
| IMPORT_NOT_FOUND | Check the id with GET /api/v1/pass-imports. | |
| IMPORT_PASS_CHANGED | Remove the pass on its own with POST /api/v1/passes/{id}/remove. | |
| IMPORT_PLAN_INVALID | Fix the mapping entries named in issues and check again. | |
| IMPORT_ROW_UNRESERVED | Retry the commit; if it persists, send the requestId to support. | |
| IMPORT_STATE | Check its state with GET /api/v1/pass-imports/{id} and call the action that state allows. | |
| INVALID_API_KEY | Create a new key in the console and update PASSBOOK_KEY. | |
| INVALID_INPUT | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| JOIN_NOT_READY | Publish the template, then enable the link with PUT /api/v1/join-links/{templateId}. | |
| MATCH_NEEDS_TEMPLATE | Send orgId and templateId with the input filter. | |
| MEMBER_PHOTO_CHANGED | Fetch the pass with GET /api/v1/passes/{id} and save the photo again. | |
| MEMBER_PHOTO_DIMENSIONS | Crop the photo to a 270 by 270 pixel square and upload it again. | |
| MEMBER_PHOTO_ENCODING | Send the photo as a PNG or JPEG file. | |
| MEMBER_PHOTO_NOT_FOUND | Add one with PUT /api/v1/passes/{id}/member-photo. | |
| MEMBER_PHOTO_STYLE | Use a template of that style, or remove the strip image. | |
| MISSING_SCOPE | Create a key with the scope the operation lists under security. | |
| MODE_MISMATCH | Use objects and a key of the same mode. | |
| NEW_CODE_UNSUPPORTED | Reissue the pass with POST /api/v1/passes/bulk-reissue instead of requesting a new code. | |
| 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_ACCESS_CHANGED | Check access with GET /api/v1/api-keys/me, then send the request again. | |
| ORG_FORBIDDEN | Use a key scoped to this organization, or a platform key for platform-wide lists. | |
| ORG_MIXED | Send ids from one organization per request. | |
| ORG_NOT_FOUND | Check orgId with GET /api/v1/orgs. | |
| ORG_REQUIRED | Send orgId with the request, or use a key scoped to one organization. | |
| PASS_CONFLICT | Fetch the pass with GET /api/v1/passes/{id} and send the request again. | |
| PASS_CONNECTION_MISMATCH | Link it with PUT /api/v1/passes/{id}/connection, then send the request again. | |
| PASS_FILE_MISSING | Rebuild it with POST /api/v1/passes/{id}/refresh. | |
| PASS_INPUT_INVALID | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| PASS_INVALID | Fix the problems named in issues in the template or inputs. | |
| PASS_NOT_ACTIVE | Restore or unvoid the pass first, or use an active one. | |
| PASS_NOT_FOUND | Check the id with GET /api/v1/passes and the key's mode. | |
| PASS_REF_TAKEN | Use a different ref, or update the existing pass. | |
| PASS_REISSUE_REQUIRED | Reissue it with POST /api/v1/passes/bulk-reissue. | |
| PASS_REMOVED | Restore it with POST /api/v1/passes/{id}/restore, then send the request again. | |
| PASS_TRANSFER_NOT_FOUND | Check the transfer id. | |
| PASS_TRANSFER_PENDING | Try again shortly. | |
| 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}. | |
| SCAN_EVENT_NOT_FOUND | Check the event id with GET /api/v1/scan/events. | |
| SCAN_WINDOW_INVALID | Set an end after the start, or fix the template's dates. | |
| SERIAL_TAKEN | Send a different serial, or leave it out to have one generated. | |
| SESSION_REQUIRED | Do it in the console, or sign in as the account that started it. | |
| STAMPS_ABOVE_MAX | Raise the template's stamp maximum, or redeem stamps first. | |
| STAMPS_CARD_FULL | Redeem the reward, then add stamps. | |
| STAMPS_NONE | Use a template with stamps. | |
| STAMPS_NO_REWARD | Add stamps until the card is full, then redeem. | |
| TEMPLATE_NOT_FOUND | Check the id with GET /api/v1/templates and the key's mode. | |
| TEMPLATE_RELEASE_CONFLICT | Send the request again to use the current release. | |
| TEMPLATE_RELEASE_REQUIRED | Approve a release with POST /api/v1/templates/{id}/candidates/{candidateId}/approve. | |
| TERM_MANAGED | Change the term in the connected system. | |
| TERM_NONE | Renew only passes whose template defines a term. | |
| TERM_NOT_STARTED | Renew after the term starts. | |
| UNAUTHENTICATED | Send Authorization: Bearer $PASSBOOK_KEY. | |
| VALIDATION | Fix each field in issues and resend. | |
| VERSION_NOT_FOUND | Check the version with GET /api/v1/passes/{id}. | |
| VERSION_PURGED | Request a newer version. | |
| WORKFLOW_START | Send the request again. |
/api/v1/passes/bulkHeaders
1 to 200 characters. A retry with the same key and body returns the first result.
Body
Returns
200
Errors
| Code | Status | Fix |
|---|---|---|
| ASSET_DIMENSIONS | Resize the image to the size named in issues and upload it again. | |
| ASSET_NOT_FOUND | Check the image name or id and that it belongs to this organization. | |
| ASSET_NOT_PNG | Re-export the image as a standard RGB or RGBA PNG and upload it again. | |
| ASSET_SIZE | Compress the image below 1 MB and upload it again. | |
| ASSET_SLOT | Use a slot name from the pass type's image slots in the request path. | |
| BULK_RUN_ACTIVE | Wait for the running job to finish, then start the new one. | |
| BUNDLE_TOO_LARGE | Split the passes across smaller bundles. | |
| CONNECTION_ORG | Use a connection id from your own organization's GET /api/v1/connections. | |
| CONNECTION_TRANSFER_PENDING | Wait for the transfer to finish, then send the request again. | |
| CREATE_STALE | Look the pass up by externalId with GET /api/v1/passes and update it instead of creating it again. | |
| CREDENTIAL_REF_KEYSET_CONFIG_UNAVAILABLE | Retry with backoff; if it persists, send the requestId to support. | |
| CREDENTIAL_REF_KEYSET_UNAVAILABLE | Retry with backoff; if it persists, send the requestId to support. | |
| DELIVERY_STALE | Review the recipient and try again. | |
| DEVICE_TOKEN_UNAVAILABLE | Retry the request; if it persists, send the requestId to support. | |
| EMAIL_INVALID | Send a valid address in the email field. | |
| EXTERNAL_ID_TAKEN | Send a new externalId, or PATCH the existing pass. | |
| FORBIDDEN | Use a key with the scope the operation lists, or ask an org admin. | |
| IDEMPOTENCY_IN_PROGRESS | Wait a moment and resend the identical request. | |
| IDEMPOTENCY_KEY_INVALID | Send a unique string of 1 to 200 characters, such as a UUID. | |
| IDEMPOTENCY_KEY_REUSED | Use a new key for a new request; resend the identical request to replay. | |
| IF_MATCH_INVALID | Send the version from the last GET, for example If-Match: 3. | |
| IMPORT_BUSY | Wait for it to finish with GET /api/v1/pass-imports/{id}, then retry. | |
| IMPORT_COLUMN_MISSING | Add the column to the file, or change the mapping, then check again. | |
| IMPORT_EXPIRED | Upload the file again with POST /api/v1/pass-imports. | |
| IMPORT_FILE_GONE | Upload it again. | |
| IMPORT_HAS_ERRORS | Fix the rows listed in GET /api/v1/pass-imports/{id}/errors.csv, or skip them, then commit again. | |
| IMPORT_HEADER_TOO_LONG | Shorten the header and upload the file again. | |
| IMPORT_ID_TAKEN | Check the import again with POST /api/v1/pass-imports/{id}/check, then commit. | |
| IMPORT_NOT_FOUND | Check the id with GET /api/v1/pass-imports. | |
| IMPORT_PASS_CHANGED | Remove the pass on its own with POST /api/v1/passes/{id}/remove. | |
| IMPORT_PLAN_INVALID | Fix the mapping entries named in issues and check again. | |
| IMPORT_ROW_UNRESERVED | Retry the commit; if it persists, send the requestId to support. | |
| IMPORT_STATE | Check its state with GET /api/v1/pass-imports/{id} and call the action that state allows. | |
| INVALID_API_KEY | Create a new key in the console and update PASSBOOK_KEY. | |
| INVALID_INPUT | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| JOIN_NOT_READY | Publish the template, then enable the link with PUT /api/v1/join-links/{templateId}. | |
| MATCH_NEEDS_TEMPLATE | Send orgId and templateId with the input filter. | |
| MEMBER_PHOTO_CHANGED | Fetch the pass with GET /api/v1/passes/{id} and save the photo again. | |
| MEMBER_PHOTO_DIMENSIONS | Crop the photo to a 270 by 270 pixel square and upload it again. | |
| MEMBER_PHOTO_ENCODING | Send the photo as a PNG or JPEG file. | |
| MEMBER_PHOTO_NOT_FOUND | Add one with PUT /api/v1/passes/{id}/member-photo. | |
| MEMBER_PHOTO_STYLE | Use a template of that style, or remove the strip image. | |
| MISSING_SCOPE | Create a key with the scope the operation lists under security. | |
| MODE_MISMATCH | Use objects and a key of the same mode. | |
| NEW_CODE_UNSUPPORTED | Reissue the pass with POST /api/v1/passes/bulk-reissue instead of requesting a new code. | |
| NO_RECIPIENT | Set the holder's email with PATCH /api/v1/passes/{id}, then send again. | |
| ORG_ACCESS_CHANGED | Check access with GET /api/v1/api-keys/me, then send the request again. | |
| ORG_FORBIDDEN | Use a key scoped to this organization, or a platform key for platform-wide lists. | |
| ORG_MIXED | Send ids from one organization per request. | |
| ORG_NOT_FOUND | Check orgId with GET /api/v1/orgs. | |
| ORG_REQUIRED | Send orgId with the request, or use a key scoped to one organization. | |
| PASS_CONFLICT | Fetch the pass with GET /api/v1/passes/{id} and send the request again. | |
| PASS_CONNECTION_MISMATCH | Link it with PUT /api/v1/passes/{id}/connection, then send the request again. | |
| PASS_FILE_MISSING | Rebuild it with POST /api/v1/passes/{id}/refresh. | |
| PASS_INPUT_INVALID | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| PASS_INVALID | Fix the problems named in issues in the template or inputs. | |
| PASS_NOT_ACTIVE | Restore or unvoid the pass first, or use an active one. | |
| PASS_NOT_FOUND | Check the id with GET /api/v1/passes and the key's mode. | |
| PASS_REF_TAKEN | Use a different ref, or update the existing pass. | |
| PASS_REISSUE_REQUIRED | Reissue it with POST /api/v1/passes/bulk-reissue. | |
| PASS_REMOVED | Restore it with POST /api/v1/passes/{id}/restore, then send the request again. | |
| PASS_TRANSFER_NOT_FOUND | Check the transfer id. | |
| PASS_TRANSFER_PENDING | Try again shortly. | |
| 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}. | |
| SCAN_EVENT_NOT_FOUND | Check the event id with GET /api/v1/scan/events. | |
| SCAN_WINDOW_INVALID | Set an end after the start, or fix the template's dates. | |
| SERIAL_TAKEN | Send a different serial, or leave it out to have one generated. | |
| SESSION_REQUIRED | Do it in the console, or sign in as the account that started it. | |
| STAMPS_ABOVE_MAX | Raise the template's stamp maximum, or redeem stamps first. | |
| STAMPS_CARD_FULL | Redeem the reward, then add stamps. | |
| STAMPS_NONE | Use a template with stamps. | |
| STAMPS_NO_REWARD | Add stamps until the card is full, then redeem. | |
| TEMPLATE_NOT_FOUND | Check the id with GET /api/v1/templates and the key's mode. | |
| TEMPLATE_RELEASE_CONFLICT | Send the request again to use the current release. | |
| TEMPLATE_RELEASE_REQUIRED | Approve a release with POST /api/v1/templates/{id}/candidates/{candidateId}/approve. | |
| TERM_MANAGED | Change the term in the connected system. | |
| TERM_NONE | Renew only passes whose template defines a term. | |
| TERM_NOT_STARTED | Renew after the term starts. | |
| UNAUTHENTICATED | Send Authorization: Bearer $PASSBOOK_KEY. | |
| VALIDATION | Fix each field in issues and resend. | |
| VERSION_NOT_FOUND | Check the version with GET /api/v1/passes/{id}. | |
| VERSION_PURGED | Request a newer version. | |
| WORKFLOW_START | Send the request again. |
/api/v1/passes/bulk-reissueBody
Returns
202
Errors
| Code | Status | Fix |
|---|---|---|
| ASSET_DIMENSIONS | Resize the image to the size named in issues and upload it again. | |
| ASSET_NOT_FOUND | Check the image name or id and that it belongs to this organization. | |
| ASSET_NOT_PNG | Re-export the image as a standard RGB or RGBA PNG and upload it again. | |
| ASSET_SIZE | Compress the image below 1 MB and upload it again. | |
| ASSET_SLOT | Use a slot name from the pass type's image slots in the request path. | |
| BULK_RUN_ACTIVE | Wait for the running job to finish, then start the new one. | |
| BUNDLE_TOO_LARGE | Split the passes across smaller bundles. | |
| CONNECTION_ORG | Use a connection id from your own organization's GET /api/v1/connections. | |
| CONNECTION_TRANSFER_PENDING | Wait for the transfer to finish, then send the request again. | |
| CREATE_STALE | Look the pass up by externalId with GET /api/v1/passes and update it instead of creating it again. | |
| CREDENTIAL_REF_KEYSET_CONFIG_UNAVAILABLE | Retry with backoff; if it persists, send the requestId to support. | |
| CREDENTIAL_REF_KEYSET_UNAVAILABLE | Retry with backoff; if it persists, send the requestId to support. | |
| DELIVERY_STALE | Review the recipient and try again. | |
| DEVICE_TOKEN_UNAVAILABLE | Retry the request; if it persists, send the requestId to support. | |
| EMAIL_INVALID | Send a valid address in the email field. | |
| EXTERNAL_ID_TAKEN | Send a new externalId, or PATCH the existing pass. | |
| FORBIDDEN | Use a key with the scope the operation lists, or ask an org admin. | |
| IDEMPOTENCY_IN_PROGRESS | Wait a moment and resend the identical request. | |
| IDEMPOTENCY_KEY_INVALID | Send a unique string of 1 to 200 characters, such as a UUID. | |
| IDEMPOTENCY_KEY_REUSED | Use a new key for a new request; resend the identical request to replay. | |
| IF_MATCH_INVALID | Send the version from the last GET, for example If-Match: 3. | |
| IMPORT_BUSY | Wait for it to finish with GET /api/v1/pass-imports/{id}, then retry. | |
| IMPORT_COLUMN_MISSING | Add the column to the file, or change the mapping, then check again. | |
| IMPORT_EXPIRED | Upload the file again with POST /api/v1/pass-imports. | |
| IMPORT_FILE_GONE | Upload it again. | |
| IMPORT_HAS_ERRORS | Fix the rows listed in GET /api/v1/pass-imports/{id}/errors.csv, or skip them, then commit again. | |
| IMPORT_HEADER_TOO_LONG | Shorten the header and upload the file again. | |
| IMPORT_ID_TAKEN | Check the import again with POST /api/v1/pass-imports/{id}/check, then commit. | |
| IMPORT_NOT_FOUND | Check the id with GET /api/v1/pass-imports. | |
| IMPORT_PASS_CHANGED | Remove the pass on its own with POST /api/v1/passes/{id}/remove. | |
| IMPORT_PLAN_INVALID | Fix the mapping entries named in issues and check again. | |
| IMPORT_ROW_UNRESERVED | Retry the commit; if it persists, send the requestId to support. | |
| IMPORT_STATE | Check its state with GET /api/v1/pass-imports/{id} and call the action that state allows. | |
| INVALID_API_KEY | Create a new key in the console and update PASSBOOK_KEY. | |
| INVALID_INPUT | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| JOIN_NOT_READY | Publish the template, then enable the link with PUT /api/v1/join-links/{templateId}. | |
| MATCH_NEEDS_TEMPLATE | Send orgId and templateId with the input filter. | |
| MEMBER_PHOTO_CHANGED | Fetch the pass with GET /api/v1/passes/{id} and save the photo again. | |
| MEMBER_PHOTO_DIMENSIONS | Crop the photo to a 270 by 270 pixel square and upload it again. | |
| MEMBER_PHOTO_ENCODING | Send the photo as a PNG or JPEG file. | |
| MEMBER_PHOTO_NOT_FOUND | Add one with PUT /api/v1/passes/{id}/member-photo. | |
| MEMBER_PHOTO_STYLE | Use a template of that style, or remove the strip image. | |
| MISSING_SCOPE | Create a key with the scope the operation lists under security. | |
| MODE_MISMATCH | Use objects and a key of the same mode. | |
| NEW_CODE_UNSUPPORTED | Reissue the pass with POST /api/v1/passes/bulk-reissue instead of requesting a new code. | |
| NO_RECIPIENT | Set the holder's email with PATCH /api/v1/passes/{id}, then send again. | |
| ORG_ACCESS_CHANGED | Check access with GET /api/v1/api-keys/me, then send the request again. | |
| ORG_FORBIDDEN | Use a key scoped to this organization, or a platform key for platform-wide lists. | |
| ORG_MIXED | Send ids from one organization per request. | |
| ORG_NOT_FOUND | Check orgId with GET /api/v1/orgs. | |
| ORG_REQUIRED | Send orgId with the request, or use a key scoped to one organization. | |
| PASS_CONFLICT | Fetch the pass with GET /api/v1/passes/{id} and send the request again. | |
| PASS_CONNECTION_MISMATCH | Link it with PUT /api/v1/passes/{id}/connection, then send the request again. | |
| PASS_FILE_MISSING | Rebuild it with POST /api/v1/passes/{id}/refresh. | |
| PASS_INPUT_INVALID | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| PASS_INVALID | Fix the problems named in issues in the template or inputs. | |
| PASS_NOT_ACTIVE | Restore or unvoid the pass first, or use an active one. | |
| PASS_NOT_FOUND | Check the id with GET /api/v1/passes and the key's mode. | |
| PASS_REF_TAKEN | Use a different ref, or update the existing pass. | |
| PASS_REISSUE_REQUIRED | Reissue it with POST /api/v1/passes/bulk-reissue. | |
| PASS_REMOVED | Restore it with POST /api/v1/passes/{id}/restore, then send the request again. | |
| PASS_TRANSFER_NOT_FOUND | Check the transfer id. | |
| PASS_TRANSFER_PENDING | Try again shortly. | |
| 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}. | |
| SCAN_EVENT_NOT_FOUND | Check the event id with GET /api/v1/scan/events. | |
| SCAN_WINDOW_INVALID | Set an end after the start, or fix the template's dates. | |
| SERIAL_TAKEN | Send a different serial, or leave it out to have one generated. | |
| SESSION_REQUIRED | Do it in the console, or sign in as the account that started it. | |
| STAMPS_ABOVE_MAX | Raise the template's stamp maximum, or redeem stamps first. | |
| STAMPS_CARD_FULL | Redeem the reward, then add stamps. | |
| STAMPS_NONE | Use a template with stamps. | |
| STAMPS_NO_REWARD | Add stamps until the card is full, then redeem. | |
| TEMPLATE_NOT_FOUND | Check the id with GET /api/v1/templates and the key's mode. | |
| TEMPLATE_RELEASE_CONFLICT | Send the request again to use the current release. | |
| TEMPLATE_RELEASE_REQUIRED | Approve a release with POST /api/v1/templates/{id}/candidates/{candidateId}/approve. | |
| TERM_MANAGED | Change the term in the connected system. | |
| TERM_NONE | Renew only passes whose template defines a term. | |
| TERM_NOT_STARTED | Renew after the term starts. | |
| UNAUTHENTICATED | Send Authorization: Bearer $PASSBOOK_KEY. | |
| VALIDATION | Fix each field in issues and resend. | |
| VERSION_NOT_FOUND | Check the version with GET /api/v1/passes/{id}. | |
| VERSION_PURGED | Request a newer version. | |
| WORKFLOW_START | Send the request again. |
/api/v1/passes/bulk/channelsBody
Returns
200
Errors
| Code | Status | Fix |
|---|---|---|
| ASSET_DIMENSIONS | Resize the image to the size named in issues and upload it again. | |
| ASSET_NOT_FOUND | Check the image name or id and that it belongs to this organization. | |
| ASSET_NOT_PNG | Re-export the image as a standard RGB or RGBA PNG and upload it again. | |
| ASSET_SIZE | Compress the image below 1 MB and upload it again. | |
| ASSET_SLOT | Use a slot name from the pass type's image slots in the request path. | |
| BULK_RUN_ACTIVE | Wait for the running job to finish, then start the new one. | |
| BUNDLE_TOO_LARGE | Split the passes across smaller bundles. | |
| CONNECTION_ORG | Use a connection id from your own organization's GET /api/v1/connections. | |
| CONNECTION_TRANSFER_PENDING | Wait for the transfer to finish, then send the request again. | |
| CREATE_STALE | Look the pass up by externalId with GET /api/v1/passes and update it instead of creating it again. | |
| CREDENTIAL_REF_KEYSET_CONFIG_UNAVAILABLE | Retry with backoff; if it persists, send the requestId to support. | |
| CREDENTIAL_REF_KEYSET_UNAVAILABLE | Retry with backoff; if it persists, send the requestId to support. | |
| DELIVERY_STALE | Review the recipient and try again. | |
| DEVICE_TOKEN_UNAVAILABLE | Retry the request; if it persists, send the requestId to support. | |
| EMAIL_INVALID | Send a valid address in the email field. | |
| EXTERNAL_ID_TAKEN | Send a new externalId, or PATCH the existing pass. | |
| FORBIDDEN | Use a key with the scope the operation lists, or ask an org admin. | |
| IDEMPOTENCY_IN_PROGRESS | Wait a moment and resend the identical request. | |
| IDEMPOTENCY_KEY_INVALID | Send a unique string of 1 to 200 characters, such as a UUID. | |
| IDEMPOTENCY_KEY_REUSED | Use a new key for a new request; resend the identical request to replay. | |
| IF_MATCH_INVALID | Send the version from the last GET, for example If-Match: 3. | |
| IMPORT_BUSY | Wait for it to finish with GET /api/v1/pass-imports/{id}, then retry. | |
| IMPORT_COLUMN_MISSING | Add the column to the file, or change the mapping, then check again. | |
| IMPORT_EXPIRED | Upload the file again with POST /api/v1/pass-imports. | |
| IMPORT_FILE_GONE | Upload it again. | |
| IMPORT_HAS_ERRORS | Fix the rows listed in GET /api/v1/pass-imports/{id}/errors.csv, or skip them, then commit again. | |
| IMPORT_HEADER_TOO_LONG | Shorten the header and upload the file again. | |
| IMPORT_ID_TAKEN | Check the import again with POST /api/v1/pass-imports/{id}/check, then commit. | |
| IMPORT_NOT_FOUND | Check the id with GET /api/v1/pass-imports. | |
| IMPORT_PASS_CHANGED | Remove the pass on its own with POST /api/v1/passes/{id}/remove. | |
| IMPORT_PLAN_INVALID | Fix the mapping entries named in issues and check again. | |
| IMPORT_ROW_UNRESERVED | Retry the commit; if it persists, send the requestId to support. | |
| IMPORT_STATE | Check its state with GET /api/v1/pass-imports/{id} and call the action that state allows. | |
| INVALID_API_KEY | Create a new key in the console and update PASSBOOK_KEY. | |
| INVALID_INPUT | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| JOIN_NOT_READY | Publish the template, then enable the link with PUT /api/v1/join-links/{templateId}. | |
| MATCH_NEEDS_TEMPLATE | Send orgId and templateId with the input filter. | |
| MEMBER_PHOTO_CHANGED | Fetch the pass with GET /api/v1/passes/{id} and save the photo again. | |
| MEMBER_PHOTO_DIMENSIONS | Crop the photo to a 270 by 270 pixel square and upload it again. | |
| MEMBER_PHOTO_ENCODING | Send the photo as a PNG or JPEG file. | |
| MEMBER_PHOTO_NOT_FOUND | Add one with PUT /api/v1/passes/{id}/member-photo. | |
| MEMBER_PHOTO_STYLE | Use a template of that style, or remove the strip image. | |
| MISSING_SCOPE | Create a key with the scope the operation lists under security. | |
| MODE_MISMATCH | Use objects and a key of the same mode. | |
| NEW_CODE_UNSUPPORTED | Reissue the pass with POST /api/v1/passes/bulk-reissue instead of requesting a new code. | |
| NO_RECIPIENT | Set the holder's email with PATCH /api/v1/passes/{id}, then send again. | |
| ORG_ACCESS_CHANGED | Check access with GET /api/v1/api-keys/me, then send the request again. | |
| ORG_FORBIDDEN | Use a key scoped to this organization, or a platform key for platform-wide lists. | |
| ORG_MIXED | Send ids from one organization per request. | |
| ORG_NOT_FOUND | Check orgId with GET /api/v1/orgs. | |
| ORG_REQUIRED | Send orgId with the request, or use a key scoped to one organization. | |
| PASS_CONFLICT | Fetch the pass with GET /api/v1/passes/{id} and send the request again. | |
| PASS_CONNECTION_MISMATCH | Link it with PUT /api/v1/passes/{id}/connection, then send the request again. | |
| PASS_FILE_MISSING | Rebuild it with POST /api/v1/passes/{id}/refresh. | |
| PASS_INPUT_INVALID | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| PASS_INVALID | Fix the problems named in issues in the template or inputs. | |
| PASS_NOT_ACTIVE | Restore or unvoid the pass first, or use an active one. | |
| PASS_NOT_FOUND | Check the id with GET /api/v1/passes and the key's mode. | |
| PASS_REF_TAKEN | Use a different ref, or update the existing pass. | |
| PASS_REISSUE_REQUIRED | Reissue it with POST /api/v1/passes/bulk-reissue. | |
| PASS_REMOVED | Restore it with POST /api/v1/passes/{id}/restore, then send the request again. | |
| PASS_TRANSFER_NOT_FOUND | Check the transfer id. | |
| PASS_TRANSFER_PENDING | Try again shortly. | |
| 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}. | |
| SCAN_EVENT_NOT_FOUND | Check the event id with GET /api/v1/scan/events. | |
| SCAN_WINDOW_INVALID | Set an end after the start, or fix the template's dates. | |
| SERIAL_TAKEN | Send a different serial, or leave it out to have one generated. | |
| SESSION_REQUIRED | Do it in the console, or sign in as the account that started it. | |
| STAMPS_ABOVE_MAX | Raise the template's stamp maximum, or redeem stamps first. | |
| STAMPS_CARD_FULL | Redeem the reward, then add stamps. | |
| STAMPS_NONE | Use a template with stamps. | |
| STAMPS_NO_REWARD | Add stamps until the card is full, then redeem. | |
| TEMPLATE_NOT_FOUND | Check the id with GET /api/v1/templates and the key's mode. | |
| TEMPLATE_RELEASE_CONFLICT | Send the request again to use the current release. | |
| TEMPLATE_RELEASE_REQUIRED | Approve a release with POST /api/v1/templates/{id}/candidates/{candidateId}/approve. | |
| TERM_MANAGED | Change the term in the connected system. | |
| TERM_NONE | Renew only passes whose template defines a term. | |
| TERM_NOT_STARTED | Renew after the term starts. | |
| UNAUTHENTICATED | Send Authorization: Bearer $PASSBOOK_KEY. | |
| VALIDATION | Fix each field in issues and resend. | |
| VERSION_NOT_FOUND | Check the version with GET /api/v1/passes/{id}. | |
| VERSION_PURGED | Request a newer version. | |
| WORKFLOW_START | Send the request again. |
/api/v1/passes/{id}/removeRemoves the pass from Wallet by publishing a voided, expired final version. The record stays; undo with restore. message shows on the lock screen.
Path
Body
Returns
200 PassSummary
Errors
| Code | Status | Fix |
|---|---|---|
| ASSET_DIMENSIONS | Resize the image to the size named in issues and upload it again. | |
| ASSET_NOT_FOUND | Check the image name or id and that it belongs to this organization. | |
| ASSET_NOT_PNG | Re-export the image as a standard RGB or RGBA PNG and upload it again. | |
| ASSET_SIZE | Compress the image below 1 MB and upload it again. | |
| ASSET_SLOT | Use a slot name from the pass type's image slots in the request path. | |
| BULK_RUN_ACTIVE | Wait for the running job to finish, then start the new one. | |
| BUNDLE_TOO_LARGE | Split the passes across smaller bundles. | |
| CONNECTION_ORG | Use a connection id from your own organization's GET /api/v1/connections. | |
| CONNECTION_TRANSFER_PENDING | Wait for the transfer to finish, then send the request again. | |
| CREATE_STALE | Look the pass up by externalId with GET /api/v1/passes and update it instead of creating it again. | |
| CREDENTIAL_REF_KEYSET_CONFIG_UNAVAILABLE | Retry with backoff; if it persists, send the requestId to support. | |
| CREDENTIAL_REF_KEYSET_UNAVAILABLE | Retry with backoff; if it persists, send the requestId to support. | |
| DELIVERY_STALE | Review the recipient and try again. | |
| DEVICE_TOKEN_UNAVAILABLE | Retry the request; if it persists, send the requestId to support. | |
| EMAIL_INVALID | Send a valid address in the email field. | |
| EXTERNAL_ID_TAKEN | Send a new externalId, or PATCH the existing pass. | |
| FORBIDDEN | Use a key with the scope the operation lists, or ask an org admin. | |
| IDEMPOTENCY_IN_PROGRESS | Wait a moment and resend the identical request. | |
| IDEMPOTENCY_KEY_INVALID | Send a unique string of 1 to 200 characters, such as a UUID. | |
| IDEMPOTENCY_KEY_REUSED | Use a new key for a new request; resend the identical request to replay. | |
| IF_MATCH_INVALID | Send the version from the last GET, for example If-Match: 3. | |
| IMPORT_BUSY | Wait for it to finish with GET /api/v1/pass-imports/{id}, then retry. | |
| IMPORT_COLUMN_MISSING | Add the column to the file, or change the mapping, then check again. | |
| IMPORT_EXPIRED | Upload the file again with POST /api/v1/pass-imports. | |
| IMPORT_FILE_GONE | Upload it again. | |
| IMPORT_HAS_ERRORS | Fix the rows listed in GET /api/v1/pass-imports/{id}/errors.csv, or skip them, then commit again. | |
| IMPORT_HEADER_TOO_LONG | Shorten the header and upload the file again. | |
| IMPORT_ID_TAKEN | Check the import again with POST /api/v1/pass-imports/{id}/check, then commit. | |
| IMPORT_NOT_FOUND | Check the id with GET /api/v1/pass-imports. | |
| IMPORT_PASS_CHANGED | Remove the pass on its own with POST /api/v1/passes/{id}/remove. | |
| IMPORT_PLAN_INVALID | Fix the mapping entries named in issues and check again. | |
| IMPORT_ROW_UNRESERVED | Retry the commit; if it persists, send the requestId to support. | |
| IMPORT_STATE | Check its state with GET /api/v1/pass-imports/{id} and call the action that state allows. | |
| INVALID_API_KEY | Create a new key in the console and update PASSBOOK_KEY. | |
| INVALID_INPUT | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| JOIN_NOT_READY | Publish the template, then enable the link with PUT /api/v1/join-links/{templateId}. | |
| MATCH_NEEDS_TEMPLATE | Send orgId and templateId with the input filter. | |
| MEMBER_PHOTO_CHANGED | Fetch the pass with GET /api/v1/passes/{id} and save the photo again. | |
| MEMBER_PHOTO_DIMENSIONS | Crop the photo to a 270 by 270 pixel square and upload it again. | |
| MEMBER_PHOTO_ENCODING | Send the photo as a PNG or JPEG file. | |
| MEMBER_PHOTO_NOT_FOUND | Add one with PUT /api/v1/passes/{id}/member-photo. | |
| MEMBER_PHOTO_STYLE | Use a template of that style, or remove the strip image. | |
| MISSING_SCOPE | Create a key with the scope the operation lists under security. | |
| MODE_MISMATCH | Use objects and a key of the same mode. | |
| NEW_CODE_UNSUPPORTED | Reissue the pass with POST /api/v1/passes/bulk-reissue instead of requesting a new code. | |
| 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_ACCESS_CHANGED | Check access with GET /api/v1/api-keys/me, then send the request again. | |
| ORG_FORBIDDEN | Use a key scoped to this organization, or a platform key for platform-wide lists. | |
| ORG_MIXED | Send ids from one organization per request. | |
| ORG_NOT_FOUND | Check orgId with GET /api/v1/orgs. | |
| ORG_REQUIRED | Send orgId with the request, or use a key scoped to one organization. | |
| PASS_CONFLICT | Fetch the pass with GET /api/v1/passes/{id} and send the request again. | |
| PASS_CONNECTION_MISMATCH | Link it with PUT /api/v1/passes/{id}/connection, then send the request again. | |
| PASS_FILE_MISSING | Rebuild it with POST /api/v1/passes/{id}/refresh. | |
| PASS_INPUT_INVALID | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| PASS_INVALID | Fix the problems named in issues in the template or inputs. | |
| PASS_NOT_ACTIVE | Restore or unvoid the pass first, or use an active one. | |
| PASS_NOT_FOUND | Check the id with GET /api/v1/passes and the key's mode. | |
| PASS_REF_TAKEN | Use a different ref, or update the existing pass. | |
| PASS_REISSUE_REQUIRED | Reissue it with POST /api/v1/passes/bulk-reissue. | |
| PASS_REMOVED | Restore it with POST /api/v1/passes/{id}/restore, then send the request again. | |
| PASS_TRANSFER_NOT_FOUND | Check the transfer id. | |
| PASS_TRANSFER_PENDING | Try again shortly. | |
| 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}. | |
| SCAN_EVENT_NOT_FOUND | Check the event id with GET /api/v1/scan/events. | |
| SCAN_WINDOW_INVALID | Set an end after the start, or fix the template's dates. | |
| SERIAL_TAKEN | Send a different serial, or leave it out to have one generated. | |
| SESSION_REQUIRED | Do it in the console, or sign in as the account that started it. | |
| STAMPS_ABOVE_MAX | Raise the template's stamp maximum, or redeem stamps first. | |
| STAMPS_CARD_FULL | Redeem the reward, then add stamps. | |
| STAMPS_NONE | Use a template with stamps. | |
| STAMPS_NO_REWARD | Add stamps until the card is full, then redeem. | |
| TEMPLATE_NOT_FOUND | Check the id with GET /api/v1/templates and the key's mode. | |
| TEMPLATE_RELEASE_CONFLICT | Send the request again to use the current release. | |
| TEMPLATE_RELEASE_REQUIRED | Approve a release with POST /api/v1/templates/{id}/candidates/{candidateId}/approve. | |
| TERM_MANAGED | Change the term in the connected system. | |
| TERM_NONE | Renew only passes whose template defines a term. | |
| TERM_NOT_STARTED | Renew after the term starts. | |
| UNAUTHENTICATED | Send Authorization: Bearer $PASSBOOK_KEY. | |
| VALIDATION | Fix each field in issues and resend. | |
| VERSION_NOT_FOUND | Check the version with GET /api/v1/passes/{id}. | |
| VERSION_PURGED | Request a newer version. | |
| WORKFLOW_START | Send the request again. |
/api/v1/passes/{id}/restoreUndoes a removal and publishes the pass again.
Path
Returns
200 PassSummary
Errors
| Code | Status | Fix |
|---|---|---|
| ASSET_DIMENSIONS | Resize the image to the size named in issues and upload it again. | |
| ASSET_NOT_FOUND | Check the image name or id and that it belongs to this organization. | |
| ASSET_NOT_PNG | Re-export the image as a standard RGB or RGBA PNG and upload it again. | |
| ASSET_SIZE | Compress the image below 1 MB and upload it again. | |
| ASSET_SLOT | Use a slot name from the pass type's image slots in the request path. | |
| BULK_RUN_ACTIVE | Wait for the running job to finish, then start the new one. | |
| BUNDLE_TOO_LARGE | Split the passes across smaller bundles. | |
| CONNECTION_ORG | Use a connection id from your own organization's GET /api/v1/connections. | |
| CONNECTION_TRANSFER_PENDING | Wait for the transfer to finish, then send the request again. | |
| CREATE_STALE | Look the pass up by externalId with GET /api/v1/passes and update it instead of creating it again. | |
| CREDENTIAL_REF_KEYSET_CONFIG_UNAVAILABLE | Retry with backoff; if it persists, send the requestId to support. | |
| CREDENTIAL_REF_KEYSET_UNAVAILABLE | Retry with backoff; if it persists, send the requestId to support. | |
| DELIVERY_STALE | Review the recipient and try again. | |
| DEVICE_TOKEN_UNAVAILABLE | Retry the request; if it persists, send the requestId to support. | |
| EMAIL_INVALID | Send a valid address in the email field. | |
| EXTERNAL_ID_TAKEN | Send a new externalId, or PATCH the existing pass. | |
| FORBIDDEN | Use a key with the scope the operation lists, or ask an org admin. | |
| IDEMPOTENCY_IN_PROGRESS | Wait a moment and resend the identical request. | |
| IDEMPOTENCY_KEY_INVALID | Send a unique string of 1 to 200 characters, such as a UUID. | |
| IDEMPOTENCY_KEY_REUSED | Use a new key for a new request; resend the identical request to replay. | |
| IF_MATCH_INVALID | Send the version from the last GET, for example If-Match: 3. | |
| IMPORT_BUSY | Wait for it to finish with GET /api/v1/pass-imports/{id}, then retry. | |
| IMPORT_COLUMN_MISSING | Add the column to the file, or change the mapping, then check again. | |
| IMPORT_EXPIRED | Upload the file again with POST /api/v1/pass-imports. | |
| IMPORT_FILE_GONE | Upload it again. | |
| IMPORT_HAS_ERRORS | Fix the rows listed in GET /api/v1/pass-imports/{id}/errors.csv, or skip them, then commit again. | |
| IMPORT_HEADER_TOO_LONG | Shorten the header and upload the file again. | |
| IMPORT_ID_TAKEN | Check the import again with POST /api/v1/pass-imports/{id}/check, then commit. | |
| IMPORT_NOT_FOUND | Check the id with GET /api/v1/pass-imports. | |
| IMPORT_PASS_CHANGED | Remove the pass on its own with POST /api/v1/passes/{id}/remove. | |
| IMPORT_PLAN_INVALID | Fix the mapping entries named in issues and check again. | |
| IMPORT_ROW_UNRESERVED | Retry the commit; if it persists, send the requestId to support. | |
| IMPORT_STATE | Check its state with GET /api/v1/pass-imports/{id} and call the action that state allows. | |
| INVALID_API_KEY | Create a new key in the console and update PASSBOOK_KEY. | |
| INVALID_INPUT | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| JOIN_NOT_READY | Publish the template, then enable the link with PUT /api/v1/join-links/{templateId}. | |
| MATCH_NEEDS_TEMPLATE | Send orgId and templateId with the input filter. | |
| MEMBER_PHOTO_CHANGED | Fetch the pass with GET /api/v1/passes/{id} and save the photo again. | |
| MEMBER_PHOTO_DIMENSIONS | Crop the photo to a 270 by 270 pixel square and upload it again. | |
| MEMBER_PHOTO_ENCODING | Send the photo as a PNG or JPEG file. | |
| MEMBER_PHOTO_NOT_FOUND | Add one with PUT /api/v1/passes/{id}/member-photo. | |
| MEMBER_PHOTO_STYLE | Use a template of that style, or remove the strip image. | |
| MISSING_SCOPE | Create a key with the scope the operation lists under security. | |
| MODE_MISMATCH | Use objects and a key of the same mode. | |
| NEW_CODE_UNSUPPORTED | Reissue the pass with POST /api/v1/passes/bulk-reissue instead of requesting a new code. | |
| 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_ACCESS_CHANGED | Check access with GET /api/v1/api-keys/me, then send the request again. | |
| ORG_FORBIDDEN | Use a key scoped to this organization, or a platform key for platform-wide lists. | |
| ORG_MIXED | Send ids from one organization per request. | |
| ORG_NOT_FOUND | Check orgId with GET /api/v1/orgs. | |
| ORG_REQUIRED | Send orgId with the request, or use a key scoped to one organization. | |
| PASS_CONFLICT | Fetch the pass with GET /api/v1/passes/{id} and send the request again. | |
| PASS_CONNECTION_MISMATCH | Link it with PUT /api/v1/passes/{id}/connection, then send the request again. | |
| PASS_FILE_MISSING | Rebuild it with POST /api/v1/passes/{id}/refresh. | |
| PASS_INPUT_INVALID | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| PASS_INVALID | Fix the problems named in issues in the template or inputs. | |
| PASS_NOT_ACTIVE | Restore or unvoid the pass first, or use an active one. | |
| PASS_NOT_FOUND | Check the id with GET /api/v1/passes and the key's mode. | |
| PASS_REF_TAKEN | Use a different ref, or update the existing pass. | |
| PASS_REISSUE_REQUIRED | Reissue it with POST /api/v1/passes/bulk-reissue. | |
| PASS_REMOVED | Restore it with POST /api/v1/passes/{id}/restore, then send the request again. | |
| PASS_TRANSFER_NOT_FOUND | Check the transfer id. | |
| PASS_TRANSFER_PENDING | Try again shortly. | |
| 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}. | |
| SCAN_EVENT_NOT_FOUND | Check the event id with GET /api/v1/scan/events. | |
| SCAN_WINDOW_INVALID | Set an end after the start, or fix the template's dates. | |
| SERIAL_TAKEN | Send a different serial, or leave it out to have one generated. | |
| SESSION_REQUIRED | Do it in the console, or sign in as the account that started it. | |
| STAMPS_ABOVE_MAX | Raise the template's stamp maximum, or redeem stamps first. | |
| STAMPS_CARD_FULL | Redeem the reward, then add stamps. | |
| STAMPS_NONE | Use a template with stamps. | |
| STAMPS_NO_REWARD | Add stamps until the card is full, then redeem. | |
| TEMPLATE_NOT_FOUND | Check the id with GET /api/v1/templates and the key's mode. | |
| TEMPLATE_RELEASE_CONFLICT | Send the request again to use the current release. | |
| TEMPLATE_RELEASE_REQUIRED | Approve a release with POST /api/v1/templates/{id}/candidates/{candidateId}/approve. | |
| TERM_MANAGED | Change the term in the connected system. | |
| TERM_NONE | Renew only passes whose template defines a term. | |
| TERM_NOT_STARTED | Renew after the term starts. | |
| UNAUTHENTICATED | Send Authorization: Bearer $PASSBOOK_KEY. | |
| VALIDATION | Fix each field in issues and resend. | |
| VERSION_NOT_FOUND | Check the version with GET /api/v1/passes/{id}. | |
| VERSION_PURGED | Request a newer version. | |
| WORKFLOW_START | Send the request again. |
/api/v1/wallet-providers/passes/{id}Path
Returns
200
Errors
| Code | Status | Fix |
|---|---|---|
| FORBIDDEN | Use a key with the scope the operation lists, or ask an org admin. | |
| GOOGLE_CALLBACK_INVALID | Send callbacks only from Google; check the callback URL set in Google Wallet. | |
| GOOGLE_CALLBACK_UNAVAILABLE | Retry with backoff; Google resends failed callbacks. | |
| GOOGLE_ISSUER_NOT_OWNED | Share an issuer your Google account owns, then send the request again. | |
| GOOGLE_ISSUER_NOT_SHARED | Share the issuer in the Google Pay and Wallet console, then send the request again. | |
| GOOGLE_UNAVAILABLE | Send the request again in a minute. | |
| IAM_BAD_ACCOUNT | Send the request again; contact support if it repeats. | |
| IAM_BAD_KEY | Send the request again; contact support if it repeats. | |
| INVALID_API_KEY | Create a new key in the console and update PASSBOOK_KEY. | |
| 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. | |
| ORG_NOT_FOUND | Check orgId with GET /api/v1/orgs. | |
| 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. | |
| SAMSUNG_FIELDS_INVALID | Send callbacks only from Samsung Wallet; check the callback setup. | |
| SAMSUNG_UNAUTHENTICATED | Check the Samsung Wallet partner credentials stored for the organization. | |
| SAMSUNG_UNAVAILABLE | Retry with backoff. | |
| TEMPLATE_MODE_MISMATCH | Use a key of the template's mode. | |
| TEMPLATE_SELF_APPROVAL | Have a different member approve the candidate. | |
| UNAUTHENTICATED | Send Authorization: Bearer $PASSBOOK_KEY. | |
| VALIDATION | Fix each field in issues and resend. | |
| WALLET_ACCOUNT_CONFLICT | Fetch it again and send your change. | |
| WALLET_ACCOUNT_INSTANCES_ACTIVE | Retire all provider instances, then revoke the account. | |
| WALLET_ACCOUNT_MOVED | List accounts with GET /api/v1/wallet-providers/accounts and use the current one. | |
| WALLET_ART_MISMATCH | Replace the image with one at the size shown in issues. | |
| WALLET_CREDENTIALS_INVALID | Fix the credentials named in issues and send them again. | |
| WALLET_CREDENTIALS_UNAVAILABLE | Retry with backoff. | |
| WALLET_ENROLMENT_HELD | Ask the platform owner to release the hold. | |
| WALLET_ENROLMENT_PREREQUISITE | Finish the steps listed in the response, then retry. | |
| WALLET_IDENTITY_IMMUTABLE | Create a new account for the new identity. | |
| WALLET_IMAGE_NOT_FOUND | Rebuild the wallet projection and use the new image URL. | |
| WALLET_ISSUER_CLAIMED | Use a different issuer. | |
| WALLET_ISSUER_EXISTS | Attach it as a shared issuer instead. | |
| WALLET_ISSUER_NOT_WAITING | Check the issuer status before completing it. | |
| WALLET_KEY_HELD | Move the credential to the new key, then send the request again. | |
| WALLET_MODE_MISMATCH | Use a key of the same mode as the request. | |
| WALLET_OFFER_NOT_FOUND | Request a new offer for the pass. | |
| WALLET_PLATFORM_CREDENTIAL_MISSING | Ask the platform owner to add it, then send the request again. | |
| WALLET_PROJECTION_BLOCKED | Fix the problems the response lists and build the projection again. | |
| WALLET_PROJECTION_CONFLICT | Fetch the candidate again and send your request. | |
| WALLET_PROJECTION_NOT_FOUND | Check the id and create a candidate if it expired. | |
| WALLET_PROJECTION_SCHEMA | Create a new candidate from the current release. | |
| WALLET_PROJECTION_UNSUPPORTED | Remove the unsupported features or release without this provider. | |
| WALLET_RUN_BUSY | Send the request again in a minute. | |
| WALLET_VERIFICATION_CONFLICT | Wait for it to finish, then verify again if needed. |
Activity
/api/v1/passes/{id}/eventsPath
Query
Returns
200
Errors
| Code | Status | Fix |
|---|---|---|
| ASSET_DIMENSIONS | Resize the image to the size named in issues and upload it again. | |
| ASSET_NOT_FOUND | Check the image name or id and that it belongs to this organization. | |
| ASSET_NOT_PNG | Re-export the image as a standard RGB or RGBA PNG and upload it again. | |
| ASSET_SIZE | Compress the image below 1 MB and upload it again. | |
| ASSET_SLOT | Use a slot name from the pass type's image slots in the request path. | |
| BULK_RUN_ACTIVE | Wait for the running job to finish, then start the new one. | |
| BUNDLE_TOO_LARGE | Split the passes across smaller bundles. | |
| CONNECTION_ORG | Use a connection id from your own organization's GET /api/v1/connections. | |
| CONNECTION_TRANSFER_PENDING | Wait for the transfer to finish, then send the request again. | |
| CREATE_STALE | Look the pass up by externalId with GET /api/v1/passes and update it instead of creating it again. | |
| CREDENTIAL_REF_KEYSET_CONFIG_UNAVAILABLE | Retry with backoff; if it persists, send the requestId to support. | |
| CREDENTIAL_REF_KEYSET_UNAVAILABLE | Retry with backoff; if it persists, send the requestId to support. | |
| DELIVERY_STALE | Review the recipient and try again. | |
| DEVICE_TOKEN_UNAVAILABLE | Retry the request; if it persists, send the requestId to support. | |
| EMAIL_INVALID | Send a valid address in the email field. | |
| EXTERNAL_ID_TAKEN | Send a new externalId, or PATCH the existing pass. | |
| FORBIDDEN | Use a key with the scope the operation lists, or ask an org admin. | |
| IDEMPOTENCY_IN_PROGRESS | Wait a moment and resend the identical request. | |
| IDEMPOTENCY_KEY_INVALID | Send a unique string of 1 to 200 characters, such as a UUID. | |
| IDEMPOTENCY_KEY_REUSED | Use a new key for a new request; resend the identical request to replay. | |
| IF_MATCH_INVALID | Send the version from the last GET, for example If-Match: 3. | |
| IMPORT_BUSY | Wait for it to finish with GET /api/v1/pass-imports/{id}, then retry. | |
| IMPORT_COLUMN_MISSING | Add the column to the file, or change the mapping, then check again. | |
| IMPORT_EXPIRED | Upload the file again with POST /api/v1/pass-imports. | |
| IMPORT_FILE_GONE | Upload it again. | |
| IMPORT_HAS_ERRORS | Fix the rows listed in GET /api/v1/pass-imports/{id}/errors.csv, or skip them, then commit again. | |
| IMPORT_HEADER_TOO_LONG | Shorten the header and upload the file again. | |
| IMPORT_ID_TAKEN | Check the import again with POST /api/v1/pass-imports/{id}/check, then commit. | |
| IMPORT_NOT_FOUND | Check the id with GET /api/v1/pass-imports. | |
| IMPORT_PASS_CHANGED | Remove the pass on its own with POST /api/v1/passes/{id}/remove. | |
| IMPORT_PLAN_INVALID | Fix the mapping entries named in issues and check again. | |
| IMPORT_ROW_UNRESERVED | Retry the commit; if it persists, send the requestId to support. | |
| IMPORT_STATE | Check its state with GET /api/v1/pass-imports/{id} and call the action that state allows. | |
| INVALID_API_KEY | Create a new key in the console and update PASSBOOK_KEY. | |
| INVALID_INPUT | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| JOIN_NOT_READY | Publish the template, then enable the link with PUT /api/v1/join-links/{templateId}. | |
| MATCH_NEEDS_TEMPLATE | Send orgId and templateId with the input filter. | |
| MEMBER_PHOTO_CHANGED | Fetch the pass with GET /api/v1/passes/{id} and save the photo again. | |
| MEMBER_PHOTO_DIMENSIONS | Crop the photo to a 270 by 270 pixel square and upload it again. | |
| MEMBER_PHOTO_ENCODING | Send the photo as a PNG or JPEG file. | |
| MEMBER_PHOTO_NOT_FOUND | Add one with PUT /api/v1/passes/{id}/member-photo. | |
| MEMBER_PHOTO_STYLE | Use a template of that style, or remove the strip image. | |
| MISSING_SCOPE | Create a key with the scope the operation lists under security. | |
| MODE_MISMATCH | Use objects and a key of the same mode. | |
| NEW_CODE_UNSUPPORTED | Reissue the pass with POST /api/v1/passes/bulk-reissue instead of requesting a new code. | |
| 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_ACCESS_CHANGED | Check access with GET /api/v1/api-keys/me, then send the request again. | |
| ORG_FORBIDDEN | Use a key scoped to this organization, or a platform key for platform-wide lists. | |
| ORG_MIXED | Send ids from one organization per request. | |
| ORG_NOT_FOUND | Check orgId with GET /api/v1/orgs. | |
| ORG_REQUIRED | Send orgId with the request, or use a key scoped to one organization. | |
| PASS_CONFLICT | Fetch the pass with GET /api/v1/passes/{id} and send the request again. | |
| PASS_CONNECTION_MISMATCH | Link it with PUT /api/v1/passes/{id}/connection, then send the request again. | |
| PASS_FILE_MISSING | Rebuild it with POST /api/v1/passes/{id}/refresh. | |
| PASS_INPUT_INVALID | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| PASS_INVALID | Fix the problems named in issues in the template or inputs. | |
| PASS_NOT_ACTIVE | Restore or unvoid the pass first, or use an active one. | |
| PASS_NOT_FOUND | Check the id with GET /api/v1/passes and the key's mode. | |
| PASS_REF_TAKEN | Use a different ref, or update the existing pass. | |
| PASS_REISSUE_REQUIRED | Reissue it with POST /api/v1/passes/bulk-reissue. | |
| PASS_REMOVED | Restore it with POST /api/v1/passes/{id}/restore, then send the request again. | |
| PASS_TRANSFER_NOT_FOUND | Check the transfer id. | |
| PASS_TRANSFER_PENDING | Try again shortly. | |
| 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}. | |
| SCAN_EVENT_NOT_FOUND | Check the event id with GET /api/v1/scan/events. | |
| SCAN_WINDOW_INVALID | Set an end after the start, or fix the template's dates. | |
| SERIAL_TAKEN | Send a different serial, or leave it out to have one generated. | |
| SESSION_REQUIRED | Do it in the console, or sign in as the account that started it. | |
| STAMPS_ABOVE_MAX | Raise the template's stamp maximum, or redeem stamps first. | |
| STAMPS_CARD_FULL | Redeem the reward, then add stamps. | |
| STAMPS_NONE | Use a template with stamps. | |
| STAMPS_NO_REWARD | Add stamps until the card is full, then redeem. | |
| TEMPLATE_NOT_FOUND | Check the id with GET /api/v1/templates and the key's mode. | |
| TEMPLATE_RELEASE_CONFLICT | Send the request again to use the current release. | |
| TEMPLATE_RELEASE_REQUIRED | Approve a release with POST /api/v1/templates/{id}/candidates/{candidateId}/approve. | |
| TERM_MANAGED | Change the term in the connected system. | |
| TERM_NONE | Renew only passes whose template defines a term. | |
| TERM_NOT_STARTED | Renew after the term starts. | |
| UNAUTHENTICATED | Send Authorization: Bearer $PASSBOOK_KEY. | |
| VALIDATION | Fix each field in issues and resend. | |
| VERSION_NOT_FOUND | Check the version with GET /api/v1/passes/{id}. | |
| VERSION_PURGED | Request a newer version. | |
| WORKFLOW_START | Send the request again. |
Assets
/api/v1/passes/{id}/assetsPath
Query
Returns
200
Errors
| Code | Status | Fix |
|---|---|---|
| ASSET_DIMENSIONS | Resize the image to the size named in issues and upload it again. | |
| ASSET_NOT_FOUND | Check the image name or id and that it belongs to this organization. | |
| ASSET_NOT_PNG | Re-export the image as a standard RGB or RGBA PNG and upload it again. | |
| ASSET_SIZE | Compress the image below 1 MB and upload it again. | |
| ASSET_SLOT | Use a slot name from the pass type's image slots in the request path. | |
| BULK_RUN_ACTIVE | Wait for the running job to finish, then start the new one. | |
| BUNDLE_TOO_LARGE | Split the passes across smaller bundles. | |
| CONNECTION_ORG | Use a connection id from your own organization's GET /api/v1/connections. | |
| CONNECTION_TRANSFER_PENDING | Wait for the transfer to finish, then send the request again. | |
| CREATE_STALE | Look the pass up by externalId with GET /api/v1/passes and update it instead of creating it again. | |
| CREDENTIAL_REF_KEYSET_CONFIG_UNAVAILABLE | Retry with backoff; if it persists, send the requestId to support. | |
| CREDENTIAL_REF_KEYSET_UNAVAILABLE | Retry with backoff; if it persists, send the requestId to support. | |
| DELIVERY_STALE | Review the recipient and try again. | |
| DEVICE_TOKEN_UNAVAILABLE | Retry the request; if it persists, send the requestId to support. | |
| EMAIL_INVALID | Send a valid address in the email field. | |
| EXTERNAL_ID_TAKEN | Send a new externalId, or PATCH the existing pass. | |
| FORBIDDEN | Use a key with the scope the operation lists, or ask an org admin. | |
| IDEMPOTENCY_IN_PROGRESS | Wait a moment and resend the identical request. | |
| IDEMPOTENCY_KEY_INVALID | Send a unique string of 1 to 200 characters, such as a UUID. | |
| IDEMPOTENCY_KEY_REUSED | Use a new key for a new request; resend the identical request to replay. | |
| IF_MATCH_INVALID | Send the version from the last GET, for example If-Match: 3. | |
| IMPORT_BUSY | Wait for it to finish with GET /api/v1/pass-imports/{id}, then retry. | |
| IMPORT_COLUMN_MISSING | Add the column to the file, or change the mapping, then check again. | |
| IMPORT_EXPIRED | Upload the file again with POST /api/v1/pass-imports. | |
| IMPORT_FILE_GONE | Upload it again. | |
| IMPORT_HAS_ERRORS | Fix the rows listed in GET /api/v1/pass-imports/{id}/errors.csv, or skip them, then commit again. | |
| IMPORT_HEADER_TOO_LONG | Shorten the header and upload the file again. | |
| IMPORT_ID_TAKEN | Check the import again with POST /api/v1/pass-imports/{id}/check, then commit. | |
| IMPORT_NOT_FOUND | Check the id with GET /api/v1/pass-imports. | |
| IMPORT_PASS_CHANGED | Remove the pass on its own with POST /api/v1/passes/{id}/remove. | |
| IMPORT_PLAN_INVALID | Fix the mapping entries named in issues and check again. | |
| IMPORT_ROW_UNRESERVED | Retry the commit; if it persists, send the requestId to support. | |
| IMPORT_STATE | Check its state with GET /api/v1/pass-imports/{id} and call the action that state allows. | |
| INVALID_API_KEY | Create a new key in the console and update PASSBOOK_KEY. | |
| INVALID_INPUT | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| JOIN_NOT_READY | Publish the template, then enable the link with PUT /api/v1/join-links/{templateId}. | |
| MATCH_NEEDS_TEMPLATE | Send orgId and templateId with the input filter. | |
| MEMBER_PHOTO_CHANGED | Fetch the pass with GET /api/v1/passes/{id} and save the photo again. | |
| MEMBER_PHOTO_DIMENSIONS | Crop the photo to a 270 by 270 pixel square and upload it again. | |
| MEMBER_PHOTO_ENCODING | Send the photo as a PNG or JPEG file. | |
| MEMBER_PHOTO_NOT_FOUND | Add one with PUT /api/v1/passes/{id}/member-photo. | |
| MEMBER_PHOTO_STYLE | Use a template of that style, or remove the strip image. | |
| MISSING_SCOPE | Create a key with the scope the operation lists under security. | |
| MODE_MISMATCH | Use objects and a key of the same mode. | |
| NEW_CODE_UNSUPPORTED | Reissue the pass with POST /api/v1/passes/bulk-reissue instead of requesting a new code. | |
| 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_ACCESS_CHANGED | Check access with GET /api/v1/api-keys/me, then send the request again. | |
| ORG_FORBIDDEN | Use a key scoped to this organization, or a platform key for platform-wide lists. | |
| ORG_MIXED | Send ids from one organization per request. | |
| ORG_NOT_FOUND | Check orgId with GET /api/v1/orgs. | |
| ORG_REQUIRED | Send orgId with the request, or use a key scoped to one organization. | |
| PASS_CONFLICT | Fetch the pass with GET /api/v1/passes/{id} and send the request again. | |
| PASS_CONNECTION_MISMATCH | Link it with PUT /api/v1/passes/{id}/connection, then send the request again. | |
| PASS_FILE_MISSING | Rebuild it with POST /api/v1/passes/{id}/refresh. | |
| PASS_INPUT_INVALID | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| PASS_INVALID | Fix the problems named in issues in the template or inputs. | |
| PASS_NOT_ACTIVE | Restore or unvoid the pass first, or use an active one. | |
| PASS_NOT_FOUND | Check the id with GET /api/v1/passes and the key's mode. | |
| PASS_REF_TAKEN | Use a different ref, or update the existing pass. | |
| PASS_REISSUE_REQUIRED | Reissue it with POST /api/v1/passes/bulk-reissue. | |
| PASS_REMOVED | Restore it with POST /api/v1/passes/{id}/restore, then send the request again. | |
| PASS_TRANSFER_NOT_FOUND | Check the transfer id. | |
| PASS_TRANSFER_PENDING | Try again shortly. | |
| 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}. | |
| SCAN_EVENT_NOT_FOUND | Check the event id with GET /api/v1/scan/events. | |
| SCAN_WINDOW_INVALID | Set an end after the start, or fix the template's dates. | |
| SERIAL_TAKEN | Send a different serial, or leave it out to have one generated. | |
| SESSION_REQUIRED | Do it in the console, or sign in as the account that started it. | |
| STAMPS_ABOVE_MAX | Raise the template's stamp maximum, or redeem stamps first. | |
| STAMPS_CARD_FULL | Redeem the reward, then add stamps. | |
| STAMPS_NONE | Use a template with stamps. | |
| STAMPS_NO_REWARD | Add stamps until the card is full, then redeem. | |
| TEMPLATE_NOT_FOUND | Check the id with GET /api/v1/templates and the key's mode. | |
| TEMPLATE_RELEASE_CONFLICT | Send the request again to use the current release. | |
| TEMPLATE_RELEASE_REQUIRED | Approve a release with POST /api/v1/templates/{id}/candidates/{candidateId}/approve. | |
| TERM_MANAGED | Change the term in the connected system. | |
| TERM_NONE | Renew only passes whose template defines a term. | |
| TERM_NOT_STARTED | Renew after the term starts. | |
| UNAUTHENTICATED | Send Authorization: Bearer $PASSBOOK_KEY. | |
| VALIDATION | Fix each field in issues and resend. | |
| VERSION_NOT_FOUND | Check the version with GET /api/v1/passes/{id}. | |
| VERSION_PURGED | Request a newer version. | |
| WORKFLOW_START | Send the request again. |
/api/v1/passes/{id}/assets/{name}Path
Returns
200
Errors
| Code | Status | Fix |
|---|---|---|
| ASSET_DIMENSIONS | Resize the image to the size named in issues and upload it again. | |
| ASSET_NOT_FOUND | Check the image name or id and that it belongs to this organization. | |
| ASSET_NOT_PNG | Re-export the image as a standard RGB or RGBA PNG and upload it again. | |
| ASSET_SIZE | Compress the image below 1 MB and upload it again. | |
| ASSET_SLOT | Use a slot name from the pass type's image slots in the request path. | |
| BULK_RUN_ACTIVE | Wait for the running job to finish, then start the new one. | |
| BUNDLE_TOO_LARGE | Split the passes across smaller bundles. | |
| CONNECTION_ORG | Use a connection id from your own organization's GET /api/v1/connections. | |
| CONNECTION_TRANSFER_PENDING | Wait for the transfer to finish, then send the request again. | |
| CREATE_STALE | Look the pass up by externalId with GET /api/v1/passes and update it instead of creating it again. | |
| CREDENTIAL_REF_KEYSET_CONFIG_UNAVAILABLE | Retry with backoff; if it persists, send the requestId to support. | |
| CREDENTIAL_REF_KEYSET_UNAVAILABLE | Retry with backoff; if it persists, send the requestId to support. | |
| DELIVERY_STALE | Review the recipient and try again. | |
| DEVICE_TOKEN_UNAVAILABLE | Retry the request; if it persists, send the requestId to support. | |
| EMAIL_INVALID | Send a valid address in the email field. | |
| EXTERNAL_ID_TAKEN | Send a new externalId, or PATCH the existing pass. | |
| FORBIDDEN | Use a key with the scope the operation lists, or ask an org admin. | |
| IDEMPOTENCY_IN_PROGRESS | Wait a moment and resend the identical request. | |
| IDEMPOTENCY_KEY_INVALID | Send a unique string of 1 to 200 characters, such as a UUID. | |
| IDEMPOTENCY_KEY_REUSED | Use a new key for a new request; resend the identical request to replay. | |
| IF_MATCH_INVALID | Send the version from the last GET, for example If-Match: 3. | |
| IMPORT_BUSY | Wait for it to finish with GET /api/v1/pass-imports/{id}, then retry. | |
| IMPORT_COLUMN_MISSING | Add the column to the file, or change the mapping, then check again. | |
| IMPORT_EXPIRED | Upload the file again with POST /api/v1/pass-imports. | |
| IMPORT_FILE_GONE | Upload it again. | |
| IMPORT_HAS_ERRORS | Fix the rows listed in GET /api/v1/pass-imports/{id}/errors.csv, or skip them, then commit again. | |
| IMPORT_HEADER_TOO_LONG | Shorten the header and upload the file again. | |
| IMPORT_ID_TAKEN | Check the import again with POST /api/v1/pass-imports/{id}/check, then commit. | |
| IMPORT_NOT_FOUND | Check the id with GET /api/v1/pass-imports. | |
| IMPORT_PASS_CHANGED | Remove the pass on its own with POST /api/v1/passes/{id}/remove. | |
| IMPORT_PLAN_INVALID | Fix the mapping entries named in issues and check again. | |
| IMPORT_ROW_UNRESERVED | Retry the commit; if it persists, send the requestId to support. | |
| IMPORT_STATE | Check its state with GET /api/v1/pass-imports/{id} and call the action that state allows. | |
| INVALID_API_KEY | Create a new key in the console and update PASSBOOK_KEY. | |
| INVALID_INPUT | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| JOIN_NOT_READY | Publish the template, then enable the link with PUT /api/v1/join-links/{templateId}. | |
| MATCH_NEEDS_TEMPLATE | Send orgId and templateId with the input filter. | |
| MEMBER_PHOTO_CHANGED | Fetch the pass with GET /api/v1/passes/{id} and save the photo again. | |
| MEMBER_PHOTO_DIMENSIONS | Crop the photo to a 270 by 270 pixel square and upload it again. | |
| MEMBER_PHOTO_ENCODING | Send the photo as a PNG or JPEG file. | |
| MEMBER_PHOTO_NOT_FOUND | Add one with PUT /api/v1/passes/{id}/member-photo. | |
| MEMBER_PHOTO_STYLE | Use a template of that style, or remove the strip image. | |
| MISSING_SCOPE | Create a key with the scope the operation lists under security. | |
| MODE_MISMATCH | Use objects and a key of the same mode. | |
| NEW_CODE_UNSUPPORTED | Reissue the pass with POST /api/v1/passes/bulk-reissue instead of requesting a new code. | |
| 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_ACCESS_CHANGED | Check access with GET /api/v1/api-keys/me, then send the request again. | |
| ORG_FORBIDDEN | Use a key scoped to this organization, or a platform key for platform-wide lists. | |
| ORG_MIXED | Send ids from one organization per request. | |
| ORG_NOT_FOUND | Check orgId with GET /api/v1/orgs. | |
| ORG_REQUIRED | Send orgId with the request, or use a key scoped to one organization. | |
| PASS_CONFLICT | Fetch the pass with GET /api/v1/passes/{id} and send the request again. | |
| PASS_CONNECTION_MISMATCH | Link it with PUT /api/v1/passes/{id}/connection, then send the request again. | |
| PASS_FILE_MISSING | Rebuild it with POST /api/v1/passes/{id}/refresh. | |
| PASS_INPUT_INVALID | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| PASS_INVALID | Fix the problems named in issues in the template or inputs. | |
| PASS_NOT_ACTIVE | Restore or unvoid the pass first, or use an active one. | |
| PASS_NOT_FOUND | Check the id with GET /api/v1/passes and the key's mode. | |
| PASS_REF_TAKEN | Use a different ref, or update the existing pass. | |
| PASS_REISSUE_REQUIRED | Reissue it with POST /api/v1/passes/bulk-reissue. | |
| PASS_REMOVED | Restore it with POST /api/v1/passes/{id}/restore, then send the request again. | |
| PASS_TRANSFER_NOT_FOUND | Check the transfer id. | |
| PASS_TRANSFER_PENDING | Try again shortly. | |
| 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}. | |
| SCAN_EVENT_NOT_FOUND | Check the event id with GET /api/v1/scan/events. | |
| SCAN_WINDOW_INVALID | Set an end after the start, or fix the template's dates. | |
| SERIAL_TAKEN | Send a different serial, or leave it out to have one generated. | |
| SESSION_REQUIRED | Do it in the console, or sign in as the account that started it. | |
| STAMPS_ABOVE_MAX | Raise the template's stamp maximum, or redeem stamps first. | |
| STAMPS_CARD_FULL | Redeem the reward, then add stamps. | |
| STAMPS_NONE | Use a template with stamps. | |
| STAMPS_NO_REWARD | Add stamps until the card is full, then redeem. | |
| TEMPLATE_NOT_FOUND | Check the id with GET /api/v1/templates and the key's mode. | |
| TEMPLATE_RELEASE_CONFLICT | Send the request again to use the current release. | |
| TEMPLATE_RELEASE_REQUIRED | Approve a release with POST /api/v1/templates/{id}/candidates/{candidateId}/approve. | |
| TERM_MANAGED | Change the term in the connected system. | |
| TERM_NONE | Renew only passes whose template defines a term. | |
| TERM_NOT_STARTED | Renew after the term starts. | |
| UNAUTHENTICATED | Send Authorization: Bearer $PASSBOOK_KEY. | |
| VALIDATION | Fix each field in issues and resend. | |
| VERSION_NOT_FOUND | Check the version with GET /api/v1/passes/{id}. | |
| VERSION_PURGED | Request a newer version. | |
| WORKFLOW_START | Send the request again. |
/api/v1/passes/{id}/assets/{name}Path
Returns
200
Errors
| Code | Status | Fix |
|---|---|---|
| ASSET_DIMENSIONS | Resize the image to the size named in issues and upload it again. | |
| ASSET_NOT_FOUND | Check the image name or id and that it belongs to this organization. | |
| ASSET_NOT_PNG | Re-export the image as a standard RGB or RGBA PNG and upload it again. | |
| ASSET_SIZE | Compress the image below 1 MB and upload it again. | |
| ASSET_SLOT | Use a slot name from the pass type's image slots in the request path. | |
| BULK_RUN_ACTIVE | Wait for the running job to finish, then start the new one. | |
| BUNDLE_TOO_LARGE | Split the passes across smaller bundles. | |
| CONNECTION_ORG | Use a connection id from your own organization's GET /api/v1/connections. | |
| CONNECTION_TRANSFER_PENDING | Wait for the transfer to finish, then send the request again. | |
| CREATE_STALE | Look the pass up by externalId with GET /api/v1/passes and update it instead of creating it again. | |
| CREDENTIAL_REF_KEYSET_CONFIG_UNAVAILABLE | Retry with backoff; if it persists, send the requestId to support. | |
| CREDENTIAL_REF_KEYSET_UNAVAILABLE | Retry with backoff; if it persists, send the requestId to support. | |
| DELIVERY_STALE | Review the recipient and try again. | |
| DEVICE_TOKEN_UNAVAILABLE | Retry the request; if it persists, send the requestId to support. | |
| EMAIL_INVALID | Send a valid address in the email field. | |
| EXTERNAL_ID_TAKEN | Send a new externalId, or PATCH the existing pass. | |
| FORBIDDEN | Use a key with the scope the operation lists, or ask an org admin. | |
| IDEMPOTENCY_IN_PROGRESS | Wait a moment and resend the identical request. | |
| IDEMPOTENCY_KEY_INVALID | Send a unique string of 1 to 200 characters, such as a UUID. | |
| IDEMPOTENCY_KEY_REUSED | Use a new key for a new request; resend the identical request to replay. | |
| IF_MATCH_INVALID | Send the version from the last GET, for example If-Match: 3. | |
| IMPORT_BUSY | Wait for it to finish with GET /api/v1/pass-imports/{id}, then retry. | |
| IMPORT_COLUMN_MISSING | Add the column to the file, or change the mapping, then check again. | |
| IMPORT_EXPIRED | Upload the file again with POST /api/v1/pass-imports. | |
| IMPORT_FILE_GONE | Upload it again. | |
| IMPORT_HAS_ERRORS | Fix the rows listed in GET /api/v1/pass-imports/{id}/errors.csv, or skip them, then commit again. | |
| IMPORT_HEADER_TOO_LONG | Shorten the header and upload the file again. | |
| IMPORT_ID_TAKEN | Check the import again with POST /api/v1/pass-imports/{id}/check, then commit. | |
| IMPORT_NOT_FOUND | Check the id with GET /api/v1/pass-imports. | |
| IMPORT_PASS_CHANGED | Remove the pass on its own with POST /api/v1/passes/{id}/remove. | |
| IMPORT_PLAN_INVALID | Fix the mapping entries named in issues and check again. | |
| IMPORT_ROW_UNRESERVED | Retry the commit; if it persists, send the requestId to support. | |
| IMPORT_STATE | Check its state with GET /api/v1/pass-imports/{id} and call the action that state allows. | |
| INVALID_API_KEY | Create a new key in the console and update PASSBOOK_KEY. | |
| INVALID_INPUT | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| JOIN_NOT_READY | Publish the template, then enable the link with PUT /api/v1/join-links/{templateId}. | |
| MATCH_NEEDS_TEMPLATE | Send orgId and templateId with the input filter. | |
| MEMBER_PHOTO_CHANGED | Fetch the pass with GET /api/v1/passes/{id} and save the photo again. | |
| MEMBER_PHOTO_DIMENSIONS | Crop the photo to a 270 by 270 pixel square and upload it again. | |
| MEMBER_PHOTO_ENCODING | Send the photo as a PNG or JPEG file. | |
| MEMBER_PHOTO_NOT_FOUND | Add one with PUT /api/v1/passes/{id}/member-photo. | |
| MEMBER_PHOTO_STYLE | Use a template of that style, or remove the strip image. | |
| MISSING_SCOPE | Create a key with the scope the operation lists under security. | |
| MODE_MISMATCH | Use objects and a key of the same mode. | |
| NEW_CODE_UNSUPPORTED | Reissue the pass with POST /api/v1/passes/bulk-reissue instead of requesting a new code. | |
| 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_ACCESS_CHANGED | Check access with GET /api/v1/api-keys/me, then send the request again. | |
| ORG_FORBIDDEN | Use a key scoped to this organization, or a platform key for platform-wide lists. | |
| ORG_MIXED | Send ids from one organization per request. | |
| ORG_NOT_FOUND | Check orgId with GET /api/v1/orgs. | |
| ORG_REQUIRED | Send orgId with the request, or use a key scoped to one organization. | |
| PASS_CONFLICT | Fetch the pass with GET /api/v1/passes/{id} and send the request again. | |
| PASS_CONNECTION_MISMATCH | Link it with PUT /api/v1/passes/{id}/connection, then send the request again. | |
| PASS_FILE_MISSING | Rebuild it with POST /api/v1/passes/{id}/refresh. | |
| PASS_INPUT_INVALID | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| PASS_INVALID | Fix the problems named in issues in the template or inputs. | |
| PASS_NOT_ACTIVE | Restore or unvoid the pass first, or use an active one. | |
| PASS_NOT_FOUND | Check the id with GET /api/v1/passes and the key's mode. | |
| PASS_REF_TAKEN | Use a different ref, or update the existing pass. | |
| PASS_REISSUE_REQUIRED | Reissue it with POST /api/v1/passes/bulk-reissue. | |
| PASS_REMOVED | Restore it with POST /api/v1/passes/{id}/restore, then send the request again. | |
| PASS_TRANSFER_NOT_FOUND | Check the transfer id. | |
| PASS_TRANSFER_PENDING | Try again shortly. | |
| 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}. | |
| SCAN_EVENT_NOT_FOUND | Check the event id with GET /api/v1/scan/events. | |
| SCAN_WINDOW_INVALID | Set an end after the start, or fix the template's dates. | |
| SERIAL_TAKEN | Send a different serial, or leave it out to have one generated. | |
| SESSION_REQUIRED | Do it in the console, or sign in as the account that started it. | |
| STAMPS_ABOVE_MAX | Raise the template's stamp maximum, or redeem stamps first. | |
| STAMPS_CARD_FULL | Redeem the reward, then add stamps. | |
| STAMPS_NONE | Use a template with stamps. | |
| STAMPS_NO_REWARD | Add stamps until the card is full, then redeem. | |
| TEMPLATE_NOT_FOUND | Check the id with GET /api/v1/templates and the key's mode. | |
| TEMPLATE_RELEASE_CONFLICT | Send the request again to use the current release. | |
| TEMPLATE_RELEASE_REQUIRED | Approve a release with POST /api/v1/templates/{id}/candidates/{candidateId}/approve. | |
| TERM_MANAGED | Change the term in the connected system. | |
| TERM_NONE | Renew only passes whose template defines a term. | |
| TERM_NOT_STARTED | Renew after the term starts. | |
| UNAUTHENTICATED | Send Authorization: Bearer $PASSBOOK_KEY. | |
| VALIDATION | Fix each field in issues and resend. | |
| VERSION_NOT_FOUND | Check the version with GET /api/v1/passes/{id}. | |
| VERSION_PURGED | Request a newer version. | |
| WORKFLOW_START | Send the request again. |
Channels
/api/v1/passes/{id}/channelsPath
Returns
200
Errors
| Code | Status | Fix |
|---|---|---|
| ASSET_DIMENSIONS | Resize the image to the size named in issues and upload it again. | |
| ASSET_NOT_FOUND | Check the image name or id and that it belongs to this organization. | |
| ASSET_NOT_PNG | Re-export the image as a standard RGB or RGBA PNG and upload it again. | |
| ASSET_SIZE | Compress the image below 1 MB and upload it again. | |
| ASSET_SLOT | Use a slot name from the pass type's image slots in the request path. | |
| BULK_RUN_ACTIVE | Wait for the running job to finish, then start the new one. | |
| BUNDLE_TOO_LARGE | Split the passes across smaller bundles. | |
| CONNECTION_ORG | Use a connection id from your own organization's GET /api/v1/connections. | |
| CONNECTION_TRANSFER_PENDING | Wait for the transfer to finish, then send the request again. | |
| CREATE_STALE | Look the pass up by externalId with GET /api/v1/passes and update it instead of creating it again. | |
| CREDENTIAL_REF_KEYSET_CONFIG_UNAVAILABLE | Retry with backoff; if it persists, send the requestId to support. | |
| CREDENTIAL_REF_KEYSET_UNAVAILABLE | Retry with backoff; if it persists, send the requestId to support. | |
| DELIVERY_STALE | Review the recipient and try again. | |
| DEVICE_TOKEN_UNAVAILABLE | Retry the request; if it persists, send the requestId to support. | |
| EMAIL_INVALID | Send a valid address in the email field. | |
| EXTERNAL_ID_TAKEN | Send a new externalId, or PATCH the existing pass. | |
| FORBIDDEN | Use a key with the scope the operation lists, or ask an org admin. | |
| IDEMPOTENCY_IN_PROGRESS | Wait a moment and resend the identical request. | |
| IDEMPOTENCY_KEY_INVALID | Send a unique string of 1 to 200 characters, such as a UUID. | |
| IDEMPOTENCY_KEY_REUSED | Use a new key for a new request; resend the identical request to replay. | |
| IF_MATCH_INVALID | Send the version from the last GET, for example If-Match: 3. | |
| IMPORT_BUSY | Wait for it to finish with GET /api/v1/pass-imports/{id}, then retry. | |
| IMPORT_COLUMN_MISSING | Add the column to the file, or change the mapping, then check again. | |
| IMPORT_EXPIRED | Upload the file again with POST /api/v1/pass-imports. | |
| IMPORT_FILE_GONE | Upload it again. | |
| IMPORT_HAS_ERRORS | Fix the rows listed in GET /api/v1/pass-imports/{id}/errors.csv, or skip them, then commit again. | |
| IMPORT_HEADER_TOO_LONG | Shorten the header and upload the file again. | |
| IMPORT_ID_TAKEN | Check the import again with POST /api/v1/pass-imports/{id}/check, then commit. | |
| IMPORT_NOT_FOUND | Check the id with GET /api/v1/pass-imports. | |
| IMPORT_PASS_CHANGED | Remove the pass on its own with POST /api/v1/passes/{id}/remove. | |
| IMPORT_PLAN_INVALID | Fix the mapping entries named in issues and check again. | |
| IMPORT_ROW_UNRESERVED | Retry the commit; if it persists, send the requestId to support. | |
| IMPORT_STATE | Check its state with GET /api/v1/pass-imports/{id} and call the action that state allows. | |
| INVALID_API_KEY | Create a new key in the console and update PASSBOOK_KEY. | |
| INVALID_INPUT | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| JOIN_NOT_READY | Publish the template, then enable the link with PUT /api/v1/join-links/{templateId}. | |
| MATCH_NEEDS_TEMPLATE | Send orgId and templateId with the input filter. | |
| MEMBER_PHOTO_CHANGED | Fetch the pass with GET /api/v1/passes/{id} and save the photo again. | |
| MEMBER_PHOTO_DIMENSIONS | Crop the photo to a 270 by 270 pixel square and upload it again. | |
| MEMBER_PHOTO_ENCODING | Send the photo as a PNG or JPEG file. | |
| MEMBER_PHOTO_NOT_FOUND | Add one with PUT /api/v1/passes/{id}/member-photo. | |
| MEMBER_PHOTO_STYLE | Use a template of that style, or remove the strip image. | |
| MISSING_SCOPE | Create a key with the scope the operation lists under security. | |
| MODE_MISMATCH | Use objects and a key of the same mode. | |
| NEW_CODE_UNSUPPORTED | Reissue the pass with POST /api/v1/passes/bulk-reissue instead of requesting a new code. | |
| 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_ACCESS_CHANGED | Check access with GET /api/v1/api-keys/me, then send the request again. | |
| ORG_FORBIDDEN | Use a key scoped to this organization, or a platform key for platform-wide lists. | |
| ORG_MIXED | Send ids from one organization per request. | |
| ORG_NOT_FOUND | Check orgId with GET /api/v1/orgs. | |
| ORG_REQUIRED | Send orgId with the request, or use a key scoped to one organization. | |
| PASS_CONFLICT | Fetch the pass with GET /api/v1/passes/{id} and send the request again. | |
| PASS_CONNECTION_MISMATCH | Link it with PUT /api/v1/passes/{id}/connection, then send the request again. | |
| PASS_FILE_MISSING | Rebuild it with POST /api/v1/passes/{id}/refresh. | |
| PASS_INPUT_INVALID | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| PASS_INVALID | Fix the problems named in issues in the template or inputs. | |
| PASS_NOT_ACTIVE | Restore or unvoid the pass first, or use an active one. | |
| PASS_NOT_FOUND | Check the id with GET /api/v1/passes and the key's mode. | |
| PASS_REF_TAKEN | Use a different ref, or update the existing pass. | |
| PASS_REISSUE_REQUIRED | Reissue it with POST /api/v1/passes/bulk-reissue. | |
| PASS_REMOVED | Restore it with POST /api/v1/passes/{id}/restore, then send the request again. | |
| PASS_TRANSFER_NOT_FOUND | Check the transfer id. | |
| PASS_TRANSFER_PENDING | Try again shortly. | |
| 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}. | |
| SCAN_EVENT_NOT_FOUND | Check the event id with GET /api/v1/scan/events. | |
| SCAN_WINDOW_INVALID | Set an end after the start, or fix the template's dates. | |
| SERIAL_TAKEN | Send a different serial, or leave it out to have one generated. | |
| SESSION_REQUIRED | Do it in the console, or sign in as the account that started it. | |
| STAMPS_ABOVE_MAX | Raise the template's stamp maximum, or redeem stamps first. | |
| STAMPS_CARD_FULL | Redeem the reward, then add stamps. | |
| STAMPS_NONE | Use a template with stamps. | |
| STAMPS_NO_REWARD | Add stamps until the card is full, then redeem. | |
| TEMPLATE_NOT_FOUND | Check the id with GET /api/v1/templates and the key's mode. | |
| TEMPLATE_RELEASE_CONFLICT | Send the request again to use the current release. | |
| TEMPLATE_RELEASE_REQUIRED | Approve a release with POST /api/v1/templates/{id}/candidates/{candidateId}/approve. | |
| TERM_MANAGED | Change the term in the connected system. | |
| TERM_NONE | Renew only passes whose template defines a term. | |
| TERM_NOT_STARTED | Renew after the term starts. | |
| UNAUTHENTICATED | Send Authorization: Bearer $PASSBOOK_KEY. | |
| VALIDATION | Fix each field in issues and resend. | |
| VERSION_NOT_FOUND | Check the version with GET /api/v1/passes/{id}. | |
| VERSION_PURGED | Request a newer version. | |
| WORKFLOW_START | Send the request again. |
/api/v1/passes/{id}/channelsPath
Body
Returns
200
Errors
| Code | Status | Fix |
|---|---|---|
| ASSET_DIMENSIONS | Resize the image to the size named in issues and upload it again. | |
| ASSET_NOT_FOUND | Check the image name or id and that it belongs to this organization. | |
| ASSET_NOT_PNG | Re-export the image as a standard RGB or RGBA PNG and upload it again. | |
| ASSET_SIZE | Compress the image below 1 MB and upload it again. | |
| ASSET_SLOT | Use a slot name from the pass type's image slots in the request path. | |
| BULK_RUN_ACTIVE | Wait for the running job to finish, then start the new one. | |
| BUNDLE_TOO_LARGE | Split the passes across smaller bundles. | |
| CONNECTION_ORG | Use a connection id from your own organization's GET /api/v1/connections. | |
| CONNECTION_TRANSFER_PENDING | Wait for the transfer to finish, then send the request again. | |
| CREATE_STALE | Look the pass up by externalId with GET /api/v1/passes and update it instead of creating it again. | |
| CREDENTIAL_REF_KEYSET_CONFIG_UNAVAILABLE | Retry with backoff; if it persists, send the requestId to support. | |
| CREDENTIAL_REF_KEYSET_UNAVAILABLE | Retry with backoff; if it persists, send the requestId to support. | |
| DELIVERY_STALE | Review the recipient and try again. | |
| DEVICE_TOKEN_UNAVAILABLE | Retry the request; if it persists, send the requestId to support. | |
| EMAIL_INVALID | Send a valid address in the email field. | |
| EXTERNAL_ID_TAKEN | Send a new externalId, or PATCH the existing pass. | |
| FORBIDDEN | Use a key with the scope the operation lists, or ask an org admin. | |
| IDEMPOTENCY_IN_PROGRESS | Wait a moment and resend the identical request. | |
| IDEMPOTENCY_KEY_INVALID | Send a unique string of 1 to 200 characters, such as a UUID. | |
| IDEMPOTENCY_KEY_REUSED | Use a new key for a new request; resend the identical request to replay. | |
| IF_MATCH_INVALID | Send the version from the last GET, for example If-Match: 3. | |
| IMPORT_BUSY | Wait for it to finish with GET /api/v1/pass-imports/{id}, then retry. | |
| IMPORT_COLUMN_MISSING | Add the column to the file, or change the mapping, then check again. | |
| IMPORT_EXPIRED | Upload the file again with POST /api/v1/pass-imports. | |
| IMPORT_FILE_GONE | Upload it again. | |
| IMPORT_HAS_ERRORS | Fix the rows listed in GET /api/v1/pass-imports/{id}/errors.csv, or skip them, then commit again. | |
| IMPORT_HEADER_TOO_LONG | Shorten the header and upload the file again. | |
| IMPORT_ID_TAKEN | Check the import again with POST /api/v1/pass-imports/{id}/check, then commit. | |
| IMPORT_NOT_FOUND | Check the id with GET /api/v1/pass-imports. | |
| IMPORT_PASS_CHANGED | Remove the pass on its own with POST /api/v1/passes/{id}/remove. | |
| IMPORT_PLAN_INVALID | Fix the mapping entries named in issues and check again. | |
| IMPORT_ROW_UNRESERVED | Retry the commit; if it persists, send the requestId to support. | |
| IMPORT_STATE | Check its state with GET /api/v1/pass-imports/{id} and call the action that state allows. | |
| INVALID_API_KEY | Create a new key in the console and update PASSBOOK_KEY. | |
| INVALID_INPUT | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| JOIN_NOT_READY | Publish the template, then enable the link with PUT /api/v1/join-links/{templateId}. | |
| MATCH_NEEDS_TEMPLATE | Send orgId and templateId with the input filter. | |
| MEMBER_PHOTO_CHANGED | Fetch the pass with GET /api/v1/passes/{id} and save the photo again. | |
| MEMBER_PHOTO_DIMENSIONS | Crop the photo to a 270 by 270 pixel square and upload it again. | |
| MEMBER_PHOTO_ENCODING | Send the photo as a PNG or JPEG file. | |
| MEMBER_PHOTO_NOT_FOUND | Add one with PUT /api/v1/passes/{id}/member-photo. | |
| MEMBER_PHOTO_STYLE | Use a template of that style, or remove the strip image. | |
| MISSING_SCOPE | Create a key with the scope the operation lists under security. | |
| MODE_MISMATCH | Use objects and a key of the same mode. | |
| NEW_CODE_UNSUPPORTED | Reissue the pass with POST /api/v1/passes/bulk-reissue instead of requesting a new code. | |
| 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_ACCESS_CHANGED | Check access with GET /api/v1/api-keys/me, then send the request again. | |
| ORG_FORBIDDEN | Use a key scoped to this organization, or a platform key for platform-wide lists. | |
| ORG_MIXED | Send ids from one organization per request. | |
| ORG_NOT_FOUND | Check orgId with GET /api/v1/orgs. | |
| ORG_REQUIRED | Send orgId with the request, or use a key scoped to one organization. | |
| PASS_CONFLICT | Fetch the pass with GET /api/v1/passes/{id} and send the request again. | |
| PASS_CONNECTION_MISMATCH | Link it with PUT /api/v1/passes/{id}/connection, then send the request again. | |
| PASS_FILE_MISSING | Rebuild it with POST /api/v1/passes/{id}/refresh. | |
| PASS_INPUT_INVALID | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| PASS_INVALID | Fix the problems named in issues in the template or inputs. | |
| PASS_NOT_ACTIVE | Restore or unvoid the pass first, or use an active one. | |
| PASS_NOT_FOUND | Check the id with GET /api/v1/passes and the key's mode. | |
| PASS_REF_TAKEN | Use a different ref, or update the existing pass. | |
| PASS_REISSUE_REQUIRED | Reissue it with POST /api/v1/passes/bulk-reissue. | |
| PASS_REMOVED | Restore it with POST /api/v1/passes/{id}/restore, then send the request again. | |
| PASS_TRANSFER_NOT_FOUND | Check the transfer id. | |
| PASS_TRANSFER_PENDING | Try again shortly. | |
| 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}. | |
| SCAN_EVENT_NOT_FOUND | Check the event id with GET /api/v1/scan/events. | |
| SCAN_WINDOW_INVALID | Set an end after the start, or fix the template's dates. | |
| SERIAL_TAKEN | Send a different serial, or leave it out to have one generated. | |
| SESSION_REQUIRED | Do it in the console, or sign in as the account that started it. | |
| STAMPS_ABOVE_MAX | Raise the template's stamp maximum, or redeem stamps first. | |
| STAMPS_CARD_FULL | Redeem the reward, then add stamps. | |
| STAMPS_NONE | Use a template with stamps. | |
| STAMPS_NO_REWARD | Add stamps until the card is full, then redeem. | |
| TEMPLATE_NOT_FOUND | Check the id with GET /api/v1/templates and the key's mode. | |
| TEMPLATE_RELEASE_CONFLICT | Send the request again to use the current release. | |
| TEMPLATE_RELEASE_REQUIRED | Approve a release with POST /api/v1/templates/{id}/candidates/{candidateId}/approve. | |
| TERM_MANAGED | Change the term in the connected system. | |
| TERM_NONE | Renew only passes whose template defines a term. | |
| TERM_NOT_STARTED | Renew after the term starts. | |
| UNAUTHENTICATED | Send Authorization: Bearer $PASSBOOK_KEY. | |
| VALIDATION | Fix each field in issues and resend. | |
| VERSION_NOT_FOUND | Check the version with GET /api/v1/passes/{id}. | |
| VERSION_PURGED | Request a newer version. | |
| WORKFLOW_START | Send the request again. |
Check In Rules
/api/v1/passes/{id}/check-inPath
Returns
200
Errors
| Code | Status | Fix |
|---|---|---|
| ASSET_DIMENSIONS | Resize the image to the size named in issues and upload it again. | |
| ASSET_NOT_FOUND | Check the image name or id and that it belongs to this organization. | |
| ASSET_NOT_PNG | Re-export the image as a standard RGB or RGBA PNG and upload it again. | |
| ASSET_SIZE | Compress the image below 1 MB and upload it again. | |
| ASSET_SLOT | Use a slot name from the pass type's image slots in the request path. | |
| BULK_RUN_ACTIVE | Wait for the running job to finish, then start the new one. | |
| BUNDLE_TOO_LARGE | Split the passes across smaller bundles. | |
| CONNECTION_ORG | Use a connection id from your own organization's GET /api/v1/connections. | |
| CONNECTION_TRANSFER_PENDING | Wait for the transfer to finish, then send the request again. | |
| CREATE_STALE | Look the pass up by externalId with GET /api/v1/passes and update it instead of creating it again. | |
| CREDENTIAL_REF_KEYSET_CONFIG_UNAVAILABLE | Retry with backoff; if it persists, send the requestId to support. | |
| CREDENTIAL_REF_KEYSET_UNAVAILABLE | Retry with backoff; if it persists, send the requestId to support. | |
| DELIVERY_STALE | Review the recipient and try again. | |
| DEVICE_TOKEN_UNAVAILABLE | Retry the request; if it persists, send the requestId to support. | |
| EMAIL_INVALID | Send a valid address in the email field. | |
| EXTERNAL_ID_TAKEN | Send a new externalId, or PATCH the existing pass. | |
| FORBIDDEN | Use a key with the scope the operation lists, or ask an org admin. | |
| IDEMPOTENCY_IN_PROGRESS | Wait a moment and resend the identical request. | |
| IDEMPOTENCY_KEY_INVALID | Send a unique string of 1 to 200 characters, such as a UUID. | |
| IDEMPOTENCY_KEY_REUSED | Use a new key for a new request; resend the identical request to replay. | |
| IF_MATCH_INVALID | Send the version from the last GET, for example If-Match: 3. | |
| IMPORT_BUSY | Wait for it to finish with GET /api/v1/pass-imports/{id}, then retry. | |
| IMPORT_COLUMN_MISSING | Add the column to the file, or change the mapping, then check again. | |
| IMPORT_EXPIRED | Upload the file again with POST /api/v1/pass-imports. | |
| IMPORT_FILE_GONE | Upload it again. | |
| IMPORT_HAS_ERRORS | Fix the rows listed in GET /api/v1/pass-imports/{id}/errors.csv, or skip them, then commit again. | |
| IMPORT_HEADER_TOO_LONG | Shorten the header and upload the file again. | |
| IMPORT_ID_TAKEN | Check the import again with POST /api/v1/pass-imports/{id}/check, then commit. | |
| IMPORT_NOT_FOUND | Check the id with GET /api/v1/pass-imports. | |
| IMPORT_PASS_CHANGED | Remove the pass on its own with POST /api/v1/passes/{id}/remove. | |
| IMPORT_PLAN_INVALID | Fix the mapping entries named in issues and check again. | |
| IMPORT_ROW_UNRESERVED | Retry the commit; if it persists, send the requestId to support. | |
| IMPORT_STATE | Check its state with GET /api/v1/pass-imports/{id} and call the action that state allows. | |
| INVALID_API_KEY | Create a new key in the console and update PASSBOOK_KEY. | |
| INVALID_INPUT | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| JOIN_NOT_READY | Publish the template, then enable the link with PUT /api/v1/join-links/{templateId}. | |
| MATCH_NEEDS_TEMPLATE | Send orgId and templateId with the input filter. | |
| MEMBER_PHOTO_CHANGED | Fetch the pass with GET /api/v1/passes/{id} and save the photo again. | |
| MEMBER_PHOTO_DIMENSIONS | Crop the photo to a 270 by 270 pixel square and upload it again. | |
| MEMBER_PHOTO_ENCODING | Send the photo as a PNG or JPEG file. | |
| MEMBER_PHOTO_NOT_FOUND | Add one with PUT /api/v1/passes/{id}/member-photo. | |
| MEMBER_PHOTO_STYLE | Use a template of that style, or remove the strip image. | |
| MISSING_SCOPE | Create a key with the scope the operation lists under security. | |
| MODE_MISMATCH | Use objects and a key of the same mode. | |
| NEW_CODE_UNSUPPORTED | Reissue the pass with POST /api/v1/passes/bulk-reissue instead of requesting a new code. | |
| 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_ACCESS_CHANGED | Check access with GET /api/v1/api-keys/me, then send the request again. | |
| ORG_FORBIDDEN | Use a key scoped to this organization, or a platform key for platform-wide lists. | |
| ORG_MIXED | Send ids from one organization per request. | |
| ORG_NOT_FOUND | Check orgId with GET /api/v1/orgs. | |
| ORG_REQUIRED | Send orgId with the request, or use a key scoped to one organization. | |
| PASS_CONFLICT | Fetch the pass with GET /api/v1/passes/{id} and send the request again. | |
| PASS_CONNECTION_MISMATCH | Link it with PUT /api/v1/passes/{id}/connection, then send the request again. | |
| PASS_FILE_MISSING | Rebuild it with POST /api/v1/passes/{id}/refresh. | |
| PASS_INPUT_INVALID | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| PASS_INVALID | Fix the problems named in issues in the template or inputs. | |
| PASS_NOT_ACTIVE | Restore or unvoid the pass first, or use an active one. | |
| PASS_NOT_FOUND | Check the id with GET /api/v1/passes and the key's mode. | |
| PASS_REF_TAKEN | Use a different ref, or update the existing pass. | |
| PASS_REISSUE_REQUIRED | Reissue it with POST /api/v1/passes/bulk-reissue. | |
| PASS_REMOVED | Restore it with POST /api/v1/passes/{id}/restore, then send the request again. | |
| PASS_TRANSFER_NOT_FOUND | Check the transfer id. | |
| PASS_TRANSFER_PENDING | Try again shortly. | |
| 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}. | |
| SCAN_EVENT_NOT_FOUND | Check the event id with GET /api/v1/scan/events. | |
| SCAN_WINDOW_INVALID | Set an end after the start, or fix the template's dates. | |
| SERIAL_TAKEN | Send a different serial, or leave it out to have one generated. | |
| SESSION_REQUIRED | Do it in the console, or sign in as the account that started it. | |
| STAMPS_ABOVE_MAX | Raise the template's stamp maximum, or redeem stamps first. | |
| STAMPS_CARD_FULL | Redeem the reward, then add stamps. | |
| STAMPS_NONE | Use a template with stamps. | |
| STAMPS_NO_REWARD | Add stamps until the card is full, then redeem. | |
| TEMPLATE_NOT_FOUND | Check the id with GET /api/v1/templates and the key's mode. | |
| TEMPLATE_RELEASE_CONFLICT | Send the request again to use the current release. | |
| TEMPLATE_RELEASE_REQUIRED | Approve a release with POST /api/v1/templates/{id}/candidates/{candidateId}/approve. | |
| TERM_MANAGED | Change the term in the connected system. | |
| TERM_NONE | Renew only passes whose template defines a term. | |
| TERM_NOT_STARTED | Renew after the term starts. | |
| UNAUTHENTICATED | Send Authorization: Bearer $PASSBOOK_KEY. | |
| VALIDATION | Fix each field in issues and resend. | |
| VERSION_NOT_FOUND | Check the version with GET /api/v1/passes/{id}. | |
| VERSION_PURGED | Request a newer version. | |
| WORKFLOW_START | Send the request again. |
/api/v1/passes/{id}/check-inPath
Body
Returns
200
Errors
| Code | Status | Fix |
|---|---|---|
| ASSET_DIMENSIONS | Resize the image to the size named in issues and upload it again. | |
| ASSET_NOT_FOUND | Check the image name or id and that it belongs to this organization. | |
| ASSET_NOT_PNG | Re-export the image as a standard RGB or RGBA PNG and upload it again. | |
| ASSET_SIZE | Compress the image below 1 MB and upload it again. | |
| ASSET_SLOT | Use a slot name from the pass type's image slots in the request path. | |
| BULK_RUN_ACTIVE | Wait for the running job to finish, then start the new one. | |
| BUNDLE_TOO_LARGE | Split the passes across smaller bundles. | |
| CONNECTION_ORG | Use a connection id from your own organization's GET /api/v1/connections. | |
| CONNECTION_TRANSFER_PENDING | Wait for the transfer to finish, then send the request again. | |
| CREATE_STALE | Look the pass up by externalId with GET /api/v1/passes and update it instead of creating it again. | |
| CREDENTIAL_REF_KEYSET_CONFIG_UNAVAILABLE | Retry with backoff; if it persists, send the requestId to support. | |
| CREDENTIAL_REF_KEYSET_UNAVAILABLE | Retry with backoff; if it persists, send the requestId to support. | |
| DELIVERY_STALE | Review the recipient and try again. | |
| DEVICE_TOKEN_UNAVAILABLE | Retry the request; if it persists, send the requestId to support. | |
| EMAIL_INVALID | Send a valid address in the email field. | |
| EXTERNAL_ID_TAKEN | Send a new externalId, or PATCH the existing pass. | |
| FORBIDDEN | Use a key with the scope the operation lists, or ask an org admin. | |
| IDEMPOTENCY_IN_PROGRESS | Wait a moment and resend the identical request. | |
| IDEMPOTENCY_KEY_INVALID | Send a unique string of 1 to 200 characters, such as a UUID. | |
| IDEMPOTENCY_KEY_REUSED | Use a new key for a new request; resend the identical request to replay. | |
| IF_MATCH_INVALID | Send the version from the last GET, for example If-Match: 3. | |
| IMPORT_BUSY | Wait for it to finish with GET /api/v1/pass-imports/{id}, then retry. | |
| IMPORT_COLUMN_MISSING | Add the column to the file, or change the mapping, then check again. | |
| IMPORT_EXPIRED | Upload the file again with POST /api/v1/pass-imports. | |
| IMPORT_FILE_GONE | Upload it again. | |
| IMPORT_HAS_ERRORS | Fix the rows listed in GET /api/v1/pass-imports/{id}/errors.csv, or skip them, then commit again. | |
| IMPORT_HEADER_TOO_LONG | Shorten the header and upload the file again. | |
| IMPORT_ID_TAKEN | Check the import again with POST /api/v1/pass-imports/{id}/check, then commit. | |
| IMPORT_NOT_FOUND | Check the id with GET /api/v1/pass-imports. | |
| IMPORT_PASS_CHANGED | Remove the pass on its own with POST /api/v1/passes/{id}/remove. | |
| IMPORT_PLAN_INVALID | Fix the mapping entries named in issues and check again. | |
| IMPORT_ROW_UNRESERVED | Retry the commit; if it persists, send the requestId to support. | |
| IMPORT_STATE | Check its state with GET /api/v1/pass-imports/{id} and call the action that state allows. | |
| INVALID_API_KEY | Create a new key in the console and update PASSBOOK_KEY. | |
| INVALID_INPUT | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| JOIN_NOT_READY | Publish the template, then enable the link with PUT /api/v1/join-links/{templateId}. | |
| MATCH_NEEDS_TEMPLATE | Send orgId and templateId with the input filter. | |
| MEMBER_PHOTO_CHANGED | Fetch the pass with GET /api/v1/passes/{id} and save the photo again. | |
| MEMBER_PHOTO_DIMENSIONS | Crop the photo to a 270 by 270 pixel square and upload it again. | |
| MEMBER_PHOTO_ENCODING | Send the photo as a PNG or JPEG file. | |
| MEMBER_PHOTO_NOT_FOUND | Add one with PUT /api/v1/passes/{id}/member-photo. | |
| MEMBER_PHOTO_STYLE | Use a template of that style, or remove the strip image. | |
| MISSING_SCOPE | Create a key with the scope the operation lists under security. | |
| MODE_MISMATCH | Use objects and a key of the same mode. | |
| NEW_CODE_UNSUPPORTED | Reissue the pass with POST /api/v1/passes/bulk-reissue instead of requesting a new code. | |
| 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_ACCESS_CHANGED | Check access with GET /api/v1/api-keys/me, then send the request again. | |
| ORG_FORBIDDEN | Use a key scoped to this organization, or a platform key for platform-wide lists. | |
| ORG_MIXED | Send ids from one organization per request. | |
| ORG_NOT_FOUND | Check orgId with GET /api/v1/orgs. | |
| ORG_REQUIRED | Send orgId with the request, or use a key scoped to one organization. | |
| PASS_CONFLICT | Fetch the pass with GET /api/v1/passes/{id} and send the request again. | |
| PASS_CONNECTION_MISMATCH | Link it with PUT /api/v1/passes/{id}/connection, then send the request again. | |
| PASS_FILE_MISSING | Rebuild it with POST /api/v1/passes/{id}/refresh. | |
| PASS_INPUT_INVALID | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| PASS_INVALID | Fix the problems named in issues in the template or inputs. | |
| PASS_NOT_ACTIVE | Restore or unvoid the pass first, or use an active one. | |
| PASS_NOT_FOUND | Check the id with GET /api/v1/passes and the key's mode. | |
| PASS_REF_TAKEN | Use a different ref, or update the existing pass. | |
| PASS_REISSUE_REQUIRED | Reissue it with POST /api/v1/passes/bulk-reissue. | |
| PASS_REMOVED | Restore it with POST /api/v1/passes/{id}/restore, then send the request again. | |
| PASS_TRANSFER_NOT_FOUND | Check the transfer id. | |
| PASS_TRANSFER_PENDING | Try again shortly. | |
| 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}. | |
| SCAN_EVENT_NOT_FOUND | Check the event id with GET /api/v1/scan/events. | |
| SCAN_WINDOW_INVALID | Set an end after the start, or fix the template's dates. | |
| SERIAL_TAKEN | Send a different serial, or leave it out to have one generated. | |
| SESSION_REQUIRED | Do it in the console, or sign in as the account that started it. | |
| STAMPS_ABOVE_MAX | Raise the template's stamp maximum, or redeem stamps first. | |
| STAMPS_CARD_FULL | Redeem the reward, then add stamps. | |
| STAMPS_NONE | Use a template with stamps. | |
| STAMPS_NO_REWARD | Add stamps until the card is full, then redeem. | |
| TEMPLATE_NOT_FOUND | Check the id with GET /api/v1/templates and the key's mode. | |
| TEMPLATE_RELEASE_CONFLICT | Send the request again to use the current release. | |
| TEMPLATE_RELEASE_REQUIRED | Approve a release with POST /api/v1/templates/{id}/candidates/{candidateId}/approve. | |
| TERM_MANAGED | Change the term in the connected system. | |
| TERM_NONE | Renew only passes whose template defines a term. | |
| TERM_NOT_STARTED | Renew after the term starts. | |
| UNAUTHENTICATED | Send Authorization: Bearer $PASSBOOK_KEY. | |
| VALIDATION | Fix each field in issues and resend. | |
| VERSION_NOT_FOUND | Check the version with GET /api/v1/passes/{id}. | |
| VERSION_PURGED | Request a newer version. | |
| WORKFLOW_START | Send the request again. |
Connection
/api/v1/passes/{id}/connectionPath
Body
Returns
200 PassDetail
Errors
| Code | Status | Fix |
|---|---|---|
| ASSET_DIMENSIONS | Resize the image to the size named in issues and upload it again. | |
| ASSET_NOT_FOUND | Check the image name or id and that it belongs to this organization. | |
| ASSET_NOT_PNG | Re-export the image as a standard RGB or RGBA PNG and upload it again. | |
| ASSET_SIZE | Compress the image below 1 MB and upload it again. | |
| ASSET_SLOT | Use a slot name from the pass type's image slots in the request path. | |
| BULK_RUN_ACTIVE | Wait for the running job to finish, then start the new one. | |
| BUNDLE_TOO_LARGE | Split the passes across smaller bundles. | |
| CONNECTION_ORG | Use a connection id from your own organization's GET /api/v1/connections. | |
| CONNECTION_TRANSFER_PENDING | Wait for the transfer to finish, then send the request again. | |
| CREATE_STALE | Look the pass up by externalId with GET /api/v1/passes and update it instead of creating it again. | |
| CREDENTIAL_REF_KEYSET_CONFIG_UNAVAILABLE | Retry with backoff; if it persists, send the requestId to support. | |
| CREDENTIAL_REF_KEYSET_UNAVAILABLE | Retry with backoff; if it persists, send the requestId to support. | |
| DELIVERY_STALE | Review the recipient and try again. | |
| DEVICE_TOKEN_UNAVAILABLE | Retry the request; if it persists, send the requestId to support. | |
| EMAIL_INVALID | Send a valid address in the email field. | |
| EXTERNAL_ID_TAKEN | Send a new externalId, or PATCH the existing pass. | |
| FORBIDDEN | Use a key with the scope the operation lists, or ask an org admin. | |
| IDEMPOTENCY_IN_PROGRESS | Wait a moment and resend the identical request. | |
| IDEMPOTENCY_KEY_INVALID | Send a unique string of 1 to 200 characters, such as a UUID. | |
| IDEMPOTENCY_KEY_REUSED | Use a new key for a new request; resend the identical request to replay. | |
| IF_MATCH_INVALID | Send the version from the last GET, for example If-Match: 3. | |
| IMPORT_BUSY | Wait for it to finish with GET /api/v1/pass-imports/{id}, then retry. | |
| IMPORT_COLUMN_MISSING | Add the column to the file, or change the mapping, then check again. | |
| IMPORT_EXPIRED | Upload the file again with POST /api/v1/pass-imports. | |
| IMPORT_FILE_GONE | Upload it again. | |
| IMPORT_HAS_ERRORS | Fix the rows listed in GET /api/v1/pass-imports/{id}/errors.csv, or skip them, then commit again. | |
| IMPORT_HEADER_TOO_LONG | Shorten the header and upload the file again. | |
| IMPORT_ID_TAKEN | Check the import again with POST /api/v1/pass-imports/{id}/check, then commit. | |
| IMPORT_NOT_FOUND | Check the id with GET /api/v1/pass-imports. | |
| IMPORT_PASS_CHANGED | Remove the pass on its own with POST /api/v1/passes/{id}/remove. | |
| IMPORT_PLAN_INVALID | Fix the mapping entries named in issues and check again. | |
| IMPORT_ROW_UNRESERVED | Retry the commit; if it persists, send the requestId to support. | |
| IMPORT_STATE | Check its state with GET /api/v1/pass-imports/{id} and call the action that state allows. | |
| INVALID_API_KEY | Create a new key in the console and update PASSBOOK_KEY. | |
| INVALID_INPUT | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| JOIN_NOT_READY | Publish the template, then enable the link with PUT /api/v1/join-links/{templateId}. | |
| MATCH_NEEDS_TEMPLATE | Send orgId and templateId with the input filter. | |
| MEMBER_PHOTO_CHANGED | Fetch the pass with GET /api/v1/passes/{id} and save the photo again. | |
| MEMBER_PHOTO_DIMENSIONS | Crop the photo to a 270 by 270 pixel square and upload it again. | |
| MEMBER_PHOTO_ENCODING | Send the photo as a PNG or JPEG file. | |
| MEMBER_PHOTO_NOT_FOUND | Add one with PUT /api/v1/passes/{id}/member-photo. | |
| MEMBER_PHOTO_STYLE | Use a template of that style, or remove the strip image. | |
| MISSING_SCOPE | Create a key with the scope the operation lists under security. | |
| MODE_MISMATCH | Use objects and a key of the same mode. | |
| NEW_CODE_UNSUPPORTED | Reissue the pass with POST /api/v1/passes/bulk-reissue instead of requesting a new code. | |
| 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_ACCESS_CHANGED | Check access with GET /api/v1/api-keys/me, then send the request again. | |
| ORG_FORBIDDEN | Use a key scoped to this organization, or a platform key for platform-wide lists. | |
| ORG_MIXED | Send ids from one organization per request. | |
| ORG_NOT_FOUND | Check orgId with GET /api/v1/orgs. | |
| ORG_REQUIRED | Send orgId with the request, or use a key scoped to one organization. | |
| PASS_CONFLICT | Fetch the pass with GET /api/v1/passes/{id} and send the request again. | |
| PASS_CONNECTION_MISMATCH | Link it with PUT /api/v1/passes/{id}/connection, then send the request again. | |
| PASS_FILE_MISSING | Rebuild it with POST /api/v1/passes/{id}/refresh. | |
| PASS_INPUT_INVALID | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| PASS_INVALID | Fix the problems named in issues in the template or inputs. | |
| PASS_NOT_ACTIVE | Restore or unvoid the pass first, or use an active one. | |
| PASS_NOT_FOUND | Check the id with GET /api/v1/passes and the key's mode. | |
| PASS_REF_TAKEN | Use a different ref, or update the existing pass. | |
| PASS_REISSUE_REQUIRED | Reissue it with POST /api/v1/passes/bulk-reissue. | |
| PASS_REMOVED | Restore it with POST /api/v1/passes/{id}/restore, then send the request again. | |
| PASS_TRANSFER_NOT_FOUND | Check the transfer id. | |
| PASS_TRANSFER_PENDING | Try again shortly. | |
| 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}. | |
| SCAN_EVENT_NOT_FOUND | Check the event id with GET /api/v1/scan/events. | |
| SCAN_WINDOW_INVALID | Set an end after the start, or fix the template's dates. | |
| SERIAL_TAKEN | Send a different serial, or leave it out to have one generated. | |
| SESSION_REQUIRED | Do it in the console, or sign in as the account that started it. | |
| STAMPS_ABOVE_MAX | Raise the template's stamp maximum, or redeem stamps first. | |
| STAMPS_CARD_FULL | Redeem the reward, then add stamps. | |
| STAMPS_NONE | Use a template with stamps. | |
| STAMPS_NO_REWARD | Add stamps until the card is full, then redeem. | |
| TEMPLATE_NOT_FOUND | Check the id with GET /api/v1/templates and the key's mode. | |
| TEMPLATE_RELEASE_CONFLICT | Send the request again to use the current release. | |
| TEMPLATE_RELEASE_REQUIRED | Approve a release with POST /api/v1/templates/{id}/candidates/{candidateId}/approve. | |
| TERM_MANAGED | Change the term in the connected system. | |
| TERM_NONE | Renew only passes whose template defines a term. | |
| TERM_NOT_STARTED | Renew after the term starts. | |
| UNAUTHENTICATED | Send Authorization: Bearer $PASSBOOK_KEY. | |
| VALIDATION | Fix each field in issues and resend. | |
| VERSION_NOT_FOUND | Check the version with GET /api/v1/passes/{id}. | |
| VERSION_PURGED | Request a newer version. | |
| WORKFLOW_START | Send the request again. |
Devices
/api/v1/passes/{id}/devicesPath
Returns
200
Errors
| Code | Status | Fix |
|---|---|---|
| ASSET_DIMENSIONS | Resize the image to the size named in issues and upload it again. | |
| ASSET_NOT_FOUND | Check the image name or id and that it belongs to this organization. | |
| ASSET_NOT_PNG | Re-export the image as a standard RGB or RGBA PNG and upload it again. | |
| ASSET_SIZE | Compress the image below 1 MB and upload it again. | |
| ASSET_SLOT | Use a slot name from the pass type's image slots in the request path. | |
| BULK_RUN_ACTIVE | Wait for the running job to finish, then start the new one. | |
| BUNDLE_TOO_LARGE | Split the passes across smaller bundles. | |
| CONNECTION_ORG | Use a connection id from your own organization's GET /api/v1/connections. | |
| CONNECTION_TRANSFER_PENDING | Wait for the transfer to finish, then send the request again. | |
| CREATE_STALE | Look the pass up by externalId with GET /api/v1/passes and update it instead of creating it again. | |
| CREDENTIAL_REF_KEYSET_CONFIG_UNAVAILABLE | Retry with backoff; if it persists, send the requestId to support. | |
| CREDENTIAL_REF_KEYSET_UNAVAILABLE | Retry with backoff; if it persists, send the requestId to support. | |
| DELIVERY_STALE | Review the recipient and try again. | |
| DEVICE_TOKEN_UNAVAILABLE | Retry the request; if it persists, send the requestId to support. | |
| EMAIL_INVALID | Send a valid address in the email field. | |
| EXTERNAL_ID_TAKEN | Send a new externalId, or PATCH the existing pass. | |
| FORBIDDEN | Use a key with the scope the operation lists, or ask an org admin. | |
| IDEMPOTENCY_IN_PROGRESS | Wait a moment and resend the identical request. | |
| IDEMPOTENCY_KEY_INVALID | Send a unique string of 1 to 200 characters, such as a UUID. | |
| IDEMPOTENCY_KEY_REUSED | Use a new key for a new request; resend the identical request to replay. | |
| IF_MATCH_INVALID | Send the version from the last GET, for example If-Match: 3. | |
| IMPORT_BUSY | Wait for it to finish with GET /api/v1/pass-imports/{id}, then retry. | |
| IMPORT_COLUMN_MISSING | Add the column to the file, or change the mapping, then check again. | |
| IMPORT_EXPIRED | Upload the file again with POST /api/v1/pass-imports. | |
| IMPORT_FILE_GONE | Upload it again. | |
| IMPORT_HAS_ERRORS | Fix the rows listed in GET /api/v1/pass-imports/{id}/errors.csv, or skip them, then commit again. | |
| IMPORT_HEADER_TOO_LONG | Shorten the header and upload the file again. | |
| IMPORT_ID_TAKEN | Check the import again with POST /api/v1/pass-imports/{id}/check, then commit. | |
| IMPORT_NOT_FOUND | Check the id with GET /api/v1/pass-imports. | |
| IMPORT_PASS_CHANGED | Remove the pass on its own with POST /api/v1/passes/{id}/remove. | |
| IMPORT_PLAN_INVALID | Fix the mapping entries named in issues and check again. | |
| IMPORT_ROW_UNRESERVED | Retry the commit; if it persists, send the requestId to support. | |
| IMPORT_STATE | Check its state with GET /api/v1/pass-imports/{id} and call the action that state allows. | |
| INVALID_API_KEY | Create a new key in the console and update PASSBOOK_KEY. | |
| INVALID_INPUT | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| JOIN_NOT_READY | Publish the template, then enable the link with PUT /api/v1/join-links/{templateId}. | |
| MATCH_NEEDS_TEMPLATE | Send orgId and templateId with the input filter. | |
| MEMBER_PHOTO_CHANGED | Fetch the pass with GET /api/v1/passes/{id} and save the photo again. | |
| MEMBER_PHOTO_DIMENSIONS | Crop the photo to a 270 by 270 pixel square and upload it again. | |
| MEMBER_PHOTO_ENCODING | Send the photo as a PNG or JPEG file. | |
| MEMBER_PHOTO_NOT_FOUND | Add one with PUT /api/v1/passes/{id}/member-photo. | |
| MEMBER_PHOTO_STYLE | Use a template of that style, or remove the strip image. | |
| MISSING_SCOPE | Create a key with the scope the operation lists under security. | |
| MODE_MISMATCH | Use objects and a key of the same mode. | |
| NEW_CODE_UNSUPPORTED | Reissue the pass with POST /api/v1/passes/bulk-reissue instead of requesting a new code. | |
| 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_ACCESS_CHANGED | Check access with GET /api/v1/api-keys/me, then send the request again. | |
| ORG_FORBIDDEN | Use a key scoped to this organization, or a platform key for platform-wide lists. | |
| ORG_MIXED | Send ids from one organization per request. | |
| ORG_NOT_FOUND | Check orgId with GET /api/v1/orgs. | |
| ORG_REQUIRED | Send orgId with the request, or use a key scoped to one organization. | |
| PASS_CONFLICT | Fetch the pass with GET /api/v1/passes/{id} and send the request again. | |
| PASS_CONNECTION_MISMATCH | Link it with PUT /api/v1/passes/{id}/connection, then send the request again. | |
| PASS_FILE_MISSING | Rebuild it with POST /api/v1/passes/{id}/refresh. | |
| PASS_INPUT_INVALID | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| PASS_INVALID | Fix the problems named in issues in the template or inputs. | |
| PASS_NOT_ACTIVE | Restore or unvoid the pass first, or use an active one. | |
| PASS_NOT_FOUND | Check the id with GET /api/v1/passes and the key's mode. | |
| PASS_REF_TAKEN | Use a different ref, or update the existing pass. | |
| PASS_REISSUE_REQUIRED | Reissue it with POST /api/v1/passes/bulk-reissue. | |
| PASS_REMOVED | Restore it with POST /api/v1/passes/{id}/restore, then send the request again. | |
| PASS_TRANSFER_NOT_FOUND | Check the transfer id. | |
| PASS_TRANSFER_PENDING | Try again shortly. | |
| 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}. | |
| SCAN_EVENT_NOT_FOUND | Check the event id with GET /api/v1/scan/events. | |
| SCAN_WINDOW_INVALID | Set an end after the start, or fix the template's dates. | |
| SERIAL_TAKEN | Send a different serial, or leave it out to have one generated. | |
| SESSION_REQUIRED | Do it in the console, or sign in as the account that started it. | |
| STAMPS_ABOVE_MAX | Raise the template's stamp maximum, or redeem stamps first. | |
| STAMPS_CARD_FULL | Redeem the reward, then add stamps. | |
| STAMPS_NONE | Use a template with stamps. | |
| STAMPS_NO_REWARD | Add stamps until the card is full, then redeem. | |
| TEMPLATE_NOT_FOUND | Check the id with GET /api/v1/templates and the key's mode. | |
| TEMPLATE_RELEASE_CONFLICT | Send the request again to use the current release. | |
| TEMPLATE_RELEASE_REQUIRED | Approve a release with POST /api/v1/templates/{id}/candidates/{candidateId}/approve. | |
| TERM_MANAGED | Change the term in the connected system. | |
| TERM_NONE | Renew only passes whose template defines a term. | |
| TERM_NOT_STARTED | Renew after the term starts. | |
| UNAUTHENTICATED | Send Authorization: Bearer $PASSBOOK_KEY. | |
| VALIDATION | Fix each field in issues and resend. | |
| VERSION_NOT_FOUND | Check the version with GET /api/v1/passes/{id}. | |
| VERSION_PURGED | Request a newer version. | |
| WORKFLOW_START | Send the request again. |
Member Photo
/api/v1/passes/{id}/member-photoPath
Returns
200
Errors
| Code | Status | Fix |
|---|---|---|
| ASSET_DIMENSIONS | Resize the image to the size named in issues and upload it again. | |
| ASSET_NOT_FOUND | Check the image name or id and that it belongs to this organization. | |
| ASSET_NOT_PNG | Re-export the image as a standard RGB or RGBA PNG and upload it again. | |
| ASSET_SIZE | Compress the image below 1 MB and upload it again. | |
| ASSET_SLOT | Use a slot name from the pass type's image slots in the request path. | |
| BULK_RUN_ACTIVE | Wait for the running job to finish, then start the new one. | |
| BUNDLE_TOO_LARGE | Split the passes across smaller bundles. | |
| CONNECTION_ORG | Use a connection id from your own organization's GET /api/v1/connections. | |
| CONNECTION_TRANSFER_PENDING | Wait for the transfer to finish, then send the request again. | |
| CREATE_STALE | Look the pass up by externalId with GET /api/v1/passes and update it instead of creating it again. | |
| CREDENTIAL_REF_KEYSET_CONFIG_UNAVAILABLE | Retry with backoff; if it persists, send the requestId to support. | |
| CREDENTIAL_REF_KEYSET_UNAVAILABLE | Retry with backoff; if it persists, send the requestId to support. | |
| DELIVERY_STALE | Review the recipient and try again. | |
| DEVICE_TOKEN_UNAVAILABLE | Retry the request; if it persists, send the requestId to support. | |
| EMAIL_INVALID | Send a valid address in the email field. | |
| EXTERNAL_ID_TAKEN | Send a new externalId, or PATCH the existing pass. | |
| FORBIDDEN | Use a key with the scope the operation lists, or ask an org admin. | |
| IDEMPOTENCY_IN_PROGRESS | Wait a moment and resend the identical request. | |
| IDEMPOTENCY_KEY_INVALID | Send a unique string of 1 to 200 characters, such as a UUID. | |
| IDEMPOTENCY_KEY_REUSED | Use a new key for a new request; resend the identical request to replay. | |
| IF_MATCH_INVALID | Send the version from the last GET, for example If-Match: 3. | |
| IMPORT_BUSY | Wait for it to finish with GET /api/v1/pass-imports/{id}, then retry. | |
| IMPORT_COLUMN_MISSING | Add the column to the file, or change the mapping, then check again. | |
| IMPORT_EXPIRED | Upload the file again with POST /api/v1/pass-imports. | |
| IMPORT_FILE_GONE | Upload it again. | |
| IMPORT_HAS_ERRORS | Fix the rows listed in GET /api/v1/pass-imports/{id}/errors.csv, or skip them, then commit again. | |
| IMPORT_HEADER_TOO_LONG | Shorten the header and upload the file again. | |
| IMPORT_ID_TAKEN | Check the import again with POST /api/v1/pass-imports/{id}/check, then commit. | |
| IMPORT_NOT_FOUND | Check the id with GET /api/v1/pass-imports. | |
| IMPORT_PASS_CHANGED | Remove the pass on its own with POST /api/v1/passes/{id}/remove. | |
| IMPORT_PLAN_INVALID | Fix the mapping entries named in issues and check again. | |
| IMPORT_ROW_UNRESERVED | Retry the commit; if it persists, send the requestId to support. | |
| IMPORT_STATE | Check its state with GET /api/v1/pass-imports/{id} and call the action that state allows. | |
| INVALID_API_KEY | Create a new key in the console and update PASSBOOK_KEY. | |
| INVALID_INPUT | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| JOIN_NOT_READY | Publish the template, then enable the link with PUT /api/v1/join-links/{templateId}. | |
| MATCH_NEEDS_TEMPLATE | Send orgId and templateId with the input filter. | |
| MEMBER_PHOTO_CHANGED | Fetch the pass with GET /api/v1/passes/{id} and save the photo again. | |
| MEMBER_PHOTO_DIMENSIONS | Crop the photo to a 270 by 270 pixel square and upload it again. | |
| MEMBER_PHOTO_ENCODING | Send the photo as a PNG or JPEG file. | |
| MEMBER_PHOTO_NOT_FOUND | Add one with PUT /api/v1/passes/{id}/member-photo. | |
| MEMBER_PHOTO_STYLE | Use a template of that style, or remove the strip image. | |
| MISSING_SCOPE | Create a key with the scope the operation lists under security. | |
| MODE_MISMATCH | Use objects and a key of the same mode. | |
| NEW_CODE_UNSUPPORTED | Reissue the pass with POST /api/v1/passes/bulk-reissue instead of requesting a new code. | |
| 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_ACCESS_CHANGED | Check access with GET /api/v1/api-keys/me, then send the request again. | |
| ORG_FORBIDDEN | Use a key scoped to this organization, or a platform key for platform-wide lists. | |
| ORG_MIXED | Send ids from one organization per request. | |
| ORG_NOT_FOUND | Check orgId with GET /api/v1/orgs. | |
| ORG_REQUIRED | Send orgId with the request, or use a key scoped to one organization. | |
| PASS_CONFLICT | Fetch the pass with GET /api/v1/passes/{id} and send the request again. | |
| PASS_CONNECTION_MISMATCH | Link it with PUT /api/v1/passes/{id}/connection, then send the request again. | |
| PASS_FILE_MISSING | Rebuild it with POST /api/v1/passes/{id}/refresh. | |
| PASS_INPUT_INVALID | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| PASS_INVALID | Fix the problems named in issues in the template or inputs. | |
| PASS_NOT_ACTIVE | Restore or unvoid the pass first, or use an active one. | |
| PASS_NOT_FOUND | Check the id with GET /api/v1/passes and the key's mode. | |
| PASS_REF_TAKEN | Use a different ref, or update the existing pass. | |
| PASS_REISSUE_REQUIRED | Reissue it with POST /api/v1/passes/bulk-reissue. | |
| PASS_REMOVED | Restore it with POST /api/v1/passes/{id}/restore, then send the request again. | |
| PASS_TRANSFER_NOT_FOUND | Check the transfer id. | |
| PASS_TRANSFER_PENDING | Try again shortly. | |
| 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}. | |
| SCAN_EVENT_NOT_FOUND | Check the event id with GET /api/v1/scan/events. | |
| SCAN_WINDOW_INVALID | Set an end after the start, or fix the template's dates. | |
| SERIAL_TAKEN | Send a different serial, or leave it out to have one generated. | |
| SESSION_REQUIRED | Do it in the console, or sign in as the account that started it. | |
| STAMPS_ABOVE_MAX | Raise the template's stamp maximum, or redeem stamps first. | |
| STAMPS_CARD_FULL | Redeem the reward, then add stamps. | |
| STAMPS_NONE | Use a template with stamps. | |
| STAMPS_NO_REWARD | Add stamps until the card is full, then redeem. | |
| TEMPLATE_NOT_FOUND | Check the id with GET /api/v1/templates and the key's mode. | |
| TEMPLATE_RELEASE_CONFLICT | Send the request again to use the current release. | |
| TEMPLATE_RELEASE_REQUIRED | Approve a release with POST /api/v1/templates/{id}/candidates/{candidateId}/approve. | |
| TERM_MANAGED | Change the term in the connected system. | |
| TERM_NONE | Renew only passes whose template defines a term. | |
| TERM_NOT_STARTED | Renew after the term starts. | |
| UNAUTHENTICATED | Send Authorization: Bearer $PASSBOOK_KEY. | |
| VALIDATION | Fix each field in issues and resend. | |
| VERSION_NOT_FOUND | Check the version with GET /api/v1/passes/{id}. | |
| VERSION_PURGED | Request a newer version. | |
| WORKFLOW_START | Send the request again. |
/api/v1/passes/{id}/member-photoPath
Body
Returns
200
Errors
| Code | Status | Fix |
|---|---|---|
| ASSET_DIMENSIONS | Resize the image to the size named in issues and upload it again. | |
| ASSET_NOT_FOUND | Check the image name or id and that it belongs to this organization. | |
| ASSET_NOT_PNG | Re-export the image as a standard RGB or RGBA PNG and upload it again. | |
| ASSET_SIZE | Compress the image below 1 MB and upload it again. | |
| ASSET_SLOT | Use a slot name from the pass type's image slots in the request path. | |
| BULK_RUN_ACTIVE | Wait for the running job to finish, then start the new one. | |
| BUNDLE_TOO_LARGE | Split the passes across smaller bundles. | |
| CONNECTION_ORG | Use a connection id from your own organization's GET /api/v1/connections. | |
| CONNECTION_TRANSFER_PENDING | Wait for the transfer to finish, then send the request again. | |
| CREATE_STALE | Look the pass up by externalId with GET /api/v1/passes and update it instead of creating it again. | |
| CREDENTIAL_REF_KEYSET_CONFIG_UNAVAILABLE | Retry with backoff; if it persists, send the requestId to support. | |
| CREDENTIAL_REF_KEYSET_UNAVAILABLE | Retry with backoff; if it persists, send the requestId to support. | |
| DELIVERY_STALE | Review the recipient and try again. | |
| DEVICE_TOKEN_UNAVAILABLE | Retry the request; if it persists, send the requestId to support. | |
| EMAIL_INVALID | Send a valid address in the email field. | |
| EXTERNAL_ID_TAKEN | Send a new externalId, or PATCH the existing pass. | |
| FORBIDDEN | Use a key with the scope the operation lists, or ask an org admin. | |
| IDEMPOTENCY_IN_PROGRESS | Wait a moment and resend the identical request. | |
| IDEMPOTENCY_KEY_INVALID | Send a unique string of 1 to 200 characters, such as a UUID. | |
| IDEMPOTENCY_KEY_REUSED | Use a new key for a new request; resend the identical request to replay. | |
| IF_MATCH_INVALID | Send the version from the last GET, for example If-Match: 3. | |
| IMPORT_BUSY | Wait for it to finish with GET /api/v1/pass-imports/{id}, then retry. | |
| IMPORT_COLUMN_MISSING | Add the column to the file, or change the mapping, then check again. | |
| IMPORT_EXPIRED | Upload the file again with POST /api/v1/pass-imports. | |
| IMPORT_FILE_GONE | Upload it again. | |
| IMPORT_HAS_ERRORS | Fix the rows listed in GET /api/v1/pass-imports/{id}/errors.csv, or skip them, then commit again. | |
| IMPORT_HEADER_TOO_LONG | Shorten the header and upload the file again. | |
| IMPORT_ID_TAKEN | Check the import again with POST /api/v1/pass-imports/{id}/check, then commit. | |
| IMPORT_NOT_FOUND | Check the id with GET /api/v1/pass-imports. | |
| IMPORT_PASS_CHANGED | Remove the pass on its own with POST /api/v1/passes/{id}/remove. | |
| IMPORT_PLAN_INVALID | Fix the mapping entries named in issues and check again. | |
| IMPORT_ROW_UNRESERVED | Retry the commit; if it persists, send the requestId to support. | |
| IMPORT_STATE | Check its state with GET /api/v1/pass-imports/{id} and call the action that state allows. | |
| INVALID_API_KEY | Create a new key in the console and update PASSBOOK_KEY. | |
| INVALID_INPUT | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| JOIN_NOT_READY | Publish the template, then enable the link with PUT /api/v1/join-links/{templateId}. | |
| MATCH_NEEDS_TEMPLATE | Send orgId and templateId with the input filter. | |
| MEMBER_PHOTO_CHANGED | Fetch the pass with GET /api/v1/passes/{id} and save the photo again. | |
| MEMBER_PHOTO_DIMENSIONS | Crop the photo to a 270 by 270 pixel square and upload it again. | |
| MEMBER_PHOTO_ENCODING | Send the photo as a PNG or JPEG file. | |
| MEMBER_PHOTO_NOT_FOUND | Add one with PUT /api/v1/passes/{id}/member-photo. | |
| MEMBER_PHOTO_STYLE | Use a template of that style, or remove the strip image. | |
| MISSING_SCOPE | Create a key with the scope the operation lists under security. | |
| MODE_MISMATCH | Use objects and a key of the same mode. | |
| NEW_CODE_UNSUPPORTED | Reissue the pass with POST /api/v1/passes/bulk-reissue instead of requesting a new code. | |
| 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_ACCESS_CHANGED | Check access with GET /api/v1/api-keys/me, then send the request again. | |
| ORG_FORBIDDEN | Use a key scoped to this organization, or a platform key for platform-wide lists. | |
| ORG_MIXED | Send ids from one organization per request. | |
| ORG_NOT_FOUND | Check orgId with GET /api/v1/orgs. | |
| ORG_REQUIRED | Send orgId with the request, or use a key scoped to one organization. | |
| PASS_CONFLICT | Fetch the pass with GET /api/v1/passes/{id} and send the request again. | |
| PASS_CONNECTION_MISMATCH | Link it with PUT /api/v1/passes/{id}/connection, then send the request again. | |
| PASS_FILE_MISSING | Rebuild it with POST /api/v1/passes/{id}/refresh. | |
| PASS_INPUT_INVALID | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| PASS_INVALID | Fix the problems named in issues in the template or inputs. | |
| PASS_NOT_ACTIVE | Restore or unvoid the pass first, or use an active one. | |
| PASS_NOT_FOUND | Check the id with GET /api/v1/passes and the key's mode. | |
| PASS_REF_TAKEN | Use a different ref, or update the existing pass. | |
| PASS_REISSUE_REQUIRED | Reissue it with POST /api/v1/passes/bulk-reissue. | |
| PASS_REMOVED | Restore it with POST /api/v1/passes/{id}/restore, then send the request again. | |
| PASS_TRANSFER_NOT_FOUND | Check the transfer id. | |
| PASS_TRANSFER_PENDING | Try again shortly. | |
| 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}. | |
| SCAN_EVENT_NOT_FOUND | Check the event id with GET /api/v1/scan/events. | |
| SCAN_WINDOW_INVALID | Set an end after the start, or fix the template's dates. | |
| SERIAL_TAKEN | Send a different serial, or leave it out to have one generated. | |
| SESSION_REQUIRED | Do it in the console, or sign in as the account that started it. | |
| STAMPS_ABOVE_MAX | Raise the template's stamp maximum, or redeem stamps first. | |
| STAMPS_CARD_FULL | Redeem the reward, then add stamps. | |
| STAMPS_NONE | Use a template with stamps. | |
| STAMPS_NO_REWARD | Add stamps until the card is full, then redeem. | |
| TEMPLATE_NOT_FOUND | Check the id with GET /api/v1/templates and the key's mode. | |
| TEMPLATE_RELEASE_CONFLICT | Send the request again to use the current release. | |
| TEMPLATE_RELEASE_REQUIRED | Approve a release with POST /api/v1/templates/{id}/candidates/{candidateId}/approve. | |
| TERM_MANAGED | Change the term in the connected system. | |
| TERM_NONE | Renew only passes whose template defines a term. | |
| TERM_NOT_STARTED | Renew after the term starts. | |
| UNAUTHENTICATED | Send Authorization: Bearer $PASSBOOK_KEY. | |
| VALIDATION | Fix each field in issues and resend. | |
| VERSION_NOT_FOUND | Check the version with GET /api/v1/passes/{id}. | |
| VERSION_PURGED | Request a newer version. | |
| WORKFLOW_START | Send the request again. |
/api/v1/passes/{id}/member-photoPath
Body
Returns
200
Errors
| Code | Status | Fix |
|---|---|---|
| ASSET_DIMENSIONS | Resize the image to the size named in issues and upload it again. | |
| ASSET_NOT_FOUND | Check the image name or id and that it belongs to this organization. | |
| ASSET_NOT_PNG | Re-export the image as a standard RGB or RGBA PNG and upload it again. | |
| ASSET_SIZE | Compress the image below 1 MB and upload it again. | |
| ASSET_SLOT | Use a slot name from the pass type's image slots in the request path. | |
| BULK_RUN_ACTIVE | Wait for the running job to finish, then start the new one. | |
| BUNDLE_TOO_LARGE | Split the passes across smaller bundles. | |
| CONNECTION_ORG | Use a connection id from your own organization's GET /api/v1/connections. | |
| CONNECTION_TRANSFER_PENDING | Wait for the transfer to finish, then send the request again. | |
| CREATE_STALE | Look the pass up by externalId with GET /api/v1/passes and update it instead of creating it again. | |
| CREDENTIAL_REF_KEYSET_CONFIG_UNAVAILABLE | Retry with backoff; if it persists, send the requestId to support. | |
| CREDENTIAL_REF_KEYSET_UNAVAILABLE | Retry with backoff; if it persists, send the requestId to support. | |
| DELIVERY_STALE | Review the recipient and try again. | |
| DEVICE_TOKEN_UNAVAILABLE | Retry the request; if it persists, send the requestId to support. | |
| EMAIL_INVALID | Send a valid address in the email field. | |
| EXTERNAL_ID_TAKEN | Send a new externalId, or PATCH the existing pass. | |
| FORBIDDEN | Use a key with the scope the operation lists, or ask an org admin. | |
| IDEMPOTENCY_IN_PROGRESS | Wait a moment and resend the identical request. | |
| IDEMPOTENCY_KEY_INVALID | Send a unique string of 1 to 200 characters, such as a UUID. | |
| IDEMPOTENCY_KEY_REUSED | Use a new key for a new request; resend the identical request to replay. | |
| IF_MATCH_INVALID | Send the version from the last GET, for example If-Match: 3. | |
| IMPORT_BUSY | Wait for it to finish with GET /api/v1/pass-imports/{id}, then retry. | |
| IMPORT_COLUMN_MISSING | Add the column to the file, or change the mapping, then check again. | |
| IMPORT_EXPIRED | Upload the file again with POST /api/v1/pass-imports. | |
| IMPORT_FILE_GONE | Upload it again. | |
| IMPORT_HAS_ERRORS | Fix the rows listed in GET /api/v1/pass-imports/{id}/errors.csv, or skip them, then commit again. | |
| IMPORT_HEADER_TOO_LONG | Shorten the header and upload the file again. | |
| IMPORT_ID_TAKEN | Check the import again with POST /api/v1/pass-imports/{id}/check, then commit. | |
| IMPORT_NOT_FOUND | Check the id with GET /api/v1/pass-imports. | |
| IMPORT_PASS_CHANGED | Remove the pass on its own with POST /api/v1/passes/{id}/remove. | |
| IMPORT_PLAN_INVALID | Fix the mapping entries named in issues and check again. | |
| IMPORT_ROW_UNRESERVED | Retry the commit; if it persists, send the requestId to support. | |
| IMPORT_STATE | Check its state with GET /api/v1/pass-imports/{id} and call the action that state allows. | |
| INVALID_API_KEY | Create a new key in the console and update PASSBOOK_KEY. | |
| INVALID_INPUT | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| JOIN_NOT_READY | Publish the template, then enable the link with PUT /api/v1/join-links/{templateId}. | |
| MATCH_NEEDS_TEMPLATE | Send orgId and templateId with the input filter. | |
| MEMBER_PHOTO_CHANGED | Fetch the pass with GET /api/v1/passes/{id} and save the photo again. | |
| MEMBER_PHOTO_DIMENSIONS | Crop the photo to a 270 by 270 pixel square and upload it again. | |
| MEMBER_PHOTO_ENCODING | Send the photo as a PNG or JPEG file. | |
| MEMBER_PHOTO_NOT_FOUND | Add one with PUT /api/v1/passes/{id}/member-photo. | |
| MEMBER_PHOTO_STYLE | Use a template of that style, or remove the strip image. | |
| MISSING_SCOPE | Create a key with the scope the operation lists under security. | |
| MODE_MISMATCH | Use objects and a key of the same mode. | |
| NEW_CODE_UNSUPPORTED | Reissue the pass with POST /api/v1/passes/bulk-reissue instead of requesting a new code. | |
| 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_ACCESS_CHANGED | Check access with GET /api/v1/api-keys/me, then send the request again. | |
| ORG_FORBIDDEN | Use a key scoped to this organization, or a platform key for platform-wide lists. | |
| ORG_MIXED | Send ids from one organization per request. | |
| ORG_NOT_FOUND | Check orgId with GET /api/v1/orgs. | |
| ORG_REQUIRED | Send orgId with the request, or use a key scoped to one organization. | |
| PASS_CONFLICT | Fetch the pass with GET /api/v1/passes/{id} and send the request again. | |
| PASS_CONNECTION_MISMATCH | Link it with PUT /api/v1/passes/{id}/connection, then send the request again. | |
| PASS_FILE_MISSING | Rebuild it with POST /api/v1/passes/{id}/refresh. | |
| PASS_INPUT_INVALID | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| PASS_INVALID | Fix the problems named in issues in the template or inputs. | |
| PASS_NOT_ACTIVE | Restore or unvoid the pass first, or use an active one. | |
| PASS_NOT_FOUND | Check the id with GET /api/v1/passes and the key's mode. | |
| PASS_REF_TAKEN | Use a different ref, or update the existing pass. | |
| PASS_REISSUE_REQUIRED | Reissue it with POST /api/v1/passes/bulk-reissue. | |
| PASS_REMOVED | Restore it with POST /api/v1/passes/{id}/restore, then send the request again. | |
| PASS_TRANSFER_NOT_FOUND | Check the transfer id. | |
| PASS_TRANSFER_PENDING | Try again shortly. | |
| 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}. | |
| SCAN_EVENT_NOT_FOUND | Check the event id with GET /api/v1/scan/events. | |
| SCAN_WINDOW_INVALID | Set an end after the start, or fix the template's dates. | |
| SERIAL_TAKEN | Send a different serial, or leave it out to have one generated. | |
| SESSION_REQUIRED | Do it in the console, or sign in as the account that started it. | |
| STAMPS_ABOVE_MAX | Raise the template's stamp maximum, or redeem stamps first. | |
| STAMPS_CARD_FULL | Redeem the reward, then add stamps. | |
| STAMPS_NONE | Use a template with stamps. | |
| STAMPS_NO_REWARD | Add stamps until the card is full, then redeem. | |
| TEMPLATE_NOT_FOUND | Check the id with GET /api/v1/templates and the key's mode. | |
| TEMPLATE_RELEASE_CONFLICT | Send the request again to use the current release. | |
| TEMPLATE_RELEASE_REQUIRED | Approve a release with POST /api/v1/templates/{id}/candidates/{candidateId}/approve. | |
| TERM_MANAGED | Change the term in the connected system. | |
| TERM_NONE | Renew only passes whose template defines a term. | |
| TERM_NOT_STARTED | Renew after the term starts. | |
| UNAUTHENTICATED | Send Authorization: Bearer $PASSBOOK_KEY. | |
| VALIDATION | Fix each field in issues and resend. | |
| VERSION_NOT_FOUND | Check the version with GET /api/v1/passes/{id}. | |
| VERSION_PURGED | Request a newer version. | |
| WORKFLOW_START | Send the request again. |
/api/v1/passes/{id}/member-photoPath
Returns
200
Errors
| Code | Status | Fix |
|---|---|---|
| ASSET_DIMENSIONS | Resize the image to the size named in issues and upload it again. | |
| ASSET_NOT_FOUND | Check the image name or id and that it belongs to this organization. | |
| ASSET_NOT_PNG | Re-export the image as a standard RGB or RGBA PNG and upload it again. | |
| ASSET_SIZE | Compress the image below 1 MB and upload it again. | |
| ASSET_SLOT | Use a slot name from the pass type's image slots in the request path. | |
| BULK_RUN_ACTIVE | Wait for the running job to finish, then start the new one. | |
| BUNDLE_TOO_LARGE | Split the passes across smaller bundles. | |
| CONNECTION_ORG | Use a connection id from your own organization's GET /api/v1/connections. | |
| CONNECTION_TRANSFER_PENDING | Wait for the transfer to finish, then send the request again. | |
| CREATE_STALE | Look the pass up by externalId with GET /api/v1/passes and update it instead of creating it again. | |
| CREDENTIAL_REF_KEYSET_CONFIG_UNAVAILABLE | Retry with backoff; if it persists, send the requestId to support. | |
| CREDENTIAL_REF_KEYSET_UNAVAILABLE | Retry with backoff; if it persists, send the requestId to support. | |
| DELIVERY_STALE | Review the recipient and try again. | |
| DEVICE_TOKEN_UNAVAILABLE | Retry the request; if it persists, send the requestId to support. | |
| EMAIL_INVALID | Send a valid address in the email field. | |
| EXTERNAL_ID_TAKEN | Send a new externalId, or PATCH the existing pass. | |
| FORBIDDEN | Use a key with the scope the operation lists, or ask an org admin. | |
| IDEMPOTENCY_IN_PROGRESS | Wait a moment and resend the identical request. | |
| IDEMPOTENCY_KEY_INVALID | Send a unique string of 1 to 200 characters, such as a UUID. | |
| IDEMPOTENCY_KEY_REUSED | Use a new key for a new request; resend the identical request to replay. | |
| IF_MATCH_INVALID | Send the version from the last GET, for example If-Match: 3. | |
| IMPORT_BUSY | Wait for it to finish with GET /api/v1/pass-imports/{id}, then retry. | |
| IMPORT_COLUMN_MISSING | Add the column to the file, or change the mapping, then check again. | |
| IMPORT_EXPIRED | Upload the file again with POST /api/v1/pass-imports. | |
| IMPORT_FILE_GONE | Upload it again. | |
| IMPORT_HAS_ERRORS | Fix the rows listed in GET /api/v1/pass-imports/{id}/errors.csv, or skip them, then commit again. | |
| IMPORT_HEADER_TOO_LONG | Shorten the header and upload the file again. | |
| IMPORT_ID_TAKEN | Check the import again with POST /api/v1/pass-imports/{id}/check, then commit. | |
| IMPORT_NOT_FOUND | Check the id with GET /api/v1/pass-imports. | |
| IMPORT_PASS_CHANGED | Remove the pass on its own with POST /api/v1/passes/{id}/remove. | |
| IMPORT_PLAN_INVALID | Fix the mapping entries named in issues and check again. | |
| IMPORT_ROW_UNRESERVED | Retry the commit; if it persists, send the requestId to support. | |
| IMPORT_STATE | Check its state with GET /api/v1/pass-imports/{id} and call the action that state allows. | |
| INVALID_API_KEY | Create a new key in the console and update PASSBOOK_KEY. | |
| INVALID_INPUT | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| JOIN_NOT_READY | Publish the template, then enable the link with PUT /api/v1/join-links/{templateId}. | |
| MATCH_NEEDS_TEMPLATE | Send orgId and templateId with the input filter. | |
| MEMBER_PHOTO_CHANGED | Fetch the pass with GET /api/v1/passes/{id} and save the photo again. | |
| MEMBER_PHOTO_DIMENSIONS | Crop the photo to a 270 by 270 pixel square and upload it again. | |
| MEMBER_PHOTO_ENCODING | Send the photo as a PNG or JPEG file. | |
| MEMBER_PHOTO_NOT_FOUND | Add one with PUT /api/v1/passes/{id}/member-photo. | |
| MEMBER_PHOTO_STYLE | Use a template of that style, or remove the strip image. | |
| MISSING_SCOPE | Create a key with the scope the operation lists under security. | |
| MODE_MISMATCH | Use objects and a key of the same mode. | |
| NEW_CODE_UNSUPPORTED | Reissue the pass with POST /api/v1/passes/bulk-reissue instead of requesting a new code. | |
| 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_ACCESS_CHANGED | Check access with GET /api/v1/api-keys/me, then send the request again. | |
| ORG_FORBIDDEN | Use a key scoped to this organization, or a platform key for platform-wide lists. | |
| ORG_MIXED | Send ids from one organization per request. | |
| ORG_NOT_FOUND | Check orgId with GET /api/v1/orgs. | |
| ORG_REQUIRED | Send orgId with the request, or use a key scoped to one organization. | |
| PASS_CONFLICT | Fetch the pass with GET /api/v1/passes/{id} and send the request again. | |
| PASS_CONNECTION_MISMATCH | Link it with PUT /api/v1/passes/{id}/connection, then send the request again. | |
| PASS_FILE_MISSING | Rebuild it with POST /api/v1/passes/{id}/refresh. | |
| PASS_INPUT_INVALID | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| PASS_INVALID | Fix the problems named in issues in the template or inputs. | |
| PASS_NOT_ACTIVE | Restore or unvoid the pass first, or use an active one. | |
| PASS_NOT_FOUND | Check the id with GET /api/v1/passes and the key's mode. | |
| PASS_REF_TAKEN | Use a different ref, or update the existing pass. | |
| PASS_REISSUE_REQUIRED | Reissue it with POST /api/v1/passes/bulk-reissue. | |
| PASS_REMOVED | Restore it with POST /api/v1/passes/{id}/restore, then send the request again. | |
| PASS_TRANSFER_NOT_FOUND | Check the transfer id. | |
| PASS_TRANSFER_PENDING | Try again shortly. | |
| 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}. | |
| SCAN_EVENT_NOT_FOUND | Check the event id with GET /api/v1/scan/events. | |
| SCAN_WINDOW_INVALID | Set an end after the start, or fix the template's dates. | |
| SERIAL_TAKEN | Send a different serial, or leave it out to have one generated. | |
| SESSION_REQUIRED | Do it in the console, or sign in as the account that started it. | |
| STAMPS_ABOVE_MAX | Raise the template's stamp maximum, or redeem stamps first. | |
| STAMPS_CARD_FULL | Redeem the reward, then add stamps. | |
| STAMPS_NONE | Use a template with stamps. | |
| STAMPS_NO_REWARD | Add stamps until the card is full, then redeem. | |
| TEMPLATE_NOT_FOUND | Check the id with GET /api/v1/templates and the key's mode. | |
| TEMPLATE_RELEASE_CONFLICT | Send the request again to use the current release. | |
| TEMPLATE_RELEASE_REQUIRED | Approve a release with POST /api/v1/templates/{id}/candidates/{candidateId}/approve. | |
| TERM_MANAGED | Change the term in the connected system. | |
| TERM_NONE | Renew only passes whose template defines a term. | |
| TERM_NOT_STARTED | Renew after the term starts. | |
| UNAUTHENTICATED | Send Authorization: Bearer $PASSBOOK_KEY. | |
| VALIDATION | Fix each field in issues and resend. | |
| VERSION_NOT_FOUND | Check the version with GET /api/v1/passes/{id}. | |
| VERSION_PURGED | Request a newer version. | |
| WORKFLOW_START | Send the request again. |
/api/v1/passes/{id}/member-photo/imagePath
Returns
200
Errors
| Code | Status | Fix |
|---|---|---|
| ASSET_DIMENSIONS | Resize the image to the size named in issues and upload it again. | |
| ASSET_NOT_FOUND | Check the image name or id and that it belongs to this organization. | |
| ASSET_NOT_PNG | Re-export the image as a standard RGB or RGBA PNG and upload it again. | |
| ASSET_SIZE | Compress the image below 1 MB and upload it again. | |
| ASSET_SLOT | Use a slot name from the pass type's image slots in the request path. | |
| BULK_RUN_ACTIVE | Wait for the running job to finish, then start the new one. | |
| BUNDLE_TOO_LARGE | Split the passes across smaller bundles. | |
| CONNECTION_ORG | Use a connection id from your own organization's GET /api/v1/connections. | |
| CONNECTION_TRANSFER_PENDING | Wait for the transfer to finish, then send the request again. | |
| CREATE_STALE | Look the pass up by externalId with GET /api/v1/passes and update it instead of creating it again. | |
| CREDENTIAL_REF_KEYSET_CONFIG_UNAVAILABLE | Retry with backoff; if it persists, send the requestId to support. | |
| CREDENTIAL_REF_KEYSET_UNAVAILABLE | Retry with backoff; if it persists, send the requestId to support. | |
| DELIVERY_STALE | Review the recipient and try again. | |
| DEVICE_TOKEN_UNAVAILABLE | Retry the request; if it persists, send the requestId to support. | |
| EMAIL_INVALID | Send a valid address in the email field. | |
| EXTERNAL_ID_TAKEN | Send a new externalId, or PATCH the existing pass. | |
| FORBIDDEN | Use a key with the scope the operation lists, or ask an org admin. | |
| IDEMPOTENCY_IN_PROGRESS | Wait a moment and resend the identical request. | |
| IDEMPOTENCY_KEY_INVALID | Send a unique string of 1 to 200 characters, such as a UUID. | |
| IDEMPOTENCY_KEY_REUSED | Use a new key for a new request; resend the identical request to replay. | |
| IF_MATCH_INVALID | Send the version from the last GET, for example If-Match: 3. | |
| IMPORT_BUSY | Wait for it to finish with GET /api/v1/pass-imports/{id}, then retry. | |
| IMPORT_COLUMN_MISSING | Add the column to the file, or change the mapping, then check again. | |
| IMPORT_EXPIRED | Upload the file again with POST /api/v1/pass-imports. | |
| IMPORT_FILE_GONE | Upload it again. | |
| IMPORT_HAS_ERRORS | Fix the rows listed in GET /api/v1/pass-imports/{id}/errors.csv, or skip them, then commit again. | |
| IMPORT_HEADER_TOO_LONG | Shorten the header and upload the file again. | |
| IMPORT_ID_TAKEN | Check the import again with POST /api/v1/pass-imports/{id}/check, then commit. | |
| IMPORT_NOT_FOUND | Check the id with GET /api/v1/pass-imports. | |
| IMPORT_PASS_CHANGED | Remove the pass on its own with POST /api/v1/passes/{id}/remove. | |
| IMPORT_PLAN_INVALID | Fix the mapping entries named in issues and check again. | |
| IMPORT_ROW_UNRESERVED | Retry the commit; if it persists, send the requestId to support. | |
| IMPORT_STATE | Check its state with GET /api/v1/pass-imports/{id} and call the action that state allows. | |
| INVALID_API_KEY | Create a new key in the console and update PASSBOOK_KEY. | |
| INVALID_INPUT | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| JOIN_NOT_READY | Publish the template, then enable the link with PUT /api/v1/join-links/{templateId}. | |
| MATCH_NEEDS_TEMPLATE | Send orgId and templateId with the input filter. | |
| MEMBER_PHOTO_CHANGED | Fetch the pass with GET /api/v1/passes/{id} and save the photo again. | |
| MEMBER_PHOTO_DIMENSIONS | Crop the photo to a 270 by 270 pixel square and upload it again. | |
| MEMBER_PHOTO_ENCODING | Send the photo as a PNG or JPEG file. | |
| MEMBER_PHOTO_NOT_FOUND | Add one with PUT /api/v1/passes/{id}/member-photo. | |
| MEMBER_PHOTO_STYLE | Use a template of that style, or remove the strip image. | |
| MISSING_SCOPE | Create a key with the scope the operation lists under security. | |
| MODE_MISMATCH | Use objects and a key of the same mode. | |
| NEW_CODE_UNSUPPORTED | Reissue the pass with POST /api/v1/passes/bulk-reissue instead of requesting a new code. | |
| 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_ACCESS_CHANGED | Check access with GET /api/v1/api-keys/me, then send the request again. | |
| ORG_FORBIDDEN | Use a key scoped to this organization, or a platform key for platform-wide lists. | |
| ORG_MIXED | Send ids from one organization per request. | |
| ORG_NOT_FOUND | Check orgId with GET /api/v1/orgs. | |
| ORG_REQUIRED | Send orgId with the request, or use a key scoped to one organization. | |
| PASS_CONFLICT | Fetch the pass with GET /api/v1/passes/{id} and send the request again. | |
| PASS_CONNECTION_MISMATCH | Link it with PUT /api/v1/passes/{id}/connection, then send the request again. | |
| PASS_FILE_MISSING | Rebuild it with POST /api/v1/passes/{id}/refresh. | |
| PASS_INPUT_INVALID | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| PASS_INVALID | Fix the problems named in issues in the template or inputs. | |
| PASS_NOT_ACTIVE | Restore or unvoid the pass first, or use an active one. | |
| PASS_NOT_FOUND | Check the id with GET /api/v1/passes and the key's mode. | |
| PASS_REF_TAKEN | Use a different ref, or update the existing pass. | |
| PASS_REISSUE_REQUIRED | Reissue it with POST /api/v1/passes/bulk-reissue. | |
| PASS_REMOVED | Restore it with POST /api/v1/passes/{id}/restore, then send the request again. | |
| PASS_TRANSFER_NOT_FOUND | Check the transfer id. | |
| PASS_TRANSFER_PENDING | Try again shortly. | |
| 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}. | |
| SCAN_EVENT_NOT_FOUND | Check the event id with GET /api/v1/scan/events. | |
| SCAN_WINDOW_INVALID | Set an end after the start, or fix the template's dates. | |
| SERIAL_TAKEN | Send a different serial, or leave it out to have one generated. | |
| SESSION_REQUIRED | Do it in the console, or sign in as the account that started it. | |
| STAMPS_ABOVE_MAX | Raise the template's stamp maximum, or redeem stamps first. | |
| STAMPS_CARD_FULL | Redeem the reward, then add stamps. | |
| STAMPS_NONE | Use a template with stamps. | |
| STAMPS_NO_REWARD | Add stamps until the card is full, then redeem. | |
| TEMPLATE_NOT_FOUND | Check the id with GET /api/v1/templates and the key's mode. | |
| TEMPLATE_RELEASE_CONFLICT | Send the request again to use the current release. | |
| TEMPLATE_RELEASE_REQUIRED | Approve a release with POST /api/v1/templates/{id}/candidates/{candidateId}/approve. | |
| TERM_MANAGED | Change the term in the connected system. | |
| TERM_NONE | Renew only passes whose template defines a term. | |
| TERM_NOT_STARTED | Renew after the term starts. | |
| UNAUTHENTICATED | Send Authorization: Bearer $PASSBOOK_KEY. | |
| VALIDATION | Fix each field in issues and resend. | |
| VERSION_NOT_FOUND | Check the version with GET /api/v1/passes/{id}. | |
| VERSION_PURGED | Request a newer version. | |
| WORKFLOW_START | Send the request again. |
Prints
/api/v1/passes/{id}/printsPath
Returns
200
Errors
| Code | Status | Fix |
|---|---|---|
| ASSET_DIMENSIONS | Resize the image to the size named in issues and upload it again. | |
| ASSET_NOT_FOUND | Check the image name or id and that it belongs to this organization. | |
| ASSET_NOT_PNG | Re-export the image as a standard RGB or RGBA PNG and upload it again. | |
| ASSET_SIZE | Compress the image below 1 MB and upload it again. | |
| ASSET_SLOT | Use a slot name from the pass type's image slots in the request path. | |
| BULK_RUN_ACTIVE | Wait for the running job to finish, then start the new one. | |
| BUNDLE_TOO_LARGE | Split the passes across smaller bundles. | |
| CONNECTION_ORG | Use a connection id from your own organization's GET /api/v1/connections. | |
| CONNECTION_TRANSFER_PENDING | Wait for the transfer to finish, then send the request again. | |
| CREATE_STALE | Look the pass up by externalId with GET /api/v1/passes and update it instead of creating it again. | |
| CREDENTIAL_REF_KEYSET_CONFIG_UNAVAILABLE | Retry with backoff; if it persists, send the requestId to support. | |
| CREDENTIAL_REF_KEYSET_UNAVAILABLE | Retry with backoff; if it persists, send the requestId to support. | |
| DELIVERY_STALE | Review the recipient and try again. | |
| DEVICE_TOKEN_UNAVAILABLE | Retry the request; if it persists, send the requestId to support. | |
| EMAIL_INVALID | Send a valid address in the email field. | |
| EXTERNAL_ID_TAKEN | Send a new externalId, or PATCH the existing pass. | |
| FORBIDDEN | Use a key with the scope the operation lists, or ask an org admin. | |
| IDEMPOTENCY_IN_PROGRESS | Wait a moment and resend the identical request. | |
| IDEMPOTENCY_KEY_INVALID | Send a unique string of 1 to 200 characters, such as a UUID. | |
| IDEMPOTENCY_KEY_REUSED | Use a new key for a new request; resend the identical request to replay. | |
| IF_MATCH_INVALID | Send the version from the last GET, for example If-Match: 3. | |
| IMPORT_BUSY | Wait for it to finish with GET /api/v1/pass-imports/{id}, then retry. | |
| IMPORT_COLUMN_MISSING | Add the column to the file, or change the mapping, then check again. | |
| IMPORT_EXPIRED | Upload the file again with POST /api/v1/pass-imports. | |
| IMPORT_FILE_GONE | Upload it again. | |
| IMPORT_HAS_ERRORS | Fix the rows listed in GET /api/v1/pass-imports/{id}/errors.csv, or skip them, then commit again. | |
| IMPORT_HEADER_TOO_LONG | Shorten the header and upload the file again. | |
| IMPORT_ID_TAKEN | Check the import again with POST /api/v1/pass-imports/{id}/check, then commit. | |
| IMPORT_NOT_FOUND | Check the id with GET /api/v1/pass-imports. | |
| IMPORT_PASS_CHANGED | Remove the pass on its own with POST /api/v1/passes/{id}/remove. | |
| IMPORT_PLAN_INVALID | Fix the mapping entries named in issues and check again. | |
| IMPORT_ROW_UNRESERVED | Retry the commit; if it persists, send the requestId to support. | |
| IMPORT_STATE | Check its state with GET /api/v1/pass-imports/{id} and call the action that state allows. | |
| INVALID_API_KEY | Create a new key in the console and update PASSBOOK_KEY. | |
| INVALID_INPUT | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| JOIN_NOT_READY | Publish the template, then enable the link with PUT /api/v1/join-links/{templateId}. | |
| MATCH_NEEDS_TEMPLATE | Send orgId and templateId with the input filter. | |
| MEMBER_PHOTO_CHANGED | Fetch the pass with GET /api/v1/passes/{id} and save the photo again. | |
| MEMBER_PHOTO_DIMENSIONS | Crop the photo to a 270 by 270 pixel square and upload it again. | |
| MEMBER_PHOTO_ENCODING | Send the photo as a PNG or JPEG file. | |
| MEMBER_PHOTO_NOT_FOUND | Add one with PUT /api/v1/passes/{id}/member-photo. | |
| MEMBER_PHOTO_STYLE | Use a template of that style, or remove the strip image. | |
| MISSING_SCOPE | Create a key with the scope the operation lists under security. | |
| MODE_MISMATCH | Use objects and a key of the same mode. | |
| NEW_CODE_UNSUPPORTED | Reissue the pass with POST /api/v1/passes/bulk-reissue instead of requesting a new code. | |
| 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_ACCESS_CHANGED | Check access with GET /api/v1/api-keys/me, then send the request again. | |
| ORG_FORBIDDEN | Use a key scoped to this organization, or a platform key for platform-wide lists. | |
| ORG_MIXED | Send ids from one organization per request. | |
| ORG_NOT_FOUND | Check orgId with GET /api/v1/orgs. | |
| ORG_REQUIRED | Send orgId with the request, or use a key scoped to one organization. | |
| PASS_CONFLICT | Fetch the pass with GET /api/v1/passes/{id} and send the request again. | |
| PASS_CONNECTION_MISMATCH | Link it with PUT /api/v1/passes/{id}/connection, then send the request again. | |
| PASS_FILE_MISSING | Rebuild it with POST /api/v1/passes/{id}/refresh. | |
| PASS_INPUT_INVALID | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| PASS_INVALID | Fix the problems named in issues in the template or inputs. | |
| PASS_NOT_ACTIVE | Restore or unvoid the pass first, or use an active one. | |
| PASS_NOT_FOUND | Check the id with GET /api/v1/passes and the key's mode. | |
| PASS_REF_TAKEN | Use a different ref, or update the existing pass. | |
| PASS_REISSUE_REQUIRED | Reissue it with POST /api/v1/passes/bulk-reissue. | |
| PASS_REMOVED | Restore it with POST /api/v1/passes/{id}/restore, then send the request again. | |
| PASS_TRANSFER_NOT_FOUND | Check the transfer id. | |
| PASS_TRANSFER_PENDING | Try again shortly. | |
| 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}. | |
| SCAN_EVENT_NOT_FOUND | Check the event id with GET /api/v1/scan/events. | |
| SCAN_WINDOW_INVALID | Set an end after the start, or fix the template's dates. | |
| SERIAL_TAKEN | Send a different serial, or leave it out to have one generated. | |
| SESSION_REQUIRED | Do it in the console, or sign in as the account that started it. | |
| STAMPS_ABOVE_MAX | Raise the template's stamp maximum, or redeem stamps first. | |
| STAMPS_CARD_FULL | Redeem the reward, then add stamps. | |
| STAMPS_NONE | Use a template with stamps. | |
| STAMPS_NO_REWARD | Add stamps until the card is full, then redeem. | |
| TEMPLATE_NOT_FOUND | Check the id with GET /api/v1/templates and the key's mode. | |
| TEMPLATE_RELEASE_CONFLICT | Send the request again to use the current release. | |
| TEMPLATE_RELEASE_REQUIRED | Approve a release with POST /api/v1/templates/{id}/candidates/{candidateId}/approve. | |
| TERM_MANAGED | Change the term in the connected system. | |
| TERM_NONE | Renew only passes whose template defines a term. | |
| TERM_NOT_STARTED | Renew after the term starts. | |
| UNAUTHENTICATED | Send Authorization: Bearer $PASSBOOK_KEY. | |
| VALIDATION | Fix each field in issues and resend. | |
| VERSION_NOT_FOUND | Check the version with GET /api/v1/passes/{id}. | |
| VERSION_PURGED | Request a newer version. | |
| WORKFLOW_START | Send the request again. |
/api/v1/passes/{id}/printsPath
Returns
200
Errors
| Code | Status | Fix |
|---|---|---|
| ASSET_DIMENSIONS | Resize the image to the size named in issues and upload it again. | |
| ASSET_NOT_FOUND | Check the image name or id and that it belongs to this organization. | |
| ASSET_NOT_PNG | Re-export the image as a standard RGB or RGBA PNG and upload it again. | |
| ASSET_SIZE | Compress the image below 1 MB and upload it again. | |
| ASSET_SLOT | Use a slot name from the pass type's image slots in the request path. | |
| BULK_RUN_ACTIVE | Wait for the running job to finish, then start the new one. | |
| BUNDLE_TOO_LARGE | Split the passes across smaller bundles. | |
| CONNECTION_ORG | Use a connection id from your own organization's GET /api/v1/connections. | |
| CONNECTION_TRANSFER_PENDING | Wait for the transfer to finish, then send the request again. | |
| CREATE_STALE | Look the pass up by externalId with GET /api/v1/passes and update it instead of creating it again. | |
| CREDENTIAL_REF_KEYSET_CONFIG_UNAVAILABLE | Retry with backoff; if it persists, send the requestId to support. | |
| CREDENTIAL_REF_KEYSET_UNAVAILABLE | Retry with backoff; if it persists, send the requestId to support. | |
| DELIVERY_STALE | Review the recipient and try again. | |
| DEVICE_TOKEN_UNAVAILABLE | Retry the request; if it persists, send the requestId to support. | |
| EMAIL_INVALID | Send a valid address in the email field. | |
| EXTERNAL_ID_TAKEN | Send a new externalId, or PATCH the existing pass. | |
| FORBIDDEN | Use a key with the scope the operation lists, or ask an org admin. | |
| IDEMPOTENCY_IN_PROGRESS | Wait a moment and resend the identical request. | |
| IDEMPOTENCY_KEY_INVALID | Send a unique string of 1 to 200 characters, such as a UUID. | |
| IDEMPOTENCY_KEY_REUSED | Use a new key for a new request; resend the identical request to replay. | |
| IF_MATCH_INVALID | Send the version from the last GET, for example If-Match: 3. | |
| IMPORT_BUSY | Wait for it to finish with GET /api/v1/pass-imports/{id}, then retry. | |
| IMPORT_COLUMN_MISSING | Add the column to the file, or change the mapping, then check again. | |
| IMPORT_EXPIRED | Upload the file again with POST /api/v1/pass-imports. | |
| IMPORT_FILE_GONE | Upload it again. | |
| IMPORT_HAS_ERRORS | Fix the rows listed in GET /api/v1/pass-imports/{id}/errors.csv, or skip them, then commit again. | |
| IMPORT_HEADER_TOO_LONG | Shorten the header and upload the file again. | |
| IMPORT_ID_TAKEN | Check the import again with POST /api/v1/pass-imports/{id}/check, then commit. | |
| IMPORT_NOT_FOUND | Check the id with GET /api/v1/pass-imports. | |
| IMPORT_PASS_CHANGED | Remove the pass on its own with POST /api/v1/passes/{id}/remove. | |
| IMPORT_PLAN_INVALID | Fix the mapping entries named in issues and check again. | |
| IMPORT_ROW_UNRESERVED | Retry the commit; if it persists, send the requestId to support. | |
| IMPORT_STATE | Check its state with GET /api/v1/pass-imports/{id} and call the action that state allows. | |
| INVALID_API_KEY | Create a new key in the console and update PASSBOOK_KEY. | |
| INVALID_INPUT | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| JOIN_NOT_READY | Publish the template, then enable the link with PUT /api/v1/join-links/{templateId}. | |
| MATCH_NEEDS_TEMPLATE | Send orgId and templateId with the input filter. | |
| MEMBER_PHOTO_CHANGED | Fetch the pass with GET /api/v1/passes/{id} and save the photo again. | |
| MEMBER_PHOTO_DIMENSIONS | Crop the photo to a 270 by 270 pixel square and upload it again. | |
| MEMBER_PHOTO_ENCODING | Send the photo as a PNG or JPEG file. | |
| MEMBER_PHOTO_NOT_FOUND | Add one with PUT /api/v1/passes/{id}/member-photo. | |
| MEMBER_PHOTO_STYLE | Use a template of that style, or remove the strip image. | |
| MISSING_SCOPE | Create a key with the scope the operation lists under security. | |
| MODE_MISMATCH | Use objects and a key of the same mode. | |
| NEW_CODE_UNSUPPORTED | Reissue the pass with POST /api/v1/passes/bulk-reissue instead of requesting a new code. | |
| 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_ACCESS_CHANGED | Check access with GET /api/v1/api-keys/me, then send the request again. | |
| ORG_FORBIDDEN | Use a key scoped to this organization, or a platform key for platform-wide lists. | |
| ORG_MIXED | Send ids from one organization per request. | |
| ORG_NOT_FOUND | Check orgId with GET /api/v1/orgs. | |
| ORG_REQUIRED | Send orgId with the request, or use a key scoped to one organization. | |
| PASS_CONFLICT | Fetch the pass with GET /api/v1/passes/{id} and send the request again. | |
| PASS_CONNECTION_MISMATCH | Link it with PUT /api/v1/passes/{id}/connection, then send the request again. | |
| PASS_FILE_MISSING | Rebuild it with POST /api/v1/passes/{id}/refresh. | |
| PASS_INPUT_INVALID | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| PASS_INVALID | Fix the problems named in issues in the template or inputs. | |
| PASS_NOT_ACTIVE | Restore or unvoid the pass first, or use an active one. | |
| PASS_NOT_FOUND | Check the id with GET /api/v1/passes and the key's mode. | |
| PASS_REF_TAKEN | Use a different ref, or update the existing pass. | |
| PASS_REISSUE_REQUIRED | Reissue it with POST /api/v1/passes/bulk-reissue. | |
| PASS_REMOVED | Restore it with POST /api/v1/passes/{id}/restore, then send the request again. | |
| PASS_TRANSFER_NOT_FOUND | Check the transfer id. | |
| PASS_TRANSFER_PENDING | Try again shortly. | |
| 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}. | |
| SCAN_EVENT_NOT_FOUND | Check the event id with GET /api/v1/scan/events. | |
| SCAN_WINDOW_INVALID | Set an end after the start, or fix the template's dates. | |
| SERIAL_TAKEN | Send a different serial, or leave it out to have one generated. | |
| SESSION_REQUIRED | Do it in the console, or sign in as the account that started it. | |
| STAMPS_ABOVE_MAX | Raise the template's stamp maximum, or redeem stamps first. | |
| STAMPS_CARD_FULL | Redeem the reward, then add stamps. | |
| STAMPS_NONE | Use a template with stamps. | |
| STAMPS_NO_REWARD | Add stamps until the card is full, then redeem. | |
| TEMPLATE_NOT_FOUND | Check the id with GET /api/v1/templates and the key's mode. | |
| TEMPLATE_RELEASE_CONFLICT | Send the request again to use the current release. | |
| TEMPLATE_RELEASE_REQUIRED | Approve a release with POST /api/v1/templates/{id}/candidates/{candidateId}/approve. | |
| TERM_MANAGED | Change the term in the connected system. | |
| TERM_NONE | Renew only passes whose template defines a term. | |
| TERM_NOT_STARTED | Renew after the term starts. | |
| UNAUTHENTICATED | Send Authorization: Bearer $PASSBOOK_KEY. | |
| VALIDATION | Fix each field in issues and resend. | |
| VERSION_NOT_FOUND | Check the version with GET /api/v1/passes/{id}. | |
| VERSION_PURGED | Request a newer version. | |
| WORKFLOW_START | Send the request again. |
/api/v1/passes/{id}/prints/{printId}/voidPath
Returns
200
Errors
| Code | Status | Fix |
|---|---|---|
| ASSET_DIMENSIONS | Resize the image to the size named in issues and upload it again. | |
| ASSET_NOT_FOUND | Check the image name or id and that it belongs to this organization. | |
| ASSET_NOT_PNG | Re-export the image as a standard RGB or RGBA PNG and upload it again. | |
| ASSET_SIZE | Compress the image below 1 MB and upload it again. | |
| ASSET_SLOT | Use a slot name from the pass type's image slots in the request path. | |
| BULK_RUN_ACTIVE | Wait for the running job to finish, then start the new one. | |
| BUNDLE_TOO_LARGE | Split the passes across smaller bundles. | |
| CONNECTION_ORG | Use a connection id from your own organization's GET /api/v1/connections. | |
| CONNECTION_TRANSFER_PENDING | Wait for the transfer to finish, then send the request again. | |
| CREATE_STALE | Look the pass up by externalId with GET /api/v1/passes and update it instead of creating it again. | |
| CREDENTIAL_REF_KEYSET_CONFIG_UNAVAILABLE | Retry with backoff; if it persists, send the requestId to support. | |
| CREDENTIAL_REF_KEYSET_UNAVAILABLE | Retry with backoff; if it persists, send the requestId to support. | |
| DELIVERY_STALE | Review the recipient and try again. | |
| DEVICE_TOKEN_UNAVAILABLE | Retry the request; if it persists, send the requestId to support. | |
| EMAIL_INVALID | Send a valid address in the email field. | |
| EXTERNAL_ID_TAKEN | Send a new externalId, or PATCH the existing pass. | |
| FORBIDDEN | Use a key with the scope the operation lists, or ask an org admin. | |
| IDEMPOTENCY_IN_PROGRESS | Wait a moment and resend the identical request. | |
| IDEMPOTENCY_KEY_INVALID | Send a unique string of 1 to 200 characters, such as a UUID. | |
| IDEMPOTENCY_KEY_REUSED | Use a new key for a new request; resend the identical request to replay. | |
| IF_MATCH_INVALID | Send the version from the last GET, for example If-Match: 3. | |
| IMPORT_BUSY | Wait for it to finish with GET /api/v1/pass-imports/{id}, then retry. | |
| IMPORT_COLUMN_MISSING | Add the column to the file, or change the mapping, then check again. | |
| IMPORT_EXPIRED | Upload the file again with POST /api/v1/pass-imports. | |
| IMPORT_FILE_GONE | Upload it again. | |
| IMPORT_HAS_ERRORS | Fix the rows listed in GET /api/v1/pass-imports/{id}/errors.csv, or skip them, then commit again. | |
| IMPORT_HEADER_TOO_LONG | Shorten the header and upload the file again. | |
| IMPORT_ID_TAKEN | Check the import again with POST /api/v1/pass-imports/{id}/check, then commit. | |
| IMPORT_NOT_FOUND | Check the id with GET /api/v1/pass-imports. | |
| IMPORT_PASS_CHANGED | Remove the pass on its own with POST /api/v1/passes/{id}/remove. | |
| IMPORT_PLAN_INVALID | Fix the mapping entries named in issues and check again. | |
| IMPORT_ROW_UNRESERVED | Retry the commit; if it persists, send the requestId to support. | |
| IMPORT_STATE | Check its state with GET /api/v1/pass-imports/{id} and call the action that state allows. | |
| INVALID_API_KEY | Create a new key in the console and update PASSBOOK_KEY. | |
| INVALID_INPUT | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| JOIN_NOT_READY | Publish the template, then enable the link with PUT /api/v1/join-links/{templateId}. | |
| MATCH_NEEDS_TEMPLATE | Send orgId and templateId with the input filter. | |
| MEMBER_PHOTO_CHANGED | Fetch the pass with GET /api/v1/passes/{id} and save the photo again. | |
| MEMBER_PHOTO_DIMENSIONS | Crop the photo to a 270 by 270 pixel square and upload it again. | |
| MEMBER_PHOTO_ENCODING | Send the photo as a PNG or JPEG file. | |
| MEMBER_PHOTO_NOT_FOUND | Add one with PUT /api/v1/passes/{id}/member-photo. | |
| MEMBER_PHOTO_STYLE | Use a template of that style, or remove the strip image. | |
| MISSING_SCOPE | Create a key with the scope the operation lists under security. | |
| MODE_MISMATCH | Use objects and a key of the same mode. | |
| NEW_CODE_UNSUPPORTED | Reissue the pass with POST /api/v1/passes/bulk-reissue instead of requesting a new code. | |
| 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_ACCESS_CHANGED | Check access with GET /api/v1/api-keys/me, then send the request again. | |
| ORG_FORBIDDEN | Use a key scoped to this organization, or a platform key for platform-wide lists. | |
| ORG_MIXED | Send ids from one organization per request. | |
| ORG_NOT_FOUND | Check orgId with GET /api/v1/orgs. | |
| ORG_REQUIRED | Send orgId with the request, or use a key scoped to one organization. | |
| PASS_CONFLICT | Fetch the pass with GET /api/v1/passes/{id} and send the request again. | |
| PASS_CONNECTION_MISMATCH | Link it with PUT /api/v1/passes/{id}/connection, then send the request again. | |
| PASS_FILE_MISSING | Rebuild it with POST /api/v1/passes/{id}/refresh. | |
| PASS_INPUT_INVALID | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| PASS_INVALID | Fix the problems named in issues in the template or inputs. | |
| PASS_NOT_ACTIVE | Restore or unvoid the pass first, or use an active one. | |
| PASS_NOT_FOUND | Check the id with GET /api/v1/passes and the key's mode. | |
| PASS_REF_TAKEN | Use a different ref, or update the existing pass. | |
| PASS_REISSUE_REQUIRED | Reissue it with POST /api/v1/passes/bulk-reissue. | |
| PASS_REMOVED | Restore it with POST /api/v1/passes/{id}/restore, then send the request again. | |
| PASS_TRANSFER_NOT_FOUND | Check the transfer id. | |
| PASS_TRANSFER_PENDING | Try again shortly. | |
| 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}. | |
| SCAN_EVENT_NOT_FOUND | Check the event id with GET /api/v1/scan/events. | |
| SCAN_WINDOW_INVALID | Set an end after the start, or fix the template's dates. | |
| SERIAL_TAKEN | Send a different serial, or leave it out to have one generated. | |
| SESSION_REQUIRED | Do it in the console, or sign in as the account that started it. | |
| STAMPS_ABOVE_MAX | Raise the template's stamp maximum, or redeem stamps first. | |
| STAMPS_CARD_FULL | Redeem the reward, then add stamps. | |
| STAMPS_NONE | Use a template with stamps. | |
| STAMPS_NO_REWARD | Add stamps until the card is full, then redeem. | |
| TEMPLATE_NOT_FOUND | Check the id with GET /api/v1/templates and the key's mode. | |
| TEMPLATE_RELEASE_CONFLICT | Send the request again to use the current release. | |
| TEMPLATE_RELEASE_REQUIRED | Approve a release with POST /api/v1/templates/{id}/candidates/{candidateId}/approve. | |
| TERM_MANAGED | Change the term in the connected system. | |
| TERM_NONE | Renew only passes whose template defines a term. | |
| TERM_NOT_STARTED | Renew after the term starts. | |
| UNAUTHENTICATED | Send Authorization: Bearer $PASSBOOK_KEY. | |
| VALIDATION | Fix each field in issues and resend. | |
| VERSION_NOT_FOUND | Check the version with GET /api/v1/passes/{id}. | |
| VERSION_PURGED | Request a newer version. | |
| WORKFLOW_START | Send the request again. |
/api/v1/passes/{id}/printPath
Returns
200
Errors
| Code | Status | Fix |
|---|---|---|
| ASSET_DIMENSIONS | Resize the image to the size named in issues and upload it again. | |
| ASSET_NOT_FOUND | Check the image name or id and that it belongs to this organization. | |
| ASSET_NOT_PNG | Re-export the image as a standard RGB or RGBA PNG and upload it again. | |
| ASSET_SIZE | Compress the image below 1 MB and upload it again. | |
| ASSET_SLOT | Use a slot name from the pass type's image slots in the request path. | |
| BULK_RUN_ACTIVE | Wait for the running job to finish, then start the new one. | |
| BUNDLE_TOO_LARGE | Split the passes across smaller bundles. | |
| CONNECTION_ORG | Use a connection id from your own organization's GET /api/v1/connections. | |
| CONNECTION_TRANSFER_PENDING | Wait for the transfer to finish, then send the request again. | |
| CREATE_STALE | Look the pass up by externalId with GET /api/v1/passes and update it instead of creating it again. | |
| CREDENTIAL_REF_KEYSET_CONFIG_UNAVAILABLE | Retry with backoff; if it persists, send the requestId to support. | |
| CREDENTIAL_REF_KEYSET_UNAVAILABLE | Retry with backoff; if it persists, send the requestId to support. | |
| DELIVERY_STALE | Review the recipient and try again. | |
| DEVICE_TOKEN_UNAVAILABLE | Retry the request; if it persists, send the requestId to support. | |
| EMAIL_INVALID | Send a valid address in the email field. | |
| EXTERNAL_ID_TAKEN | Send a new externalId, or PATCH the existing pass. | |
| FORBIDDEN | Use a key with the scope the operation lists, or ask an org admin. | |
| IDEMPOTENCY_IN_PROGRESS | Wait a moment and resend the identical request. | |
| IDEMPOTENCY_KEY_INVALID | Send a unique string of 1 to 200 characters, such as a UUID. | |
| IDEMPOTENCY_KEY_REUSED | Use a new key for a new request; resend the identical request to replay. | |
| IF_MATCH_INVALID | Send the version from the last GET, for example If-Match: 3. | |
| IMPORT_BUSY | Wait for it to finish with GET /api/v1/pass-imports/{id}, then retry. | |
| IMPORT_COLUMN_MISSING | Add the column to the file, or change the mapping, then check again. | |
| IMPORT_EXPIRED | Upload the file again with POST /api/v1/pass-imports. | |
| IMPORT_FILE_GONE | Upload it again. | |
| IMPORT_HAS_ERRORS | Fix the rows listed in GET /api/v1/pass-imports/{id}/errors.csv, or skip them, then commit again. | |
| IMPORT_HEADER_TOO_LONG | Shorten the header and upload the file again. | |
| IMPORT_ID_TAKEN | Check the import again with POST /api/v1/pass-imports/{id}/check, then commit. | |
| IMPORT_NOT_FOUND | Check the id with GET /api/v1/pass-imports. | |
| IMPORT_PASS_CHANGED | Remove the pass on its own with POST /api/v1/passes/{id}/remove. | |
| IMPORT_PLAN_INVALID | Fix the mapping entries named in issues and check again. | |
| IMPORT_ROW_UNRESERVED | Retry the commit; if it persists, send the requestId to support. | |
| IMPORT_STATE | Check its state with GET /api/v1/pass-imports/{id} and call the action that state allows. | |
| INVALID_API_KEY | Create a new key in the console and update PASSBOOK_KEY. | |
| INVALID_INPUT | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| JOIN_NOT_READY | Publish the template, then enable the link with PUT /api/v1/join-links/{templateId}. | |
| MATCH_NEEDS_TEMPLATE | Send orgId and templateId with the input filter. | |
| MEMBER_PHOTO_CHANGED | Fetch the pass with GET /api/v1/passes/{id} and save the photo again. | |
| MEMBER_PHOTO_DIMENSIONS | Crop the photo to a 270 by 270 pixel square and upload it again. | |
| MEMBER_PHOTO_ENCODING | Send the photo as a PNG or JPEG file. | |
| MEMBER_PHOTO_NOT_FOUND | Add one with PUT /api/v1/passes/{id}/member-photo. | |
| MEMBER_PHOTO_STYLE | Use a template of that style, or remove the strip image. | |
| MISSING_SCOPE | Create a key with the scope the operation lists under security. | |
| MODE_MISMATCH | Use objects and a key of the same mode. | |
| NEW_CODE_UNSUPPORTED | Reissue the pass with POST /api/v1/passes/bulk-reissue instead of requesting a new code. | |
| 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_ACCESS_CHANGED | Check access with GET /api/v1/api-keys/me, then send the request again. | |
| ORG_FORBIDDEN | Use a key scoped to this organization, or a platform key for platform-wide lists. | |
| ORG_MIXED | Send ids from one organization per request. | |
| ORG_NOT_FOUND | Check orgId with GET /api/v1/orgs. | |
| ORG_REQUIRED | Send orgId with the request, or use a key scoped to one organization. | |
| PASS_CONFLICT | Fetch the pass with GET /api/v1/passes/{id} and send the request again. | |
| PASS_CONNECTION_MISMATCH | Link it with PUT /api/v1/passes/{id}/connection, then send the request again. | |
| PASS_FILE_MISSING | Rebuild it with POST /api/v1/passes/{id}/refresh. | |
| PASS_INPUT_INVALID | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| PASS_INVALID | Fix the problems named in issues in the template or inputs. | |
| PASS_NOT_ACTIVE | Restore or unvoid the pass first, or use an active one. | |
| PASS_NOT_FOUND | Check the id with GET /api/v1/passes and the key's mode. | |
| PASS_REF_TAKEN | Use a different ref, or update the existing pass. | |
| PASS_REISSUE_REQUIRED | Reissue it with POST /api/v1/passes/bulk-reissue. | |
| PASS_REMOVED | Restore it with POST /api/v1/passes/{id}/restore, then send the request again. | |
| PASS_TRANSFER_NOT_FOUND | Check the transfer id. | |
| PASS_TRANSFER_PENDING | Try again shortly. | |
| 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}. | |
| SCAN_EVENT_NOT_FOUND | Check the event id with GET /api/v1/scan/events. | |
| SCAN_WINDOW_INVALID | Set an end after the start, or fix the template's dates. | |
| SERIAL_TAKEN | Send a different serial, or leave it out to have one generated. | |
| SESSION_REQUIRED | Do it in the console, or sign in as the account that started it. | |
| STAMPS_ABOVE_MAX | Raise the template's stamp maximum, or redeem stamps first. | |
| STAMPS_CARD_FULL | Redeem the reward, then add stamps. | |
| STAMPS_NONE | Use a template with stamps. | |
| STAMPS_NO_REWARD | Add stamps until the card is full, then redeem. | |
| TEMPLATE_NOT_FOUND | Check the id with GET /api/v1/templates and the key's mode. | |
| TEMPLATE_RELEASE_CONFLICT | Send the request again to use the current release. | |
| TEMPLATE_RELEASE_REQUIRED | Approve a release with POST /api/v1/templates/{id}/candidates/{candidateId}/approve. | |
| TERM_MANAGED | Change the term in the connected system. | |
| TERM_NONE | Renew only passes whose template defines a term. | |
| TERM_NOT_STARTED | Renew after the term starts. | |
| UNAUTHENTICATED | Send Authorization: Bearer $PASSBOOK_KEY. | |
| VALIDATION | Fix each field in issues and resend. | |
| VERSION_NOT_FOUND | Check the version with GET /api/v1/passes/{id}. | |
| VERSION_PURGED | Request a newer version. | |
| WORKFLOW_START | Send the request again. |
/api/v1/passes/{id}/print/pdfPath
Returns
200
Errors
| Code | Status | Fix |
|---|---|---|
| ASSET_DIMENSIONS | Resize the image to the size named in issues and upload it again. | |
| ASSET_NOT_FOUND | Check the image name or id and that it belongs to this organization. | |
| ASSET_NOT_PNG | Re-export the image as a standard RGB or RGBA PNG and upload it again. | |
| ASSET_SIZE | Compress the image below 1 MB and upload it again. | |
| ASSET_SLOT | Use a slot name from the pass type's image slots in the request path. | |
| BULK_RUN_ACTIVE | Wait for the running job to finish, then start the new one. | |
| BUNDLE_TOO_LARGE | Split the passes across smaller bundles. | |
| CONNECTION_ORG | Use a connection id from your own organization's GET /api/v1/connections. | |
| CONNECTION_TRANSFER_PENDING | Wait for the transfer to finish, then send the request again. | |
| CREATE_STALE | Look the pass up by externalId with GET /api/v1/passes and update it instead of creating it again. | |
| CREDENTIAL_REF_KEYSET_CONFIG_UNAVAILABLE | Retry with backoff; if it persists, send the requestId to support. | |
| CREDENTIAL_REF_KEYSET_UNAVAILABLE | Retry with backoff; if it persists, send the requestId to support. | |
| DELIVERY_STALE | Review the recipient and try again. | |
| DEVICE_TOKEN_UNAVAILABLE | Retry the request; if it persists, send the requestId to support. | |
| EMAIL_INVALID | Send a valid address in the email field. | |
| EXTERNAL_ID_TAKEN | Send a new externalId, or PATCH the existing pass. | |
| FORBIDDEN | Use a key with the scope the operation lists, or ask an org admin. | |
| IDEMPOTENCY_IN_PROGRESS | Wait a moment and resend the identical request. | |
| IDEMPOTENCY_KEY_INVALID | Send a unique string of 1 to 200 characters, such as a UUID. | |
| IDEMPOTENCY_KEY_REUSED | Use a new key for a new request; resend the identical request to replay. | |
| IF_MATCH_INVALID | Send the version from the last GET, for example If-Match: 3. | |
| IMPORT_BUSY | Wait for it to finish with GET /api/v1/pass-imports/{id}, then retry. | |
| IMPORT_COLUMN_MISSING | Add the column to the file, or change the mapping, then check again. | |
| IMPORT_EXPIRED | Upload the file again with POST /api/v1/pass-imports. | |
| IMPORT_FILE_GONE | Upload it again. | |
| IMPORT_HAS_ERRORS | Fix the rows listed in GET /api/v1/pass-imports/{id}/errors.csv, or skip them, then commit again. | |
| IMPORT_HEADER_TOO_LONG | Shorten the header and upload the file again. | |
| IMPORT_ID_TAKEN | Check the import again with POST /api/v1/pass-imports/{id}/check, then commit. | |
| IMPORT_NOT_FOUND | Check the id with GET /api/v1/pass-imports. | |
| IMPORT_PASS_CHANGED | Remove the pass on its own with POST /api/v1/passes/{id}/remove. | |
| IMPORT_PLAN_INVALID | Fix the mapping entries named in issues and check again. | |
| IMPORT_ROW_UNRESERVED | Retry the commit; if it persists, send the requestId to support. | |
| IMPORT_STATE | Check its state with GET /api/v1/pass-imports/{id} and call the action that state allows. | |
| INVALID_API_KEY | Create a new key in the console and update PASSBOOK_KEY. | |
| INVALID_INPUT | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| JOIN_NOT_READY | Publish the template, then enable the link with PUT /api/v1/join-links/{templateId}. | |
| MATCH_NEEDS_TEMPLATE | Send orgId and templateId with the input filter. | |
| MEMBER_PHOTO_CHANGED | Fetch the pass with GET /api/v1/passes/{id} and save the photo again. | |
| MEMBER_PHOTO_DIMENSIONS | Crop the photo to a 270 by 270 pixel square and upload it again. | |
| MEMBER_PHOTO_ENCODING | Send the photo as a PNG or JPEG file. | |
| MEMBER_PHOTO_NOT_FOUND | Add one with PUT /api/v1/passes/{id}/member-photo. | |
| MEMBER_PHOTO_STYLE | Use a template of that style, or remove the strip image. | |
| MISSING_SCOPE | Create a key with the scope the operation lists under security. | |
| MODE_MISMATCH | Use objects and a key of the same mode. | |
| NEW_CODE_UNSUPPORTED | Reissue the pass with POST /api/v1/passes/bulk-reissue instead of requesting a new code. | |
| 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_ACCESS_CHANGED | Check access with GET /api/v1/api-keys/me, then send the request again. | |
| ORG_FORBIDDEN | Use a key scoped to this organization, or a platform key for platform-wide lists. | |
| ORG_MIXED | Send ids from one organization per request. | |
| ORG_NOT_FOUND | Check orgId with GET /api/v1/orgs. | |
| ORG_REQUIRED | Send orgId with the request, or use a key scoped to one organization. | |
| PASS_CONFLICT | Fetch the pass with GET /api/v1/passes/{id} and send the request again. | |
| PASS_CONNECTION_MISMATCH | Link it with PUT /api/v1/passes/{id}/connection, then send the request again. | |
| PASS_FILE_MISSING | Rebuild it with POST /api/v1/passes/{id}/refresh. | |
| PASS_INPUT_INVALID | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| PASS_INVALID | Fix the problems named in issues in the template or inputs. | |
| PASS_NOT_ACTIVE | Restore or unvoid the pass first, or use an active one. | |
| PASS_NOT_FOUND | Check the id with GET /api/v1/passes and the key's mode. | |
| PASS_REF_TAKEN | Use a different ref, or update the existing pass. | |
| PASS_REISSUE_REQUIRED | Reissue it with POST /api/v1/passes/bulk-reissue. | |
| PASS_REMOVED | Restore it with POST /api/v1/passes/{id}/restore, then send the request again. | |
| PASS_TRANSFER_NOT_FOUND | Check the transfer id. | |
| PASS_TRANSFER_PENDING | Try again shortly. | |
| 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}. | |
| SCAN_EVENT_NOT_FOUND | Check the event id with GET /api/v1/scan/events. | |
| SCAN_WINDOW_INVALID | Set an end after the start, or fix the template's dates. | |
| SERIAL_TAKEN | Send a different serial, or leave it out to have one generated. | |
| SESSION_REQUIRED | Do it in the console, or sign in as the account that started it. | |
| STAMPS_ABOVE_MAX | Raise the template's stamp maximum, or redeem stamps first. | |
| STAMPS_CARD_FULL | Redeem the reward, then add stamps. | |
| STAMPS_NONE | Use a template with stamps. | |
| STAMPS_NO_REWARD | Add stamps until the card is full, then redeem. | |
| TEMPLATE_NOT_FOUND | Check the id with GET /api/v1/templates and the key's mode. | |
| TEMPLATE_RELEASE_CONFLICT | Send the request again to use the current release. | |
| TEMPLATE_RELEASE_REQUIRED | Approve a release with POST /api/v1/templates/{id}/candidates/{candidateId}/approve. | |
| TERM_MANAGED | Change the term in the connected system. | |
| TERM_NONE | Renew only passes whose template defines a term. | |
| TERM_NOT_STARTED | Renew after the term starts. | |
| UNAUTHENTICATED | Send Authorization: Bearer $PASSBOOK_KEY. | |
| VALIDATION | Fix each field in issues and resend. | |
| VERSION_NOT_FOUND | Check the version with GET /api/v1/passes/{id}. | |
| VERSION_PURGED | Request a newer version. | |
| WORKFLOW_START | Send the request again. |
/api/v1/passes/{id}/print/assets/{name}Path
Returns
200
Errors
| Code | Status | Fix |
|---|---|---|
| ASSET_DIMENSIONS | Resize the image to the size named in issues and upload it again. | |
| ASSET_NOT_FOUND | Check the image name or id and that it belongs to this organization. | |
| ASSET_NOT_PNG | Re-export the image as a standard RGB or RGBA PNG and upload it again. | |
| ASSET_SIZE | Compress the image below 1 MB and upload it again. | |
| ASSET_SLOT | Use a slot name from the pass type's image slots in the request path. | |
| BULK_RUN_ACTIVE | Wait for the running job to finish, then start the new one. | |
| BUNDLE_TOO_LARGE | Split the passes across smaller bundles. | |
| CONNECTION_ORG | Use a connection id from your own organization's GET /api/v1/connections. | |
| CONNECTION_TRANSFER_PENDING | Wait for the transfer to finish, then send the request again. | |
| CREATE_STALE | Look the pass up by externalId with GET /api/v1/passes and update it instead of creating it again. | |
| CREDENTIAL_REF_KEYSET_CONFIG_UNAVAILABLE | Retry with backoff; if it persists, send the requestId to support. | |
| CREDENTIAL_REF_KEYSET_UNAVAILABLE | Retry with backoff; if it persists, send the requestId to support. | |
| DELIVERY_STALE | Review the recipient and try again. | |
| DEVICE_TOKEN_UNAVAILABLE | Retry the request; if it persists, send the requestId to support. | |
| EMAIL_INVALID | Send a valid address in the email field. | |
| EXTERNAL_ID_TAKEN | Send a new externalId, or PATCH the existing pass. | |
| FORBIDDEN | Use a key with the scope the operation lists, or ask an org admin. | |
| IDEMPOTENCY_IN_PROGRESS | Wait a moment and resend the identical request. | |
| IDEMPOTENCY_KEY_INVALID | Send a unique string of 1 to 200 characters, such as a UUID. | |
| IDEMPOTENCY_KEY_REUSED | Use a new key for a new request; resend the identical request to replay. | |
| IF_MATCH_INVALID | Send the version from the last GET, for example If-Match: 3. | |
| IMPORT_BUSY | Wait for it to finish with GET /api/v1/pass-imports/{id}, then retry. | |
| IMPORT_COLUMN_MISSING | Add the column to the file, or change the mapping, then check again. | |
| IMPORT_EXPIRED | Upload the file again with POST /api/v1/pass-imports. | |
| IMPORT_FILE_GONE | Upload it again. | |
| IMPORT_HAS_ERRORS | Fix the rows listed in GET /api/v1/pass-imports/{id}/errors.csv, or skip them, then commit again. | |
| IMPORT_HEADER_TOO_LONG | Shorten the header and upload the file again. | |
| IMPORT_ID_TAKEN | Check the import again with POST /api/v1/pass-imports/{id}/check, then commit. | |
| IMPORT_NOT_FOUND | Check the id with GET /api/v1/pass-imports. | |
| IMPORT_PASS_CHANGED | Remove the pass on its own with POST /api/v1/passes/{id}/remove. | |
| IMPORT_PLAN_INVALID | Fix the mapping entries named in issues and check again. | |
| IMPORT_ROW_UNRESERVED | Retry the commit; if it persists, send the requestId to support. | |
| IMPORT_STATE | Check its state with GET /api/v1/pass-imports/{id} and call the action that state allows. | |
| INVALID_API_KEY | Create a new key in the console and update PASSBOOK_KEY. | |
| INVALID_INPUT | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| JOIN_NOT_READY | Publish the template, then enable the link with PUT /api/v1/join-links/{templateId}. | |
| MATCH_NEEDS_TEMPLATE | Send orgId and templateId with the input filter. | |
| MEMBER_PHOTO_CHANGED | Fetch the pass with GET /api/v1/passes/{id} and save the photo again. | |
| MEMBER_PHOTO_DIMENSIONS | Crop the photo to a 270 by 270 pixel square and upload it again. | |
| MEMBER_PHOTO_ENCODING | Send the photo as a PNG or JPEG file. | |
| MEMBER_PHOTO_NOT_FOUND | Add one with PUT /api/v1/passes/{id}/member-photo. | |
| MEMBER_PHOTO_STYLE | Use a template of that style, or remove the strip image. | |
| MISSING_SCOPE | Create a key with the scope the operation lists under security. | |
| MODE_MISMATCH | Use objects and a key of the same mode. | |
| NEW_CODE_UNSUPPORTED | Reissue the pass with POST /api/v1/passes/bulk-reissue instead of requesting a new code. | |
| 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_ACCESS_CHANGED | Check access with GET /api/v1/api-keys/me, then send the request again. | |
| ORG_FORBIDDEN | Use a key scoped to this organization, or a platform key for platform-wide lists. | |
| ORG_MIXED | Send ids from one organization per request. | |
| ORG_NOT_FOUND | Check orgId with GET /api/v1/orgs. | |
| ORG_REQUIRED | Send orgId with the request, or use a key scoped to one organization. | |
| PASS_CONFLICT | Fetch the pass with GET /api/v1/passes/{id} and send the request again. | |
| PASS_CONNECTION_MISMATCH | Link it with PUT /api/v1/passes/{id}/connection, then send the request again. | |
| PASS_FILE_MISSING | Rebuild it with POST /api/v1/passes/{id}/refresh. | |
| PASS_INPUT_INVALID | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| PASS_INVALID | Fix the problems named in issues in the template or inputs. | |
| PASS_NOT_ACTIVE | Restore or unvoid the pass first, or use an active one. | |
| PASS_NOT_FOUND | Check the id with GET /api/v1/passes and the key's mode. | |
| PASS_REF_TAKEN | Use a different ref, or update the existing pass. | |
| PASS_REISSUE_REQUIRED | Reissue it with POST /api/v1/passes/bulk-reissue. | |
| PASS_REMOVED | Restore it with POST /api/v1/passes/{id}/restore, then send the request again. | |
| PASS_TRANSFER_NOT_FOUND | Check the transfer id. | |
| PASS_TRANSFER_PENDING | Try again shortly. | |
| 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}. | |
| SCAN_EVENT_NOT_FOUND | Check the event id with GET /api/v1/scan/events. | |
| SCAN_WINDOW_INVALID | Set an end after the start, or fix the template's dates. | |
| SERIAL_TAKEN | Send a different serial, or leave it out to have one generated. | |
| SESSION_REQUIRED | Do it in the console, or sign in as the account that started it. | |
| STAMPS_ABOVE_MAX | Raise the template's stamp maximum, or redeem stamps first. | |
| STAMPS_CARD_FULL | Redeem the reward, then add stamps. | |
| STAMPS_NONE | Use a template with stamps. | |
| STAMPS_NO_REWARD | Add stamps until the card is full, then redeem. | |
| TEMPLATE_NOT_FOUND | Check the id with GET /api/v1/templates and the key's mode. | |
| TEMPLATE_RELEASE_CONFLICT | Send the request again to use the current release. | |
| TEMPLATE_RELEASE_REQUIRED | Approve a release with POST /api/v1/templates/{id}/candidates/{candidateId}/approve. | |
| TERM_MANAGED | Change the term in the connected system. | |
| TERM_NONE | Renew only passes whose template defines a term. | |
| TERM_NOT_STARTED | Renew after the term starts. | |
| UNAUTHENTICATED | Send Authorization: Bearer $PASSBOOK_KEY. | |
| VALIDATION | Fix each field in issues and resend. | |
| VERSION_NOT_FOUND | Check the version with GET /api/v1/passes/{id}. | |
| VERSION_PURGED | Request a newer version. | |
| WORKFLOW_START | Send the request again. |
Stamps
/api/v1/passes/{id}/stampsPath
Returns
200 PassDetail
Errors
| Code | Status | Fix |
|---|---|---|
| ASSET_DIMENSIONS | Resize the image to the size named in issues and upload it again. | |
| ASSET_NOT_FOUND | Check the image name or id and that it belongs to this organization. | |
| ASSET_NOT_PNG | Re-export the image as a standard RGB or RGBA PNG and upload it again. | |
| ASSET_SIZE | Compress the image below 1 MB and upload it again. | |
| ASSET_SLOT | Use a slot name from the pass type's image slots in the request path. | |
| BULK_RUN_ACTIVE | Wait for the running job to finish, then start the new one. | |
| BUNDLE_TOO_LARGE | Split the passes across smaller bundles. | |
| CONNECTION_ORG | Use a connection id from your own organization's GET /api/v1/connections. | |
| CONNECTION_TRANSFER_PENDING | Wait for the transfer to finish, then send the request again. | |
| CREATE_STALE | Look the pass up by externalId with GET /api/v1/passes and update it instead of creating it again. | |
| CREDENTIAL_REF_KEYSET_CONFIG_UNAVAILABLE | Retry with backoff; if it persists, send the requestId to support. | |
| CREDENTIAL_REF_KEYSET_UNAVAILABLE | Retry with backoff; if it persists, send the requestId to support. | |
| DELIVERY_STALE | Review the recipient and try again. | |
| DEVICE_TOKEN_UNAVAILABLE | Retry the request; if it persists, send the requestId to support. | |
| EMAIL_INVALID | Send a valid address in the email field. | |
| EXTERNAL_ID_TAKEN | Send a new externalId, or PATCH the existing pass. | |
| FORBIDDEN | Use a key with the scope the operation lists, or ask an org admin. | |
| IDEMPOTENCY_IN_PROGRESS | Wait a moment and resend the identical request. | |
| IDEMPOTENCY_KEY_INVALID | Send a unique string of 1 to 200 characters, such as a UUID. | |
| IDEMPOTENCY_KEY_REUSED | Use a new key for a new request; resend the identical request to replay. | |
| IF_MATCH_INVALID | Send the version from the last GET, for example If-Match: 3. | |
| IMPORT_BUSY | Wait for it to finish with GET /api/v1/pass-imports/{id}, then retry. | |
| IMPORT_COLUMN_MISSING | Add the column to the file, or change the mapping, then check again. | |
| IMPORT_EXPIRED | Upload the file again with POST /api/v1/pass-imports. | |
| IMPORT_FILE_GONE | Upload it again. | |
| IMPORT_HAS_ERRORS | Fix the rows listed in GET /api/v1/pass-imports/{id}/errors.csv, or skip them, then commit again. | |
| IMPORT_HEADER_TOO_LONG | Shorten the header and upload the file again. | |
| IMPORT_ID_TAKEN | Check the import again with POST /api/v1/pass-imports/{id}/check, then commit. | |
| IMPORT_NOT_FOUND | Check the id with GET /api/v1/pass-imports. | |
| IMPORT_PASS_CHANGED | Remove the pass on its own with POST /api/v1/passes/{id}/remove. | |
| IMPORT_PLAN_INVALID | Fix the mapping entries named in issues and check again. | |
| IMPORT_ROW_UNRESERVED | Retry the commit; if it persists, send the requestId to support. | |
| IMPORT_STATE | Check its state with GET /api/v1/pass-imports/{id} and call the action that state allows. | |
| INVALID_API_KEY | Create a new key in the console and update PASSBOOK_KEY. | |
| INVALID_INPUT | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| JOIN_NOT_READY | Publish the template, then enable the link with PUT /api/v1/join-links/{templateId}. | |
| MATCH_NEEDS_TEMPLATE | Send orgId and templateId with the input filter. | |
| MEMBER_PHOTO_CHANGED | Fetch the pass with GET /api/v1/passes/{id} and save the photo again. | |
| MEMBER_PHOTO_DIMENSIONS | Crop the photo to a 270 by 270 pixel square and upload it again. | |
| MEMBER_PHOTO_ENCODING | Send the photo as a PNG or JPEG file. | |
| MEMBER_PHOTO_NOT_FOUND | Add one with PUT /api/v1/passes/{id}/member-photo. | |
| MEMBER_PHOTO_STYLE | Use a template of that style, or remove the strip image. | |
| MISSING_SCOPE | Create a key with the scope the operation lists under security. | |
| MODE_MISMATCH | Use objects and a key of the same mode. | |
| NEW_CODE_UNSUPPORTED | Reissue the pass with POST /api/v1/passes/bulk-reissue instead of requesting a new code. | |
| 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_ACCESS_CHANGED | Check access with GET /api/v1/api-keys/me, then send the request again. | |
| ORG_FORBIDDEN | Use a key scoped to this organization, or a platform key for platform-wide lists. | |
| ORG_MIXED | Send ids from one organization per request. | |
| ORG_NOT_FOUND | Check orgId with GET /api/v1/orgs. | |
| ORG_REQUIRED | Send orgId with the request, or use a key scoped to one organization. | |
| PASS_CONFLICT | Fetch the pass with GET /api/v1/passes/{id} and send the request again. | |
| PASS_CONNECTION_MISMATCH | Link it with PUT /api/v1/passes/{id}/connection, then send the request again. | |
| PASS_FILE_MISSING | Rebuild it with POST /api/v1/passes/{id}/refresh. | |
| PASS_INPUT_INVALID | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| PASS_INVALID | Fix the problems named in issues in the template or inputs. | |
| PASS_NOT_ACTIVE | Restore or unvoid the pass first, or use an active one. | |
| PASS_NOT_FOUND | Check the id with GET /api/v1/passes and the key's mode. | |
| PASS_REF_TAKEN | Use a different ref, or update the existing pass. | |
| PASS_REISSUE_REQUIRED | Reissue it with POST /api/v1/passes/bulk-reissue. | |
| PASS_REMOVED | Restore it with POST /api/v1/passes/{id}/restore, then send the request again. | |
| PASS_TRANSFER_NOT_FOUND | Check the transfer id. | |
| PASS_TRANSFER_PENDING | Try again shortly. | |
| 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}. | |
| SCAN_EVENT_NOT_FOUND | Check the event id with GET /api/v1/scan/events. | |
| SCAN_WINDOW_INVALID | Set an end after the start, or fix the template's dates. | |
| SERIAL_TAKEN | Send a different serial, or leave it out to have one generated. | |
| SESSION_REQUIRED | Do it in the console, or sign in as the account that started it. | |
| STAMPS_ABOVE_MAX | Raise the template's stamp maximum, or redeem stamps first. | |
| STAMPS_CARD_FULL | Redeem the reward, then add stamps. | |
| STAMPS_NONE | Use a template with stamps. | |
| STAMPS_NO_REWARD | Add stamps until the card is full, then redeem. | |
| TEMPLATE_NOT_FOUND | Check the id with GET /api/v1/templates and the key's mode. | |
| TEMPLATE_RELEASE_CONFLICT | Send the request again to use the current release. | |
| TEMPLATE_RELEASE_REQUIRED | Approve a release with POST /api/v1/templates/{id}/candidates/{candidateId}/approve. | |
| TERM_MANAGED | Change the term in the connected system. | |
| TERM_NONE | Renew only passes whose template defines a term. | |
| TERM_NOT_STARTED | Renew after the term starts. | |
| UNAUTHENTICATED | Send Authorization: Bearer $PASSBOOK_KEY. | |
| VALIDATION | Fix each field in issues and resend. | |
| VERSION_NOT_FOUND | Check the version with GET /api/v1/passes/{id}. | |
| VERSION_PURGED | Request a newer version. | |
| WORKFLOW_START | Send the request again. |
Versions
/api/v1/passes/{id}/versions/{version}Path
Returns
200 PassDetail
Errors
| Code | Status | Fix |
|---|---|---|
| ASSET_DIMENSIONS | Resize the image to the size named in issues and upload it again. | |
| ASSET_NOT_FOUND | Check the image name or id and that it belongs to this organization. | |
| ASSET_NOT_PNG | Re-export the image as a standard RGB or RGBA PNG and upload it again. | |
| ASSET_SIZE | Compress the image below 1 MB and upload it again. | |
| ASSET_SLOT | Use a slot name from the pass type's image slots in the request path. | |
| BULK_RUN_ACTIVE | Wait for the running job to finish, then start the new one. | |
| BUNDLE_TOO_LARGE | Split the passes across smaller bundles. | |
| CONNECTION_ORG | Use a connection id from your own organization's GET /api/v1/connections. | |
| CONNECTION_TRANSFER_PENDING | Wait for the transfer to finish, then send the request again. | |
| CREATE_STALE | Look the pass up by externalId with GET /api/v1/passes and update it instead of creating it again. | |
| CREDENTIAL_REF_KEYSET_CONFIG_UNAVAILABLE | Retry with backoff; if it persists, send the requestId to support. | |
| CREDENTIAL_REF_KEYSET_UNAVAILABLE | Retry with backoff; if it persists, send the requestId to support. | |
| DELIVERY_STALE | Review the recipient and try again. | |
| DEVICE_TOKEN_UNAVAILABLE | Retry the request; if it persists, send the requestId to support. | |
| EMAIL_INVALID | Send a valid address in the email field. | |
| EXTERNAL_ID_TAKEN | Send a new externalId, or PATCH the existing pass. | |
| FORBIDDEN | Use a key with the scope the operation lists, or ask an org admin. | |
| IDEMPOTENCY_IN_PROGRESS | Wait a moment and resend the identical request. | |
| IDEMPOTENCY_KEY_INVALID | Send a unique string of 1 to 200 characters, such as a UUID. | |
| IDEMPOTENCY_KEY_REUSED | Use a new key for a new request; resend the identical request to replay. | |
| IF_MATCH_INVALID | Send the version from the last GET, for example If-Match: 3. | |
| IMPORT_BUSY | Wait for it to finish with GET /api/v1/pass-imports/{id}, then retry. | |
| IMPORT_COLUMN_MISSING | Add the column to the file, or change the mapping, then check again. | |
| IMPORT_EXPIRED | Upload the file again with POST /api/v1/pass-imports. | |
| IMPORT_FILE_GONE | Upload it again. | |
| IMPORT_HAS_ERRORS | Fix the rows listed in GET /api/v1/pass-imports/{id}/errors.csv, or skip them, then commit again. | |
| IMPORT_HEADER_TOO_LONG | Shorten the header and upload the file again. | |
| IMPORT_ID_TAKEN | Check the import again with POST /api/v1/pass-imports/{id}/check, then commit. | |
| IMPORT_NOT_FOUND | Check the id with GET /api/v1/pass-imports. | |
| IMPORT_PASS_CHANGED | Remove the pass on its own with POST /api/v1/passes/{id}/remove. | |
| IMPORT_PLAN_INVALID | Fix the mapping entries named in issues and check again. | |
| IMPORT_ROW_UNRESERVED | Retry the commit; if it persists, send the requestId to support. | |
| IMPORT_STATE | Check its state with GET /api/v1/pass-imports/{id} and call the action that state allows. | |
| INVALID_API_KEY | Create a new key in the console and update PASSBOOK_KEY. | |
| INVALID_INPUT | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| JOIN_NOT_READY | Publish the template, then enable the link with PUT /api/v1/join-links/{templateId}. | |
| MATCH_NEEDS_TEMPLATE | Send orgId and templateId with the input filter. | |
| MEMBER_PHOTO_CHANGED | Fetch the pass with GET /api/v1/passes/{id} and save the photo again. | |
| MEMBER_PHOTO_DIMENSIONS | Crop the photo to a 270 by 270 pixel square and upload it again. | |
| MEMBER_PHOTO_ENCODING | Send the photo as a PNG or JPEG file. | |
| MEMBER_PHOTO_NOT_FOUND | Add one with PUT /api/v1/passes/{id}/member-photo. | |
| MEMBER_PHOTO_STYLE | Use a template of that style, or remove the strip image. | |
| MISSING_SCOPE | Create a key with the scope the operation lists under security. | |
| MODE_MISMATCH | Use objects and a key of the same mode. | |
| NEW_CODE_UNSUPPORTED | Reissue the pass with POST /api/v1/passes/bulk-reissue instead of requesting a new code. | |
| 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_ACCESS_CHANGED | Check access with GET /api/v1/api-keys/me, then send the request again. | |
| ORG_FORBIDDEN | Use a key scoped to this organization, or a platform key for platform-wide lists. | |
| ORG_MIXED | Send ids from one organization per request. | |
| ORG_NOT_FOUND | Check orgId with GET /api/v1/orgs. | |
| ORG_REQUIRED | Send orgId with the request, or use a key scoped to one organization. | |
| PASS_CONFLICT | Fetch the pass with GET /api/v1/passes/{id} and send the request again. | |
| PASS_CONNECTION_MISMATCH | Link it with PUT /api/v1/passes/{id}/connection, then send the request again. | |
| PASS_FILE_MISSING | Rebuild it with POST /api/v1/passes/{id}/refresh. | |
| PASS_INPUT_INVALID | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| PASS_INVALID | Fix the problems named in issues in the template or inputs. | |
| PASS_NOT_ACTIVE | Restore or unvoid the pass first, or use an active one. | |
| PASS_NOT_FOUND | Check the id with GET /api/v1/passes and the key's mode. | |
| PASS_REF_TAKEN | Use a different ref, or update the existing pass. | |
| PASS_REISSUE_REQUIRED | Reissue it with POST /api/v1/passes/bulk-reissue. | |
| PASS_REMOVED | Restore it with POST /api/v1/passes/{id}/restore, then send the request again. | |
| PASS_TRANSFER_NOT_FOUND | Check the transfer id. | |
| PASS_TRANSFER_PENDING | Try again shortly. | |
| 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}. | |
| SCAN_EVENT_NOT_FOUND | Check the event id with GET /api/v1/scan/events. | |
| SCAN_WINDOW_INVALID | Set an end after the start, or fix the template's dates. | |
| SERIAL_TAKEN | Send a different serial, or leave it out to have one generated. | |
| SESSION_REQUIRED | Do it in the console, or sign in as the account that started it. | |
| STAMPS_ABOVE_MAX | Raise the template's stamp maximum, or redeem stamps first. | |
| STAMPS_CARD_FULL | Redeem the reward, then add stamps. | |
| STAMPS_NONE | Use a template with stamps. | |
| STAMPS_NO_REWARD | Add stamps until the card is full, then redeem. | |
| TEMPLATE_NOT_FOUND | Check the id with GET /api/v1/templates and the key's mode. | |
| TEMPLATE_RELEASE_CONFLICT | Send the request again to use the current release. | |
| TEMPLATE_RELEASE_REQUIRED | Approve a release with POST /api/v1/templates/{id}/candidates/{candidateId}/approve. | |
| TERM_MANAGED | Change the term in the connected system. | |
| TERM_NONE | Renew only passes whose template defines a term. | |
| TERM_NOT_STARTED | Renew after the term starts. | |
| UNAUTHENTICATED | Send Authorization: Bearer $PASSBOOK_KEY. | |
| VALIDATION | Fix each field in issues and resend. | |
| VERSION_NOT_FOUND | Check the version with GET /api/v1/passes/{id}. | |
| VERSION_PURGED | Request a newer version. | |
| WORKFLOW_START | Send the request again. |
/api/v1/passes/{id}/diffPath
Query
Returns
200
Errors
| Code | Status | Fix |
|---|---|---|
| ASSET_DIMENSIONS | Resize the image to the size named in issues and upload it again. | |
| ASSET_NOT_FOUND | Check the image name or id and that it belongs to this organization. | |
| ASSET_NOT_PNG | Re-export the image as a standard RGB or RGBA PNG and upload it again. | |
| ASSET_SIZE | Compress the image below 1 MB and upload it again. | |
| ASSET_SLOT | Use a slot name from the pass type's image slots in the request path. | |
| BULK_RUN_ACTIVE | Wait for the running job to finish, then start the new one. | |
| BUNDLE_TOO_LARGE | Split the passes across smaller bundles. | |
| CONNECTION_ORG | Use a connection id from your own organization's GET /api/v1/connections. | |
| CONNECTION_TRANSFER_PENDING | Wait for the transfer to finish, then send the request again. | |
| CREATE_STALE | Look the pass up by externalId with GET /api/v1/passes and update it instead of creating it again. | |
| CREDENTIAL_REF_KEYSET_CONFIG_UNAVAILABLE | Retry with backoff; if it persists, send the requestId to support. | |
| CREDENTIAL_REF_KEYSET_UNAVAILABLE | Retry with backoff; if it persists, send the requestId to support. | |
| DELIVERY_STALE | Review the recipient and try again. | |
| DEVICE_TOKEN_UNAVAILABLE | Retry the request; if it persists, send the requestId to support. | |
| EMAIL_INVALID | Send a valid address in the email field. | |
| EXTERNAL_ID_TAKEN | Send a new externalId, or PATCH the existing pass. | |
| FORBIDDEN | Use a key with the scope the operation lists, or ask an org admin. | |
| IDEMPOTENCY_IN_PROGRESS | Wait a moment and resend the identical request. | |
| IDEMPOTENCY_KEY_INVALID | Send a unique string of 1 to 200 characters, such as a UUID. | |
| IDEMPOTENCY_KEY_REUSED | Use a new key for a new request; resend the identical request to replay. | |
| IF_MATCH_INVALID | Send the version from the last GET, for example If-Match: 3. | |
| IMPORT_BUSY | Wait for it to finish with GET /api/v1/pass-imports/{id}, then retry. | |
| IMPORT_COLUMN_MISSING | Add the column to the file, or change the mapping, then check again. | |
| IMPORT_EXPIRED | Upload the file again with POST /api/v1/pass-imports. | |
| IMPORT_FILE_GONE | Upload it again. | |
| IMPORT_HAS_ERRORS | Fix the rows listed in GET /api/v1/pass-imports/{id}/errors.csv, or skip them, then commit again. | |
| IMPORT_HEADER_TOO_LONG | Shorten the header and upload the file again. | |
| IMPORT_ID_TAKEN | Check the import again with POST /api/v1/pass-imports/{id}/check, then commit. | |
| IMPORT_NOT_FOUND | Check the id with GET /api/v1/pass-imports. | |
| IMPORT_PASS_CHANGED | Remove the pass on its own with POST /api/v1/passes/{id}/remove. | |
| IMPORT_PLAN_INVALID | Fix the mapping entries named in issues and check again. | |
| IMPORT_ROW_UNRESERVED | Retry the commit; if it persists, send the requestId to support. | |
| IMPORT_STATE | Check its state with GET /api/v1/pass-imports/{id} and call the action that state allows. | |
| INVALID_API_KEY | Create a new key in the console and update PASSBOOK_KEY. | |
| INVALID_INPUT | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| JOIN_NOT_READY | Publish the template, then enable the link with PUT /api/v1/join-links/{templateId}. | |
| MATCH_NEEDS_TEMPLATE | Send orgId and templateId with the input filter. | |
| MEMBER_PHOTO_CHANGED | Fetch the pass with GET /api/v1/passes/{id} and save the photo again. | |
| MEMBER_PHOTO_DIMENSIONS | Crop the photo to a 270 by 270 pixel square and upload it again. | |
| MEMBER_PHOTO_ENCODING | Send the photo as a PNG or JPEG file. | |
| MEMBER_PHOTO_NOT_FOUND | Add one with PUT /api/v1/passes/{id}/member-photo. | |
| MEMBER_PHOTO_STYLE | Use a template of that style, or remove the strip image. | |
| MISSING_SCOPE | Create a key with the scope the operation lists under security. | |
| MODE_MISMATCH | Use objects and a key of the same mode. | |
| NEW_CODE_UNSUPPORTED | Reissue the pass with POST /api/v1/passes/bulk-reissue instead of requesting a new code. | |
| 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_ACCESS_CHANGED | Check access with GET /api/v1/api-keys/me, then send the request again. | |
| ORG_FORBIDDEN | Use a key scoped to this organization, or a platform key for platform-wide lists. | |
| ORG_MIXED | Send ids from one organization per request. | |
| ORG_NOT_FOUND | Check orgId with GET /api/v1/orgs. | |
| ORG_REQUIRED | Send orgId with the request, or use a key scoped to one organization. | |
| PASS_CONFLICT | Fetch the pass with GET /api/v1/passes/{id} and send the request again. | |
| PASS_CONNECTION_MISMATCH | Link it with PUT /api/v1/passes/{id}/connection, then send the request again. | |
| PASS_FILE_MISSING | Rebuild it with POST /api/v1/passes/{id}/refresh. | |
| PASS_INPUT_INVALID | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| PASS_INVALID | Fix the problems named in issues in the template or inputs. | |
| PASS_NOT_ACTIVE | Restore or unvoid the pass first, or use an active one. | |
| PASS_NOT_FOUND | Check the id with GET /api/v1/passes and the key's mode. | |
| PASS_REF_TAKEN | Use a different ref, or update the existing pass. | |
| PASS_REISSUE_REQUIRED | Reissue it with POST /api/v1/passes/bulk-reissue. | |
| PASS_REMOVED | Restore it with POST /api/v1/passes/{id}/restore, then send the request again. | |
| PASS_TRANSFER_NOT_FOUND | Check the transfer id. | |
| PASS_TRANSFER_PENDING | Try again shortly. | |
| 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}. | |
| SCAN_EVENT_NOT_FOUND | Check the event id with GET /api/v1/scan/events. | |
| SCAN_WINDOW_INVALID | Set an end after the start, or fix the template's dates. | |
| SERIAL_TAKEN | Send a different serial, or leave it out to have one generated. | |
| SESSION_REQUIRED | Do it in the console, or sign in as the account that started it. | |
| STAMPS_ABOVE_MAX | Raise the template's stamp maximum, or redeem stamps first. | |
| STAMPS_CARD_FULL | Redeem the reward, then add stamps. | |
| STAMPS_NONE | Use a template with stamps. | |
| STAMPS_NO_REWARD | Add stamps until the card is full, then redeem. | |
| TEMPLATE_NOT_FOUND | Check the id with GET /api/v1/templates and the key's mode. | |
| TEMPLATE_RELEASE_CONFLICT | Send the request again to use the current release. | |
| TEMPLATE_RELEASE_REQUIRED | Approve a release with POST /api/v1/templates/{id}/candidates/{candidateId}/approve. | |
| TERM_MANAGED | Change the term in the connected system. | |
| TERM_NONE | Renew only passes whose template defines a term. | |
| TERM_NOT_STARTED | Renew after the term starts. | |
| UNAUTHENTICATED | Send Authorization: Bearer $PASSBOOK_KEY. | |
| VALIDATION | Fix each field in issues and resend. | |
| VERSION_NOT_FOUND | Check the version with GET /api/v1/passes/{id}. | |
| VERSION_PURGED | Request a newer version. | |
| WORKFLOW_START | Send the request again. |