Create List Entry | AgentMail

**CLI:** ```bash agentmail lists create --direction <direction> --type <type> --entry user@example.com ```

CLI:

$ agentmail lists create --direction <direction> --type <type> --entry user@example.com

**CLI:** ```bash agentmail lists create --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

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.

Allowed values:

entrystring

Email address or domain of list entry.

entry_typeenum

Whether the entry is an email address or domain.

Allowed values:

list_typeenum

Type of list entry.

Allowed values:

organization_idstring

ID of organization.

read_onlyboolean

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

reasonstring

Reason for adding the entry.

Errors

400

Validation Error

CLI:

$ agentmail lists create --direction <direction> --type <type> --entry user@example.com

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

Direction of list entry.

This endpoint expects an object.

Email address or domain to add.

Reason for adding the entry.

This endpoint returns an object.

Time at which entry was created.

Direction of list entry.

Email address or domain of list entry.

Whether the entry is an email address or domain.

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

Reason for adding the entry.

1	from agentmail import AgentMail
2
3	client = AgentMail(
4	api_key="YOUR_TOKEN_HERE",
5	)
6
7	client.lists.create(
8	direction="send",
9	type="allow",
10	entry="entry",
11	)

1	{
2	"created_at": "2024-01-15T09:30:00Z",
3	"direction": "send",
4	"entry": "entry",
5	"entry_type": "email",
6	"list_type": "allow",
7	"organization_id": "organization_id",
8	"read_only": true,
9	"reason": "reason"
10	}

1	from agentmail import AgentMail
2
3	client = AgentMail(
4	api_key="YOUR_TOKEN_HERE",
5	)
6
7	client.lists.create(
8	direction="send",
9	type="allow",
10	entry="entry",
11	)

1	{
2	"created_at": "2024-01-15T09:30:00Z",
3	"direction": "send",
4	"entry": "entry",
5	"entry_type": "email",
6	"list_type": "allow",
7	"organization_id": "organization_id",
8	"read_only": true,
9	"reason": "reason"
10	}