Create Inbox
inbox_createCreate a new email inbox (mailbox) that can receive mail immediately at its address. Choose a username and domain or let the platform generate them. Requires master key access.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| domain | No | Domain for the inbox address. Uses the platform default (agents.useanima.sh) when omitted. Custom domains must already be registered and verified — see domain_list. | |
| agentId | No | Agent ID to associate with this inbox. Inbound mail to the inbox is attributed to this agent. | |
| username | No | Local part of the inbox email address (letters, numbers, dots, hyphens, underscores; normalized to lowercase; must not start/end with a dot or hyphen). A random local part is generated when omitted. | |
| displayName | No | Human-readable display name for the inbox (max 128 characters). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||