v34

latestOpenAPI 3.0.1raw.githubusercontent.com2026-07-21119235265.2 KB

Inboxes

Update Inbox

CLI:

agentmail inboxes update --inbox-id <inbox_id> --display-name "Updated Name"

patch/v0/inboxes/{inbox_id}

Path parameters

inbox_idstring required

The ID of the inbox.

Request body

display_namestring

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

metadataInboxesUpdateMetadata

Custom key-value pairs to merge into the inbox's existing metadata. A value may be a string, number, boolean, or null. Setting a key to null removes it. Up to 256 keys; keys and string values are each limited to 256 characters.

Response

pod_idstring required

ID of pod.

inbox_idstring required

The ID of the inbox.

emailstring required

Email address of the inbox.

display_namestring

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

client_idstring

Client ID of inbox.

metadataInboxesMetadata

Custom key-value pairs attached to the inbox. Up to 256 keys. Keys and string values are each limited to 256 characters. When updating metadata, send a key with a null value to remove that key.

updated_atstring date-time required

Time at which inbox was last updated.

created_atstring date-time required

Time at which inbox was created.