ReferenceMessages
Deliveries
1 operation. Send Authorization: Bearer $PASSBOOK_KEY. Markdown
GET
/api/v1/deliverypasses:readSDK pb.deliveries.list
Query
passIdstring · max 64Required
Returns
200
Errors
| Code | Status | Fix |
|---|---|---|
| DELIVERY_STALE | Review the recipient and try again. | |
| EMAIL_INVALID | Send a valid address in the email field. | |
| EMAIL_OUTCOME_UNKNOWN | Check the pass's delivery status before sending again, to avoid a duplicate email. | |
| EMAIL_RATE_LIMITED | Wait for Retry-After, then retry. | |
| 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. | |
| 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. | |
| 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_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. | |
| REPLY_TO_LINK_INVALID | Request a new link with POST /api/v1/settings/reply-to/resend. | |
| REPLY_TO_NOTHING_PENDING | Set a new reply-to address with PUT /api/v1/settings first. | |
| REPLY_TO_RESEND_LIMITED | Wait a minute, then call POST /api/v1/settings/reply-to/resend again. | |
| UNAUTHENTICATED | Send Authorization: Bearer $PASSBOOK_KEY. | |
| VALIDATION | Fix each field in issues and resend. |