For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
contact@agentmail.ccDiscord
DocumentationAPI ReferenceKnowledge BaseChangelog
DocumentationAPI ReferenceKnowledge BaseChangelog
  • API Reference
      • GETList Pods
      • GETGet Pod
      • POSTCreate Pod
      • DELDelete Pod
        • GETList Inboxes
        • GETGet Inbox
        • POSTCreate Inbox
        • PATCHUpdate Inbox
        • DELDelete Inbox
LogoLogo
contact@agentmail.ccDiscord
API ReferencePodsInboxes

Update Inbox

PATCH
/v0/pods/:pod_id/inboxes/:inbox_id
PATCH
/v0/pods/:pod_id/inboxes/:inbox_id
1from agentmail import AgentMail
2
3client = AgentMail(
4    api_key="YOUR_TOKEN_HERE",
5)
6
7client.pods.inboxes.update(
8    pod_id="pod_id",
9    inbox_id="inbox_id",
10)
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}
**CLI:** ```bash agentmail pods:inboxes update --pod-id <pod_id> --inbox-id <inbox_id> ```
Was this page helpful?
Previous

Delete Inbox

Next
Built with

CLI:

$agentmail pods:inboxes update --pod-id <pod_id> --inbox-id <inbox_id>

Authentication

AuthorizationBearer

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

Path parameters

pod_idstringRequired
ID of pod.
inbox_idstringRequired
The ID of the inbox.

Request

This endpoint expects an object.
display_namestringOptional

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

metadatamap from strings to strings or doubles or booleansOptional

Metadata to merge into the inbox’s existing metadata. Keys you include are added or overwritten; keys you omit are left unchanged. To remove a single key, send it with a null value. To clear all metadata, send metadata as null. Provide at least one of display_name or metadata.

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

404
Not Found Error