Sign in
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 verified domain. Defaults to agentmail.to.

display_namestring

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

client_idstring

Client ID of inbox.

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.

updated_atstring date-time required

Time at which inbox was last updated.

created_atstring date-time required

Time at which inbox was created.

Changes

No recorded changes to this endpoint across all 1 revision of this API.