ReferenceMessages

Test inbox

2 operations. Send Authorization: Bearer $PASSBOOK_KEY. Markdown

GET/api/v1/test-inbox

Lists emails captured in Test mode, newest first. Nothing is sent to the recipient.

passes:readSDK pb.testEmails.list

Query

cursorstring · max 512
limitinteger · ≥ 1 · ≤ 200

Returns

200 CapturedEmailPage

Errors

CodeStatusFix
CAPTURED_EMAIL_NOT_FOUNDList emails with GET /api/v1/test-inbox and use an id from the result.
FORBIDDENUse a key with the scope the operation lists, or ask an org admin.
INVALID_API_KEYCreate a new key in the console and update PASSBOOK_KEY.
MISSING_SCOPECreate a key with the scope the operation lists under security.
NO_VERIFIED_EMAILVerify an email address on the account, then send again.
RATE_LIMITEDWait for Retry-After seconds, then retry. Back off on repeats.
SANDBOX_PREVIEW_ONLYUse the preview card and QR in the console; live passes need a real organization.
SANDBOX_QUOTADelete test objects you no longer need, or move to an organization with live access.
SESSION_REQUIREDDo it in the console, or sign in as the account that started it.
TEST_FORWARD_ALREADY_ATTEMPTEDDo not send it again; check your inbox first.
TEST_FORWARD_CHANGEDSend it to yourself again.
TEST_FORWARD_OUTCOME_UNKNOWNDo not send this message again.
TEST_FORWARD_PREPARATION_FAILEDNothing was sent.
TEST_KEY_REQUIREDUse a key that starts with pb_test_.
UNAUTHENTICATEDSend Authorization: Bearer $PASSBOOK_KEY.
VALIDATIONFix each field in issues and resend.
GET/api/v1/test-inbox/{id}

One captured email with its HTML and text.

passes:readSDK pb.testEmails.retrieve

Path

idstring · max 64Required

Query

mode"live" | "test"

Returns

200 CapturedEmailDetail

Errors

CodeStatusFix
CAPTURED_EMAIL_NOT_FOUNDList emails with GET /api/v1/test-inbox and use an id from the result.
FORBIDDENUse a key with the scope the operation lists, or ask an org admin.
INVALID_API_KEYCreate a new key in the console and update PASSBOOK_KEY.
MISSING_SCOPECreate a key with the scope the operation lists under security.
NOT_FOUNDCheck the id, and that the key's mode (test or live) matches the object.
NO_VERIFIED_EMAILVerify an email address on the account, then send again.
RATE_LIMITEDWait for Retry-After seconds, then retry. Back off on repeats.
SANDBOX_PREVIEW_ONLYUse the preview card and QR in the console; live passes need a real organization.
SANDBOX_QUOTADelete test objects you no longer need, or move to an organization with live access.
SESSION_REQUIREDDo it in the console, or sign in as the account that started it.
TEST_FORWARD_ALREADY_ATTEMPTEDDo not send it again; check your inbox first.
TEST_FORWARD_CHANGEDSend it to yourself again.
TEST_FORWARD_OUTCOME_UNKNOWNDo not send this message again.
TEST_FORWARD_PREPARATION_FAILEDNothing was sent.
TEST_KEY_REQUIREDUse a key that starts with pb_test_.
UNAUTHENTICATEDSend Authorization: Bearer $PASSBOOK_KEY.
VALIDATIONFix each field in issues and resend.