AGagentmail-to
Inboxes

Update Inbox

CLI:

agentmail inboxes update --inbox-id <inbox_id> --display-name "Updated Name"
patch/v0/inboxes/{inbox_id}

Request

  • Base URL
    https://api.agentmail.to
  • URL
    https://api.agentmail.to/v0/inboxes/{inbox_id}
  • Auth
    HTTP bearer

Path parameters

inbox_idstring required

The ID of the inbox.

Request body

display_namestring required

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

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.

updated_atstring date-time required

Time at which inbox was last updated.

created_atstring date-time required

Time at which inbox was created.

Changes

No recorded changes to this operation across all 1 revision of this API.