Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

JWT Bearer token obtained from authentication. Pass as: Authorization: Bearer

Body

application/json

Request body for creating a new inbox

username
string

Local part of the inbox email address (letters, numbers, dots, hyphens, underscores). Normalized to lowercase.

Required string length: 1 - 64
Pattern: ^[a-zA-Z0-9._-]+$
domain
string

Domain for the inbox email address; uses the default domain if omitted

displayName
string

Human-readable display name for the inbox (max 128 characters)

Maximum string length: 128
agentId
string

ID of the agent to associate with this inbox. With an agent-scoped key, defaults to the calling agent and may only name that agent; naming a different agent requires a master key. With a master key, omitting it creates a dedicated backing agent for the inbox.

Pattern: ^[cC][^\s-]{8,}$

Response

OK

Inbox resource representation

id
string
required

Unique identifier of the inbox

Pattern: ^[cC][^\s-]{8,}$
email
string<email>
required

Full email address of the inbox

domain
string
required

Domain portion of the inbox email address

localPart
string
required

Local part (before the @) of the inbox email address

displayName
string | null
required

Human-readable display name, or null if not set

agentId
string
required

ID of the agent this inbox belongs to

Pattern: ^[cC][^\s-]{8,}$
createdAt
string<date-time>
required

Timestamp when the inbox was created