/inboundIngest an inbound email
Authentication
Bearer authentication is required for this operation.
Request body
fromrequiredstringSender email address. Example: "hello@example.com".
htmlstringHTML email content.
subjectstringEmail subject.
textstringPlain-text email content.
torequiredstringReceiving email address. Example: "hello@example.com".
Request examples
curl --request POST 'https://api.au.boundry.dev/inbound' \
+ -H 'Authorization: Bearer $BOUNDRY_API_KEY' \
+ -H 'Content-Type: application/json' \
+ --data '{"from":"sender@example.com","text":"Hello","to":"inbox@acme.com"}'202 response
Inbound email stored in the local data plane.
datarequiredobjectStored inbound email. Example: {"created_at":"2026-08-14T12:00:00.000Z","from":"sender@example.com","html":null,"id":"rcv_01j0example","status":"received","subject":"Hello","text":"Hello","to":["inbox@acme.com"],"updated_at":"2026-08-14T12:00:00.000Z"}.
created_atrequiredstring (date-time)Timestamp when the email was received. Example: "2026-08-14T12:00:00.000Z".
fromrequiredstringSender email address. Example: "hello@example.com".
htmlrequiredstring | null | nullHTML body, or null when omitted.
Option 1stringHTML email content.
Option 2null | nullOne permitted response shape.
idrequiredstringInbound email identifier. Example: "msg_01j0example".
statusrequiredstringInbound email status. Values: "received".
subjectrequiredstringEmail subject.
textrequiredstring | null | nullPlain-text body, or null when omitted.
Option 1stringPlain-text email content.
Option 2null | nullOne permitted response shape.
torequiredarrayReceiving addresses.
updated_atrequiredstring (date-time)Timestamp when the email was last updated. Example: "2026-08-14T12:00:00.000Z".
moderequiredstringInbound processing mode. Values: "local-inbound".
{
"from": "sender@example.com",
"text": "Hello",
"to": "inbox@acme.com"
}400 response
Request body was not valid JSON.
errorsarrayDetailed validation issues. Absent only for the historical 401 API-key envelope.
coderequiredstringZod validation issue code. Example: "invalid_format".
messagerequiredstringHuman-readable validation failure. Example: "Invalid email address".
pathrequiredstringDot-separated location of the invalid value. Example: "from".
messagerequiredstringHuman-readable error message. Example: "Request validation failed.".
namerequiredstringMachine-readable error category. Values: "validation_error", "application_error", "not_found". Example: "validation_error".
{
"from": "sender@example.com",
"text": "Hello",
"to": "inbox@acme.com"
}401 response
Invalid API key.
errorsarrayDetailed validation issues. Absent only for the historical 401 API-key envelope.
coderequiredstringZod validation issue code. Example: "invalid_format".
messagerequiredstringHuman-readable validation failure. Example: "Invalid email address".
pathrequiredstringDot-separated location of the invalid value. Example: "from".
messagerequiredstringHuman-readable error message. Example: "Request validation failed.".
namerequiredstringMachine-readable error category. Values: "validation_error", "application_error", "not_found". Example: "validation_error".
{
"from": "sender@example.com",
"text": "Hello",
"to": "inbox@acme.com"
}422 response
Inbound email validation failed.
errorsarrayDetailed validation issues. Absent only for the historical 401 API-key envelope.
coderequiredstringZod validation issue code. Example: "invalid_format".
messagerequiredstringHuman-readable validation failure. Example: "Invalid email address".
pathrequiredstringDot-separated location of the invalid value. Example: "from".
messagerequiredstringHuman-readable error message. Example: "Request validation failed.".
namerequiredstringMachine-readable error category. Values: "validation_error", "application_error", "not_found". Example: "validation_error".
{
"from": "sender@example.com",
"text": "Hello",
"to": "inbox@acme.com"
}