跳转到主要内容
PATCH
https://api.aisa.one/apis/v1
/
agentmail
/
inboxes
/
{inbox_id}
更新收件箱
curl --request PATCH \
  --url https://api.aisa.one/apis/v1/agentmail/inboxes/{inbox_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "display_name": "<string>",
  "metadata": {}
}
'
import requests

url = "https://api.aisa.one/apis/v1/agentmail/inboxes/{inbox_id}"

payload = {
"display_name": "<string>",
"metadata": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({display_name: '<string>', metadata: {}})
};

fetch('https://api.aisa.one/apis/v1/agentmail/inboxes/{inbox_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.aisa.one/apis/v1/agentmail/inboxes/{inbox_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'display_name' => '<string>',
'metadata' => [

]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.aisa.one/apis/v1/agentmail/inboxes/{inbox_id}"

payload := strings.NewReader("{\n \"display_name\": \"<string>\",\n \"metadata\": {}\n}")

req, _ := http.NewRequest("PATCH", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.patch("https://api.aisa.one/apis/v1/agentmail/inboxes/{inbox_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"display_name\": \"<string>\",\n \"metadata\": {}\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.aisa.one/apis/v1/agentmail/inboxes/{inbox_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"display_name\": \"<string>\",\n \"metadata\": {}\n}"

response = http.request(request)
puts response.read_body
{
  "pod_id": "<string>",
  "inbox_id": "<string>",
  "email": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "display_name": "<string>",
  "client_id": "<string>",
  "metadata": {}
}
{
"name": "<string>",
"errors": "<unknown>"
}
{
"name": "<string>",
"message": "<string>"
}

授权

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

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