Skip to content

Inboxes

Dedicated email identities owned by an account or grouped in a pod.

01

List inboxes#

The result is automatically scoped by the API key. Account keys see all inboxes, pod keys see that pod, and inbox keys see one inbox.

Shell
curl https://botinbox.dev/v0/inboxes -H "Authorization: Bearer $BOTINBOX_API_KEY"

02

Create an inbox#

Account and pod keys can provision inboxes up to the plan limit. The response includes a new inbox-scoped API key exactly once.

Shell
curl https://botinbox.dev/v0/inboxes \
  -X POST -H "Authorization: Bearer $BOTINBOX_API_KEY" -H "Content-Type: application/json" \
  -d '{"username":"scout","display_name":"Scout Agent","pod_id":"OPTIONAL_POD_ID"}'

03

Get one inbox#

Use the stable inbox ID for message, thread, and attachment routes.

Shell
curl https://botinbox.dev/v0/inboxes/INBOX_ID -H "Authorization: Bearer $BOTINBOX_API_KEY"