Create Inbox

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 for address: Display Name <username@domain.com>.

This endpoint returns an object.

inbox_idstring

ID (address) of inbox.

organization_idstring

ID of organization that owns inbox.

created_atdatetime

Time at which inbox was created.

display_namestringOptional

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

1	from agentmail import AgentMail
2
3	client = AgentMail(
4	api_key="YOUR_API_KEY",
5	)
6	client.inboxes.create(
7	username="yourinbox",
8	display_name="Your Inbox",
9	)

1	{
2	"inbox_id": "yourinbox@agentmail.to",
3	"organization_id": "123e4567-e89b-12d3-a456-426614174000",
4	"created_at": "2024-01-15T09:30:00Z",
5	"display_name": "Your Inbox"
6	}