v1

latestOpenAPI 3.0.1raw.githubusercontent.com2026-04-2099201202.6 KB

Inboxes

Create Inbox

CLI:

agentmail inboxes create --display-name "My Agent" --username myagent --domain agentmail.to

post/v0/inboxes

usernamestring nullable

Username of address. Randomly generated if not specified.

domainstring nullable

Domain of address. Must be verified domain. Defaults to agentmail.to.

display_namestring

Display name: Display Name <username@domain.com>.

client_idstring

Client ID of inbox.

pod_idstring required

ID of pod.

inbox_idstring required

The ID of the inbox.

emailstring required

Email address of the inbox.

display_namestring

Display name: Display Name <username@domain.com>.

client_idstring

Client ID of inbox.

updated_atstring date-time required

Time at which inbox was last updated.

created_atstring date-time required

Time at which inbox was created.