Skip to main content

Inboxes

GET /v0/emails/inboxes · POST /v0/emails/inboxes · GET|PATCH|DELETE /v0/emails/inboxes/:inbox_id (project twins under /v0/projects/:project_id/emails/inboxes…).

Create

username is optional (random if omitted). domain must be a verified domain you own (or a subdomain of one with subdomains enabled), else the default domain. client_id makes creation idempotent.

Update

PATCH accepts display_name and/or metadata. Metadata merges: included keys overwrite, null removes one key, null for the whole object clears it. Empty {} is rejected; at least one field is required.

Object

Deleting an inbox cascades to its threads and messages.