Update 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

{
  "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>"
}

PATCH

https://api.aisa.one/apis/v1

agentmail

inboxes

{inbox_id}

Update 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

{
  "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>"
}

Updates one inbox’s 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.
{
  "operation_id": "patch_agentmail_inbox",
  "arguments": {},
  "max_price_usd": 0.05
}
// ── for the agent ─────────────────────────────────────────────────────────
// Register the AIsa MCP server, then call its `use` 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 lists five tools over https://mcp.aisa.one/servers worth of APIs:
// search, get_details, use, batch_use, list_categories. search and
// get_details are free; use is billed per call and max_price_usd refuses
// anything above the cap before spending. 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
// Then run the call 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. The commands per client, and what each call costs, are on aisa.one/mcp.

Set this endpoint up in your agent →

Authorizations

Authorization

string

header

required

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

Headers

Authorization

string

required

Bearer authentication

Path Parameters

inbox_id

string

required

The ID of the inbox.

Body

application/json

Expects an object; provide at least one of display_name or metadata.

display_name

string

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

metadata

UpdateMetadata · object | null

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 or metadata.

Show child attributes

Response

Response with status 200

pod_id

string

required

ID of pod.

inbox_id

string

required

The ID of the inbox.

string

required

Email address of the inbox.

updated_at

string<date-time>

required

Time at which inbox was last updated.

created_at

string<date-time>

required

Time at which inbox was created.

display_name

string

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

client_id

string

Client ID of inbox.

metadata

Metadata · object

Custom metadata attached to the inbox.

Show child attributes

Overview

Chat API

Embeddings & Rerank

Search API

Perplexity API

Financial API

Twitter API

Reddit API

Instagram API

Pinterest API

Scholar API

WaveInflu API

Prediction Market API

CoinGecko

DataForSEO

AgentMail

Apollo

Ahrefs API

Semrush API

Foreplay API

CNPJá API

Open-Meteo API

SimilarWeb API

Essentials

TikHub API

Update Inbox

Example

Authorizations

Headers

Path Parameters

Body

Response

​Example

Authorizations

Headers

Path Parameters

Body

Response

Example