contact@agentmail.ccDiscord
DocumentationAPI ReferenceChangelog
DocumentationAPI ReferenceChangelog
  • API Reference
Logo
contact@agentmail.ccDiscord
API ReferencePodsInboxes

Create Inbox

POST
/v0/pods/:pod_id/inboxes
POST
/v0/pods/:pod_id/inboxes
1from agentmail import AgentMail
2
3client = AgentMail(
4    base_url="https://api.agentmail.to",
5    api_key="YOUR_TOKEN_HERE"
6)
7
8client.pods.inboxes.create(
9    pod_id="pod_id"
10)
Try it
200Successful
1{
2  "inbox_id": "inbox_id",
3  "updated_at": "2024-01-15T09:30:00Z",
4  "created_at": "2024-01-15T09:30:00Z",
5  "display_name": "display_name",
6  "client_id": "client_id"
7}
Was this page helpful?
Previous

Delete Inbox

Next
Built with
Delete Inbox

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.
inbox_idstring
ID of inbox.
updated_atdatetime
Time at which inbox was last updated.
created_atdatetime
Time at which inbox was created.
display_namestring or null

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

client_idstring or null
Client ID of inbox.

Errors

ID of pod.

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