Create Inbox

POST

/v0/pods/:pod_id/inboxes

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 a verified domain, or any subdomain of a verified domain that has subdomains enabled (e.g., bot.example.com). Defaults to agentmail.to.

display_namestringOptional

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

client_idstringOptional

Client ID of inbox.

metadatamap from strings to strings or doubles or booleansOptional

Custom metadata to attach to the 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.

metadatamap from strings to strings or doubles or booleans

Custom metadata attached to the inbox.

Errors

400

Validation Error

422

Unprocessable Error

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	"metadata": {
10	"metadata": "metadata"
11	}
12	}