Skip to main content
PATCH
更新收件箱
更新单个收件箱的 display_namemetadata,地址本身不可改。返回更新后的完整收件箱。写入的是共享 AgentMail 工作区:所有 AIsa 调用方共用同一个 AgentMail 账号,因此这里会触及其他调用方创建的收件箱,你写进去的东西下一个调用方也看得到、改得动。 只读不改用 get_agentmail_inbox

示例

授权

Authorization
string
header
必填

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

请求头

Authorization
string
必填

Bearer 身份验证

路径参数

inbox_id
string
必填

收件箱的 ID。

请求体

application/json

应为对象;请至少提供 display_namemetadata 之一。

display_name
string

显示名称:Display Name <username@domain.com>

metadata
UpdateMetadata · object | null

要合并到收件箱现有元数据中的元数据。你包含的键 将被添加或覆盖;省略的键保持不变。要移除 单个键,请为其发送 null 值。要清除所有元数据,请将 metadata 设为 null。发送空对象将被拒绝;请使用 null 进行清除。每次更新必须至少包含 display_namemetadata 之一。

响应

状态码为 200 的响应

pod_id
string
必填

Pod ID。

inbox_id
string
必填

收件箱的 ID。

email
string
必填

收件箱的电子邮件地址。

updated_at
string<date-time>
必填

收件箱上次更新的时间。

created_at
string<date-time>
必填

收件箱的创建时间。

display_name
string

显示名称:Display Name <username@domain.com>

client_id
string

收件箱的客户端 ID。

metadata
Metadata · object

附加到收件箱的自定义元数据。