Skip to navigation
API ReferencePodsLists

Create List Entry

CLI:

agentmail pods lists create --pod-id <pod_id> --direction <direction> --type <type> --entry user@example.com

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

pod_idstringRequired
ID of pod.
directionenumRequired
Direction of list entry.
Allowed values:
typeenumRequired
Type of list entry.
Allowed values:

Request

This endpoint expects an object.
entrystringRequired
Email address or domain to add.
reasonstringOptional
Reason for adding the entry.

Response

This endpoint returns an object.
created_atdatetime
Time at which entry was created.
directionenum
Direction of list entry.
entrystring
Email address or domain of list entry.
entry_typeenum
Whether the entry is an email address or domain.
list_typeenum
Type of list entry.
organization_idstring
ID of organization.
pod_idstring
ID of pod.
inbox_idstringOptional

ID of inbox, if entry is inbox-scoped.

read_onlybooleanOptional

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

reasonstringOptional
Reason for adding the entry.

Errors

400
Validation Error