Skip to main content
POST
Create an inbox

Authorizations

Authorization
string
header
required

Organization key (alk_…) created under Settings; acts for the whole organization

Body

application/json
username
string
required

Local part of the address

Pattern: ^[a-z0-9._-]{1,64}$
agent_id
string

Owning agent; omitted creates an agent named after the username

Minimum string length: 1
display_name
string
Maximum string length: 80
domain
string

A verified domain of this organization; defaults to the managed domain

Maximum string length: 253
inbound_mode
enum<string>
Available options:
open,
allowlist
metadata
object

Up to 16 string labels, for example your own tenant id

idempotency_key
string
Maximum string length: 200

Response

Inbox already existed

inbox
object | null
required

Null while provisioning continues

created
boolean
required
resource
object
required
agent
object

The owning agent, while the inbox is still provisioning