AGagentmail-to
pods > inboxes

Create Inbox

Changed on

CLI:

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

Request

Path parameters

pod_idstring required

ID of pod.

Request body

usernamestring

Username of address. Randomly generated if not specified.

domainstring

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.

status'active' | 'deactivated'

Whether the inbox sends and receives mail. deactivated stops both: sends return 403 with code inbox_deactivated, and incoming mail is not delivered and not bounced, then or on reactivation. Mail already in the inbox, its drafts, and its API keys are kept. Set active to reactivate.

deactivate_atstring date-time

When the inbox deactivates itself. Within about five minutes after this time, the inbox becomes deactivated exactly as if status had been set to deactivated, and deactivate_at is cleared. Must be in the future; returned in UTC. A manual deactivation or reactivation does not change it.

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

Response with status 200

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.

status'active' | 'deactivated'

Whether the inbox sends and receives mail. deactivated stops both: sends return 403 with code inbox_deactivated, and incoming mail is not delivered and not bounced, then or on reactivation. Mail already in the inbox, its drafts, and its API keys are kept. Set active to reactivate.

deactivate_atstring date-time

When the inbox deactivates itself. Within about five minutes after this time, the inbox becomes deactivated exactly as if status had been set to deactivated, and deactivate_at is cleared. Must be in the future; returned in UTC. A manual deactivation or reactivation does not change it.

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.

Changes

  • bb124483eb34Revision changes
    • breaking

      removed the enum value paused of the request property

    • warning

      removed the request property

    • warning

      removed the optional property from the response with the status

    • warning

      added the new deactivated enum value to the response property for the response status

    • info

      added the new optional request property

    • info

      added the new deactivated enum value to the request property

    • info

      added the optional property to the response with the status

    • info

      removed the paused enum value from the response property for the response status

  • a9792efe7bdfRevision changes
    • info

      added the new optional request property

    • info

      added the optional property to the response with the status