Manage Inbox
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{
"created_at": "2023-11-07T05:31:56Z",
"email": "<string>",
"inbox_id": "<string>",
"pod_id": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"client_id": "<string>",
"display_name": "<string>",
"metadata": {},
"status": "active"
}Inboxes Resource
Manage Inbox
Updates one inbox’s display_name and metadata; the address itself cannot change.
PATCH
https://api.aisa.one
/
apis
/
v1
/
agentmail
/
inboxes
/
{inbox_id}
Manage Inbox
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{
"created_at": "2023-11-07T05:31:56Z",
"email": "<string>",
"inbox_id": "<string>",
"pod_id": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"client_id": "<string>",
"display_name": "<string>",
"metadata": {},
"status": "active"
}Updates one inbox’s
Set this endpoint up in your agent →
display_name and metadata; the address itself cannot change. Returns the full inbox after the update. Writes to the shared AgentMail workspace: Every AIsa caller shares one AgentMail account, so this reaches inboxes other callers created, and what you write here is visible and editable by the next caller. To read without changing anything use get_agentmail_inbox.
Example
curl -X PATCH "https://api.aisa.one/apis/v1/agentmail/inboxes/{inbox_id}" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY"
// Copy this whole block into Claude Code, Codex, Cursor or any coding agent.
// It carries everything needed to connect, authorize and run this example —
// no key to paste, one click of Allow in the browser.
{
"calls": [
{
"call_id": "1",
"tool": "patch_agentmail_inbox",
"arguments": {}
}
]
}
// ── for the agent ─────────────────────────────────────────────────────────
// Register the AIsa MCP server, then call its `batch_quote` tool with the JSON above.
// name aisa
// endpoint https://mcp.aisa.one/mcp
// transport streamable-http
// auth OAuth. The server publishes RFC 9728 metadata, so open a
// browser and the user clicks Allow once — nothing to paste.
// If AISA_API_KEY is set, send it as a bearer header instead.
// Use your own MCP mechanism, not a hand-edited config file:
// Codex codex mcp add aisa --url https://mcp.aisa.one/mcp
// Claude Code claude mcp add --transport http -s user aisa https://mcp.aisa.one/mcp
// Cursor / VS Code a "url" entry for https://mcp.aisa.one/mcp in the MCP config
// The server reaches https://mcp.aisa.one/servers worth of APIs through a few meta
// tools: search, list_categories, get_details, batch_quote, batch_use.
// search, get_details and batch_quote are free; batch_use is billed per
// call. This operation's full contract — every argument, the response
// shape, the price and the pitfalls — is at
// https://aisa.one/docs/api-reference/agentmail/patch_agentmail-inboxes-inbox-id.md
// Show me the quoted cost. Once I approve, run the same calls with
// batch_use and show me the result.
First time? Point any MCP client at
https://mcp.aisa.one/mcp — Claude
Code, Codex, Cursor, VS Code and the rest. Authorization is OAuth: the client
opens a browser, you click Allow once, and there is no key to paste. Your
agent then reaches every endpoint through a few meta tools: search,
list_categories, get_details and batch_quote are free, batch_use is
billed per call. Setup per client is in
Connect via MCP; the live tool list and what each call
costs are on aisa.one/mcp.Request contract
- Method and path: PATCH /apis/v1/agentmail/inboxes/{inbox_id}
- Availability: enabled
- Request URL template: https://api.aisa.one/apis/v1/agentmail/inboxes/{inbox_id}
- inbox_id: path; required
- Runtime facts: 18a04e28941fae19674c11246b677373368b6bd927b7c146220cec1f168f4639
{
"operationId": "patch_agentmail_inbox",
"method": "PATCH",
"path": "/apis/v1/agentmail/inboxes/{inbox_id}",
"servers": [
{
"url": "https://api.aisa.one"
}
],
"parameters": [
{
"in": "path",
"name": "inbox_id",
"required": true,
"schema": {
"description": "The ID of the inbox.",
"title": "InboxId",
"type": "string"
}
}
],
"security": [
{
"bearerAuth": []
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"properties": {
"display_name": {
"description": "Display name: `Display Name <username@domain.com>`.",
"title": "DisplayName",
"type": "string"
},
"metadata": {
"description": "Metadata to merge into the inbox's existing metadata. Keys you include\nare added or overwritten; keys you omit are left unchanged. To remove a\nsingle key, send it with a null value. To clear all metadata, send\n`metadata` as null. Sending an empty object is rejected; use null to\nclear. Each update must include at least one of `display_name`,\n`status`, or `metadata`.",
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"description": "A metadata value. May be a string, number, or boolean.",
"oneOf": [
{
"type": "string"
},
{
"format": "double",
"type": "number"
},
{
"type": "boolean"
}
],
"title": "MetadataValue"
},
{
"type": "null"
}
]
},
"description": "Custom key-value pairs to merge into the inbox's existing metadata. A\nvalue may be a string, number, boolean, or null. Setting a key to null\nremoves it. Up to 256 keys; keys and string values are each limited to\n256 characters.",
"title": "UpdateMetadata",
"type": "object"
},
{
"type": "null"
}
]
},
"status": {
"description": "`paused` stops the inbox sending and receiving mail; `active` resumes\nit. Mail that arrived while the inbox was paused is not delivered on\nresume.",
"enum": [
"active",
"paused"
],
"title": "InboxStatus",
"type": "string"
}
},
"title": "UpdateInboxRequest",
"type": "object"
}
}
},
"description": "Expects an object; provide at least one of `display_name`, `status`, or `metadata`."
},
"x-aisa-status": "enabled",
"x-aisa-pricing": {
"cost_contract": "explicit_zero",
"customer_pricing": "fixed_success",
"default_request_estimate_usd": 0.012,
"estimate_source": "profile_seed",
"evidence_source": "request_snapshot"
},
"components": {
"securitySchemes": {
"bearerAuth": {
"scheme": "bearer",
"type": "http"
}
}
}
}
Cost and request rules
Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. Published reference values are not an account-specific quote or a settled charge. For endpoints supporting X-AISA-Cost-Mode: quote, obtain a free quote for your exact request before execution; reconcile the settled cost with response metadata and Usage Logs. USD amounts use 1,000,000 integer micro-USD per dollar.- Default request reference estimate (USD): 0.012
- Cost contract: explicit_zero
- Settlement evidence source: request_snapshot
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The ID of the inbox.
Body
application/json
Expects an object; provide at least one of display_name, status, or metadata.
Display name: Display Name <username@domain.com>.
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. Sending an empty object is rejected; use null to
clear. Each update must include at least one of display_name,
status, or metadata.
Show child attributes
Show child attributes
paused stops the inbox sending and receiving mail; active resumes
it. Mail that arrived while the inbox was paused is not delivered on
resume.
Available options:
active, paused Response
Response with status 200
Time at which inbox was created.
Email address of the inbox.
The ID of the inbox.
ID of pod.
Time at which inbox was last updated.
Client ID of inbox.
Display name: Display Name <username@domain.com>.
Custom metadata attached to the inbox.
Show child attributes
Show child attributes
paused when the inbox is paused. Omitted when the inbox is active.
Treat any value other than paused as an inbox that sends and
receives normally.
Available options:
active, paused