Sign in

v34

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

Create List Entry

CLI:

agentmail inboxes:lists create --inbox-id <inbox_id> --direction <direction> --type <type> --entry user@example.com
post/v0/inboxes/{inbox_id}/lists/{direction}/{type}

Path parameters

inbox_idstring required

The ID of the inbox.

direction'send' | 'receive' | 'reply' required

Direction of list entry.

type'allow' | 'block' required

Type of list entry.

Request body

entrystring required

Email address or domain to add.

reasonstring nullable

Reason for adding the entry.

Response

entrystring required

Email address or domain of list entry.

organization_idstring required

ID of organization.

reasonstring nullable

Reason for adding the entry.

direction'send' | 'receive' | 'reply' required

Direction of list entry.

list_type'allow' | 'block' required

Type of list entry.

entry_type'email' | 'domain' required

Whether the entry is an email address or domain.

created_atstring date-time required

Time at which entry was created.

read_onlyboolean nullable

Whether the entry is read-only and cannot be deleted via the API.