Sign in

v34

latestOpenAPI 3.0.1raw.githubusercontent.com2026-07-21119235265.2 KB
PodsInboxes

Create Inbox

CLI:

agentmail pods:inboxes create --pod-id <pod_id> --username myagent --domain example.com
post/v0/pods/{pod_id}/inboxes

Path parameters

pod_idstring required

ID of pod.

Request body

usernamestring nullable

Username of address. Randomly generated if not specified.

domainstring nullable

Domain of address. Must be a verified domain, or any subdomain of a verified domain that has subdomains enabled (e.g., bot.example.com). Defaults to agentmail.to.

display_namestring

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

client_idstring

Client ID of inbox.

metadataInboxesMetadata

Custom key-value pairs attached to the inbox. Up to 256 keys. Keys and string values are each limited to 256 characters. When updating metadata, send a key with a null value to remove that key.

Response

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.

metadataInboxesMetadata

Custom key-value pairs attached to the inbox. Up to 256 keys. Keys and string values are each limited to 256 characters. When updating metadata, send a key with a null value to remove that key.

updated_atstring date-time required

Time at which inbox was last updated.

created_atstring date-time required

Time at which inbox was created.