Create Inbox | AgentMail

**CLI:** ```bash agentmail pods:inboxes create --pod-id <pod_id> --username myagent --domain example.com ```

CLI:

$ agentmail pods:inboxes create --pod-id <pod_id> --username myagent --domain example.com

**CLI:** ```bash agentmail pods:inboxes create --pod-id <pod_id> --username myagent --domain example.com ```

Authentication

AuthorizationBearer

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

Path parameters

pod_idstringRequired

ID of pod.

Request

This endpoint expects an object.

usernamestringOptional

Username of address. Randomly generated if not specified.

domainstringOptional

Domain of address. Must be verified domain. Defaults to agentmail.to.

display_namestringOptional

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

client_idstringOptional

Client ID of inbox.

Response

This endpoint returns an object.

pod_idstring

ID of pod.

inbox_idstring

The ID of the inbox.

emailstring

Email address of the inbox.

updated_atdatetime

Time at which inbox was last updated.

created_atdatetime

Time at which inbox was created.

display_namestring

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

client_idstring

Client ID of inbox.

Errors

400

Validation Error

CLI:

$ agentmail pods:inboxes create --pod-id <pod_id> --username myagent --domain example.com

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

This endpoint expects an object.

Username of address. Randomly generated if not specified.

Domain of address. Must be verified domain. Defaults to agentmail.to.

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

This endpoint returns an object.

The ID of the inbox.

Email address of the inbox.

Time at which inbox was last updated.

Time at which inbox was created.

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

1	from agentmail import AgentMail
2
3	client = AgentMail(
4	api_key="YOUR_TOKEN_HERE",
5	)
6
7	client.pods.inboxes.create(
8	pod_id="pod_id",
9	)

1	{
2	"pod_id": "pod_id",
3	"inbox_id": "inbox_id",
4	"email": "email",
5	"updated_at": "2024-01-15T09:30:00Z",
6	"created_at": "2024-01-15T09:30:00Z",
7	"display_name": "display_name",
8	"client_id": "client_id"
9	}

1	from agentmail import AgentMail
2
3	client = AgentMail(
4	api_key="YOUR_TOKEN_HERE",
5	)
6
7	client.pods.inboxes.create(
8	pod_id="pod_id",
9	)

1	{
2	"pod_id": "pod_id",
3	"inbox_id": "inbox_id",
4	"email": "email",
5	"updated_at": "2024-01-15T09:30:00Z",
6	"created_at": "2024-01-15T09:30:00Z",
7	"display_name": "display_name",
8	"client_id": "client_id"
9	}