agentmail 0.5.3 → 0.5.5

package/dist/llms-full.txt

@@ -538,6 +538,89 @@ don't provide them, AgentMail will generate a unique address for you using our
 default domain. Check out our [guide on managing
 domains](/guides/domains/managing-domains) to learn more.
 
+## Metadata
+
+Attach your own key-value data to any `Inbox` with the `metadata` field. Use it to link an inbox to records in your own system: a user ID, an agent name, or feature flags. Metadata is returned on every inbox response.
+
+Values may be a string, number, or boolean. An `Inbox` can hold up to 256 keys, and each key and string value is limited to 256 characters.
+
+```python title="Python"
+# Attach metadata when creating an inbox; values may be a string, int, float, or boolean
+inbox = client.inboxes.create(
+    username="support-agent",
+    metadata={
+        "tenant_id": "acme",       # string
+        "seat_count": 5,           # int
+        "monthly_spend": 19.99,    # float
+        "active": True,            # boolean
+    },
+)
+
+# Read it back from any inbox response
+print(inbox.metadata)
+```
+
+```typescript title="TypeScript"
+// Attach metadata when creating an inbox; values may be a string, int, float, or boolean
+const inbox = await client.inboxes.create({
+  username: "support-agent",
+  metadata: {
+    tenant_id: "acme", // string
+    seat_count: 5, // int
+    monthly_spend: 19.99, // float
+    active: true, // boolean
+  },
+});
+
+// Read it back from any inbox response
+console.log(inbox.metadata);
+```
+
+### Updating metadata
+
+Updates **merge** into the inbox's existing metadata — keys you include are added or overwritten, and keys you omit are preserved.
+
+To remove a single key, send it with a `null` value. To clear all metadata at
+once, send `metadata` as `null`. Every update must include either
+`display_name` or `metadata`.
+
+```python title="Python"
+# Add or overwrite keys; the keys you omit stay unchanged
+client.inboxes.update(
+    inbox_id="support-agent@agentmail.to",
+    metadata={"tier": "enterprise"},
+)
+
+# Remove a single key
+client.inboxes.update(
+    inbox_id="support-agent@agentmail.to",
+    metadata={"tier": None},
+)
+
+# Clear all metadata
+client.inboxes.update(
+    inbox_id="support-agent@agentmail.to",
+    metadata=None,
+)
+```
+
+```typescript title="TypeScript"
+// Add or overwrite keys; the keys you omit stay unchanged
+await client.inboxes.update("support-agent@agentmail.to", {
+  metadata: { tier: "enterprise" },
+});
+
+// Remove a single key
+await client.inboxes.update("support-agent@agentmail.to", {
+  metadata: { tier: null },
+});
+
+// Clear all metadata
+await client.inboxes.update("support-agent@agentmail.to", {
+  metadata: null,
+});
+```
+
 ## Inbox-scoped API keys
 
 You can create API keys that are restricted to a single inbox. An inbox-scoped key can only access that inbox's threads, messages, and drafts. This is useful when you want to give an agent or integration the minimum access it needs.
@@ -575,10 +658,10 @@ AgentMail Inboxes — copy into Cursor/Claude.
 Setup: pip install agentmail python-dotenv. Set AGENTMAIL_API_KEY in .env.
 
 API reference:
-- inboxes.create(username?, domain?, display_name?, client_id?) — client_id for idempotent retries
+- inboxes.create(username?, domain?, display_name?, client_id?, metadata?) — client_id for idempotent retries; metadata is custom key-value data
 - inboxes.get(inbox_id)
 - inboxes.list(limit?, page_token?)
-- inboxes.update(inbox_id, display_name)
+- inboxes.update(inbox_id, display_name?, metadata?) — at least one field required; metadata is merged, not replaced
 - inboxes.delete(inbox_id)
 - inboxes.api_keys.create(inbox_id, name) — inbox-scoped key
 - inboxes.api_keys.list(inbox_id)
@@ -609,10 +692,10 @@ print(f"Total: {all_inboxes.count}")
  * Setup: npm install agentmail dotenv. Set AGENTMAIL_API_KEY in .env.
  *
  * API reference:
- * - inboxes.create({ username?, domain?, displayName?, clientId? })
+ * - inboxes.create({ username?, domain?, displayName?, clientId?, metadata? }) — metadata is custom key-value data
  * - inboxes.get(inboxId)
  * - inboxes.list({ limit?, pageToken? })
- * - inboxes.update(inboxId, { displayName })
+ * - inboxes.update(inboxId, { displayName?, metadata? }) — at least one field required
  * - inboxes.delete(inboxId)
  * - inboxes.apiKeys.create(inboxId, { name }) — inbox-scoped key
  * - inboxes.apiKeys.list(inboxId)
@@ -5157,8 +5240,6 @@ For more details on scheduled sending—including how to cancel, reschedule, lis
 
 > Configure IMAP and SMTP to access your AgentMail inboxes using email clients or programmatic access.
 
-IMAP support is currently under development and will be available in the coming weeks. The documentation below describes the planned functionality. SMTP is fully available today.
-
 AgentMail supports standard IMAP and SMTP protocols, allowing you to connect using traditional email clients or integrate with existing systems that rely on these protocols.
 
 ## What are IMAP and SMTP?
@@ -5202,9 +5283,15 @@ be rejected. Make sure to enable SSL/TLS in your email client settings.
 | **Password** | Your API key                                    |
 | **SSL/TLS**  | **Required** (must be enabled)                  |
 
-Currently, only the **INBOX** folder is accessible via IMAP. Other folders
-(Sent, Drafts, Trash) are not available through IMAP. Use the [AgentMail
-API](/introduction) for full folder access.
+IMAP exposes the following folders: **INBOX**, **Sent**, **Trash**, and
+**Spam**. A **Drafts** folder is also listed for client compatibility but
+always appears empty — use the [AgentMail API](/introduction) to create
+and manage drafts.
+
+The IMAP server supports the `IDLE` extension (RFC 2177), so modern
+clients (Thunderbird, Outlook, Apple Mail) receive new messages
+push-style without polling. Clients negotiate `IDLE` automatically when
+supported — no extra configuration needed.
 
 ### Python IMAP Example
 
@@ -5224,7 +5311,7 @@ try:
     # Authenticate using inbox email as username
     imap.login(inbox_email, api_key)
 
-    # Select INBOX (only supported folder)
+    # Select a folder (INBOX, Sent, Trash, or Spam)
     imap.select("INBOX")
 
     # Search for all messages
@@ -5278,16 +5365,18 @@ imap.connect();
 
 Use SMTP to send emails from your AgentMail inbox.
 
-SSL/TLS is **required** for all SMTP connections. Connections without SSL will
-be rejected. Make sure to enable SSL/TLS in your email client settings.
+Encryption is **required** for all SMTP connections. Connect using **port 465
+with implicit TLS** (SSL on connect) or **port 587 with STARTTLS** (upgrade
+in-band). On port 587, attempting to authenticate before issuing `STARTTLS`
+is rejected with a `538` error.
 
-| Setting      | Value                          |
-| ------------ | ------------------------------ |
-| **Host**     | `smtp.agentmail.to`            |
-| **Port**     | `465`                          |
-| **Username** | agentmail                      |
-| **Password** | Your API key                   |
-| **SSL/TLS**  | **Required** (must be enabled) |
+| Setting        | Value                                                 |
+| -------------- | ----------------------------------------------------- |
+| **Host**       | `smtp.agentmail.to`                                   |
+| **Port**       | `465` (implicit TLS) or `587` (STARTTLS)              |
+| **Username**   | Your inbox email (e.g., `myinbox@agentmail.to`)       |
+| **Password**   | Your API key                                          |
+| **Encryption** | Port `465`: SSL/TLS on connect · Port `587`: STARTTLS |
 
 The "From" address in your email should match the email address of your inbox
 (e.g., `myinbox@agentmail.to`). Using a different From address may result in
@@ -5318,11 +5407,17 @@ msg["From"] = inbox_email  # Use your inbox email as the From address
 msg["To"] = "recipient@example.com"
 msg.attach(MIMEText("This is a test email sent via SMTP.", "plain"))
 
-# Connect with SSL (required) and send
+# Connect with implicit TLS on port 465 and send
 with smtplib.SMTP_SSL("smtp.agentmail.to", 465) as server:
     server.login(inbox_email, api_key)
     server.send_message(msg)
     print("Email sent successfully!")
+
+# Alternatively, use STARTTLS on port 587:
+#   with smtplib.SMTP("smtp.agentmail.to", 587) as server:
+#       server.starttls()
+#       server.login(inbox_email, api_key)
+#       server.send_message(msg)
 ```
 
 ### TypeScript SMTP Example
@@ -5337,7 +5432,8 @@ const apiKey = process.env.AGENTMAIL_API_KEY!; // From Dashboard → API Keys
 const transporter = nodemailer.createTransport({
   host: "smtp.agentmail.to",
   port: 465,
-  secure: true, // SSL required
+  secure: true, // implicit TLS on port 465
+  // For STARTTLS on port 587 instead, use: port: 587, secure: false
   auth: {
     user: inboxEmail,
     pass: apiKey,
@@ -5359,13 +5455,14 @@ sendEmail().catch(console.error);
 
 ## Troubleshooting
 
-| Error                   | Cause                   | Solution                                               |
-| ----------------------- | ----------------------- | ------------------------------------------------------ |
-| "Authentication failed" | Invalid credentials     | Verify your inbox email and API key from the console   |
-| "Connection refused"    | SSL not enabled         | Enable SSL/TLS in your client settings                 |
-| "Connection timeout"    | Firewall blocking ports | Ensure ports 993 (IMAP) and 465/587 (SMTP) are open    |
-| "Sender not authorized" | Wrong From address      | Use your inbox's email address as the From address     |
-| "Folder not found"      | Non-INBOX folder        | Only INBOX is supported; use the API for other folders |
+| Error                                       | Cause                                  | Solution                                                                                                                                              |
+| ------------------------------------------- | -------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
+| "Authentication failed"                     | Invalid credentials                    | Verify your inbox email and API key from the console                                                                                                  |
+| "Connection refused" / handshake error      | Wrong encryption mode for the port     | Use SSL/TLS on connect for port `465`, or STARTTLS for port `587`                                                                                     |
+| `538` "Must issue a STARTTLS command first" | Plaintext AUTH on port `587`           | Enable STARTTLS on port `587` (or use implicit TLS on `465`) before authenticating                                                                    |
+| "Connection timeout"                        | Firewall blocking ports                | Ensure ports 993 (IMAP) and 465/587 (SMTP) are open                                                                                                   |
+| "Sender not authorized"                     | Wrong From address                     | Use your inbox's email address as the From address                                                                                                    |
+| "Folder not found"                          | Folder name typo or unsupported folder | IMAP exposes `INBOX`, `Sent`, `Trash`, and `Spam`. Folder names other than `INBOX` are case-sensitive. Use the [API](/introduction) to manage drafts. |
 
 ## When to Use IMAP/SMTP vs API
 
@@ -11984,7 +12081,7 @@ Verify an agent organization using the 6-digit OTP sent to the human's email dur
 
 On success, the organization is upgraded from `agent_unverified` to `agent_verified`, the send allowlist is removed, and free plan entitlements are applied.
 
-The OTP expires after 24 hours and allows a maximum of 10 attempts.
+The OTP expires after 24 hours and allows a maximum of 10 attempts. If you run into any difficulties receiving the OTP code, you can also create an account on [console.agentmail.to](https://console.agentmail.to) using the human email address you provided to verify your account.
 
 **CLI:**
 ```bash
@@ -12015,7 +12112,11 @@ paths:
         entitlements are applied.
 
 
-        The OTP expires after 24 hours and allows a maximum of 10 attempts.
+        The OTP expires after 24 hours and allows a maximum of 10 attempts. If
+        you run into any difficulties receiving the OTP code, you can also
+        create an account on
+        [console.agentmail.to](https://console.agentmail.to) using the human
+        email address you provided to verify your account.
 
 
         **CLI:**
@@ -12334,6 +12435,22 @@ components:
       type: string
       description: Client ID of inbox.
       title: ClientId
+    type_inboxes:MetadataValue:
+      oneOf:
+        - type: string
+        - type: number
+          format: double
+        - type: boolean
+      description: A metadata value. May be a string, number, or boolean.
+      title: MetadataValue
+    type_inboxes:Metadata:
+      type: object
+      additionalProperties:
+        $ref: '#/components/schemas/type_inboxes:MetadataValue'
+      description: |-
+        Custom key-value pairs attached to the inbox. Up to 256 keys. Keys and
+        string values are each limited to 256 characters.
+      title: Metadata
     type_inboxes:Inbox:
       type: object
       properties:
@@ -12347,6 +12464,9 @@ components:
           $ref: '#/components/schemas/type_inboxes:DisplayName'
         client_id:
           $ref: '#/components/schemas/type_inboxes:ClientId'
+        metadata:
+          $ref: '#/components/schemas/type_inboxes:Metadata'
+          description: Custom metadata attached to the inbox.
         updated_at:
           type: string
           format: date-time
@@ -12596,6 +12716,22 @@ components:
       type: string
       description: Client ID of inbox.
       title: ClientId
+    type_inboxes:MetadataValue:
+      oneOf:
+        - type: string
+        - type: number
+          format: double
+        - type: boolean
+      description: A metadata value. May be a string, number, or boolean.
+      title: MetadataValue
+    type_inboxes:Metadata:
+      type: object
+      additionalProperties:
+        $ref: '#/components/schemas/type_inboxes:MetadataValue'
+      description: |-
+        Custom key-value pairs attached to the inbox. Up to 256 keys. Keys and
+        string values are each limited to 256 characters.
+      title: Metadata
     type_inboxes:Inbox:
       type: object
       properties:
@@ -12609,6 +12745,9 @@ components:
           $ref: '#/components/schemas/type_inboxes:DisplayName'
         client_id:
           $ref: '#/components/schemas/type_inboxes:ClientId'
+        metadata:
+          $ref: '#/components/schemas/type_inboxes:Metadata'
+          description: Custom metadata attached to the inbox.
         updated_at:
           type: string
           format: date-time
@@ -12854,6 +12993,22 @@ components:
       type: string
       description: Client ID of inbox.
       title: ClientId
+    type_inboxes:MetadataValue:
+      oneOf:
+        - type: string
+        - type: number
+          format: double
+        - type: boolean
+      description: A metadata value. May be a string, number, or boolean.
+      title: MetadataValue
+    type_inboxes:Metadata:
+      type: object
+      additionalProperties:
+        $ref: '#/components/schemas/type_inboxes:MetadataValue'
+      description: |-
+        Custom key-value pairs attached to the inbox. Up to 256 keys. Keys and
+        string values are each limited to 256 characters.
+      title: Metadata
     type_inboxes:CreateInboxRequest:
       type: object
       properties:
@@ -12869,6 +13024,9 @@ components:
           $ref: '#/components/schemas/type_inboxes:DisplayName'
         client_id:
           $ref: '#/components/schemas/type_inboxes:ClientId'
+        metadata:
+          $ref: '#/components/schemas/type_inboxes:Metadata'
+          description: Custom metadata to attach to the inbox.
       title: CreateInboxRequest
     type_pods:PodId:
       type: string
@@ -12895,6 +13053,9 @@ components:
           $ref: '#/components/schemas/type_inboxes:DisplayName'
         client_id:
           $ref: '#/components/schemas/type_inboxes:ClientId'
+        metadata:
+          $ref: '#/components/schemas/type_inboxes:Metadata'
+          description: Custom metadata attached to the inbox.
         updated_at:
           type: string
           format: date-time
@@ -13121,6 +13282,12 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/type_inboxes:Inbox'
+        '400':
+          description: Error response with status 400
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/type_:ValidationErrorResponse'
         '404':
           description: Error response with status 404
           content:
@@ -13147,13 +13314,40 @@ components:
       type: string
       description: 'Display name: `Display Name <username@domain.com>`.'
       title: DisplayName
+    type_inboxes:MetadataValue:
+      oneOf:
+        - type: string
+        - type: number
+          format: double
+        - type: boolean
+      description: A metadata value. May be a string, number, or boolean.
+      title: MetadataValue
+    type_inboxes:Metadata:
+      type: object
+      additionalProperties:
+        $ref: '#/components/schemas/type_inboxes:MetadataValue'
+      description: |-
+        Custom key-value pairs attached to the inbox. Up to 256 keys. Keys and
+        string values are each limited to 256 characters.
+      title: Metadata
     type_inboxes:UpdateInboxRequest:
       type: object
       properties:
         display_name:
           $ref: '#/components/schemas/type_inboxes:DisplayName'
-      required:
-        - display_name
+        metadata:
+          $ref: '#/components/schemas/type_inboxes:Metadata'
+          description: >-
+            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. Provide at least one of `display_name` or
+            `metadata`.
       title: UpdateInboxRequest
     type_pods:PodId:
       type: string
@@ -13180,6 +13374,9 @@ components:
           $ref: '#/components/schemas/type_inboxes:DisplayName'
         client_id:
           $ref: '#/components/schemas/type_inboxes:ClientId'
+        metadata:
+          $ref: '#/components/schemas/type_inboxes:Metadata'
+          description: Custom metadata attached to the inbox.
         updated_at:
           type: string
           format: date-time
@@ -13214,6 +13411,17 @@ components:
         - name
         - message
       title: ErrorResponse
+    type_:ValidationErrorResponse:
+      type: object
+      properties:
+        name:
+          $ref: '#/components/schemas/type_:ErrorName'
+        errors:
+          description: Validation errors.
+      required:
+        - name
+        - errors
+      title: ValidationErrorResponse
   securitySchemes:
     Bearer:
       type: http
@@ -13230,9 +13438,7 @@ async function main() {
     const client = new AgentMailClient({
         apiKey: "YOUR_TOKEN_HERE",
     });
-    await client.inboxes.update("inbox_id", {
-        displayName: "display_name",
-    });
+    await client.inboxes.update("inbox_id", {});
 }
 main();
 
@@ -13247,7 +13453,6 @@ client = AgentMail(
 
 client.inboxes.update(
     inbox_id="inbox_id",
-    display_name="display_name",
 )
 
 ```
@@ -13266,7 +13471,7 @@ func main() {
 
 	url := "https://api.agentmail.to/v0/inboxes/inbox_id"
 
-	payload := strings.NewReader("{\n  \"display_name\": \"display_name\"\n}")
+	payload := strings.NewReader("{}")
 
 	req, _ := http.NewRequest("PATCH", url, payload)
 
@@ -13296,7 +13501,7 @@ http.use_ssl = true
 request = Net::HTTP::Patch.new(url)
 request["Authorization"] = 'Bearer <api_key>'
 request["Content-Type"] = 'application/json'
-request.body = "{\n  \"display_name\": \"display_name\"\n}"
+request.body = "{}"
 
 response = http.request(request)
 puts response.read_body
@@ -13309,7 +13514,7 @@ import com.mashape.unirest.http.Unirest;
 HttpResponse<String> response = Unirest.patch("https://api.agentmail.to/v0/inboxes/inbox_id")
   .header("Authorization", "Bearer <api_key>")
   .header("Content-Type", "application/json")
-  .body("{\n  \"display_name\": \"display_name\"\n}")
+  .body("{}")
   .asString();
 ```
 
@@ -13320,9 +13525,7 @@ require_once('vendor/autoload.php');
 $client = new \GuzzleHttp\Client();
 
 $response = $client->request('PATCH', 'https://api.agentmail.to/v0/inboxes/inbox_id', [
-  'body' => '{
-  "display_name": "display_name"
-}',
+  'body' => '{}',
   'headers' => [
     'Authorization' => 'Bearer <api_key>',
     'Content-Type' => 'application/json',
@@ -13339,7 +13542,7 @@ var client = new RestClient("https://api.agentmail.to/v0/inboxes/inbox_id");
 var request = new RestRequest(Method.PATCH);
 request.AddHeader("Authorization", "Bearer <api_key>");
 request.AddHeader("Content-Type", "application/json");
-request.AddParameter("application/json", "{\n  \"display_name\": \"display_name\"\n}", ParameterType.RequestBody);
+request.AddParameter("application/json", "{}", ParameterType.RequestBody);
 IRestResponse response = client.Execute(request);
 ```
 
@@ -13350,7 +13553,7 @@ let headers = [
   "Authorization": "Bearer <api_key>",
   "Content-Type": "application/json"
 ]
-let parameters = ["display_name": "display_name"] as [String : Any]
+let parameters = [] as [String : Any]
 
 let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
 
@@ -22561,6 +22764,9 @@ components:
           type: string
           format: date-time
           description: Time at which entry was created.
+        read_only:
+          type: boolean
+          description: Whether the entry is read-only and cannot be deleted via the API.
         pod_id:
           type: string
           description: ID of pod.
@@ -22865,6 +23071,9 @@ components:
           type: string
           format: date-time
           description: Time at which entry was created.
+        read_only:
+          type: boolean
+          description: Whether the entry is read-only and cannot be deleted via the API.
         pod_id:
           type: string
           description: ID of pod.
@@ -23183,6 +23392,9 @@ components:
           type: string
           format: date-time
           description: Time at which entry was created.
+        read_only:
+          type: boolean
+          description: Whether the entry is read-only and cannot be deleted via the API.
         pod_id:
           type: string
           description: ID of pod.
@@ -34327,6 +34539,9 @@ components:
           type: string
           format: date-time
           description: Time at which entry was created.
+        read_only:
+          type: boolean
+          description: Whether the entry is read-only and cannot be deleted via the API.
       required:
         - entry
         - organization_id
@@ -34614,6 +34829,9 @@ components:
           type: string
           format: date-time
           description: Time at which entry was created.
+        read_only:
+          type: boolean
+          description: Whether the entry is read-only and cannot be deleted via the API.
       required:
         - entry
         - organization_id
@@ -34915,6 +35133,9 @@ components:
           type: string
           format: date-time
           description: Time at which entry was created.
+        read_only:
+          type: boolean
+          description: Whether the entry is read-only and cannot be deleted via the API.
       required:
         - entry
         - organization_id
@@ -37775,6 +37996,22 @@ components:
       type: string
       description: Client ID of inbox.
       title: ClientId
+    type_inboxes:MetadataValue:
+      oneOf:
+        - type: string
+        - type: number
+          format: double
+        - type: boolean
+      description: A metadata value. May be a string, number, or boolean.
+      title: MetadataValue
+    type_inboxes:Metadata:
+      type: object
+      additionalProperties:
+        $ref: '#/components/schemas/type_inboxes:MetadataValue'
+      description: |-
+        Custom key-value pairs attached to the inbox. Up to 256 keys. Keys and
+        string values are each limited to 256 characters.
+      title: Metadata
     type_inboxes:Inbox:
       type: object
       properties:
@@ -37788,6 +38025,9 @@ components:
           $ref: '#/components/schemas/type_inboxes:DisplayName'
         client_id:
           $ref: '#/components/schemas/type_inboxes:ClientId'
+        metadata:
+          $ref: '#/components/schemas/type_inboxes:Metadata'
+          description: Custom metadata attached to the inbox.
         updated_at:
           type: string
           format: date-time
@@ -38063,6 +38303,22 @@ components:
       type: string
       description: Client ID of inbox.
       title: ClientId
+    type_inboxes:MetadataValue:
+      oneOf:
+        - type: string
+        - type: number
+          format: double
+        - type: boolean
+      description: A metadata value. May be a string, number, or boolean.
+      title: MetadataValue
+    type_inboxes:Metadata:
+      type: object
+      additionalProperties:
+        $ref: '#/components/schemas/type_inboxes:MetadataValue'
+      description: |-
+        Custom key-value pairs attached to the inbox. Up to 256 keys. Keys and
+        string values are each limited to 256 characters.
+      title: Metadata
     type_inboxes:Inbox:
       type: object
       properties:
@@ -38076,6 +38332,9 @@ components:
           $ref: '#/components/schemas/type_inboxes:DisplayName'
         client_id:
           $ref: '#/components/schemas/type_inboxes:ClientId'
+        metadata:
+          $ref: '#/components/schemas/type_inboxes:Metadata'
+          description: Custom metadata attached to the inbox.
         updated_at:
           type: string
           format: date-time
@@ -38331,6 +38590,22 @@ components:
       type: string
       description: Client ID of inbox.
       title: ClientId
+    type_inboxes:MetadataValue:
+      oneOf:
+        - type: string
+        - type: number
+          format: double
+        - type: boolean
+      description: A metadata value. May be a string, number, or boolean.
+      title: MetadataValue
+    type_inboxes:Metadata:
+      type: object
+      additionalProperties:
+        $ref: '#/components/schemas/type_inboxes:MetadataValue'
+      description: |-
+        Custom key-value pairs attached to the inbox. Up to 256 keys. Keys and
+        string values are each limited to 256 characters.
+      title: Metadata
     type_inboxes:CreateInboxRequest:
       type: object
       properties:
@@ -38346,6 +38621,9 @@ components:
           $ref: '#/components/schemas/type_inboxes:DisplayName'
         client_id:
           $ref: '#/components/schemas/type_inboxes:ClientId'
+        metadata:
+          $ref: '#/components/schemas/type_inboxes:Metadata'
+          description: Custom metadata to attach to the inbox.
       title: CreateInboxRequest
     type_inboxes:InboxId:
       type: string
@@ -38368,6 +38646,9 @@ components:
           $ref: '#/components/schemas/type_inboxes:DisplayName'
         client_id:
           $ref: '#/components/schemas/type_inboxes:ClientId'
+        metadata:
+          $ref: '#/components/schemas/type_inboxes:Metadata'
+          description: Custom metadata attached to the inbox.
         updated_at:
           type: string
           format: date-time
@@ -38638,13 +38919,40 @@ components:
       type: string
       description: 'Display name: `Display Name <username@domain.com>`.'
       title: DisplayName
+    type_inboxes:MetadataValue:
+      oneOf:
+        - type: string
+        - type: number
+          format: double
+        - type: boolean
+      description: A metadata value. May be a string, number, or boolean.
+      title: MetadataValue
+    type_inboxes:Metadata:
+      type: object
+      additionalProperties:
+        $ref: '#/components/schemas/type_inboxes:MetadataValue'
+      description: |-
+        Custom key-value pairs attached to the inbox. Up to 256 keys. Keys and
+        string values are each limited to 256 characters.
+      title: Metadata
     type_inboxes:UpdateInboxRequest:
       type: object
       properties:
         display_name:
           $ref: '#/components/schemas/type_inboxes:DisplayName'
-      required:
-        - display_name
+        metadata:
+          $ref: '#/components/schemas/type_inboxes:Metadata'
+          description: >-
+            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. Provide at least one of `display_name` or
+            `metadata`.
       title: UpdateInboxRequest
     type_inboxes:Email:
       type: string
@@ -38667,6 +38975,9 @@ components:
           $ref: '#/components/schemas/type_inboxes:DisplayName'
         client_id:
           $ref: '#/components/schemas/type_inboxes:ClientId'
+        metadata:
+          $ref: '#/components/schemas/type_inboxes:Metadata'
+          description: Custom metadata attached to the inbox.
         updated_at:
           type: string
           format: date-time
@@ -38717,9 +39028,7 @@ async function main() {
     const client = new AgentMailClient({
         apiKey: "YOUR_TOKEN_HERE",
     });
-    await client.pods.inboxes.update("pod_id", "inbox_id", {
-        displayName: "display_name",
-    });
+    await client.pods.inboxes.update("pod_id", "inbox_id", {});
 }
 main();
 
@@ -38735,7 +39044,6 @@ client = AgentMail(
 client.pods.inboxes.update(
     pod_id="pod_id",
     inbox_id="inbox_id",
-    display_name="display_name",
 )
 
 ```
@@ -38754,7 +39062,7 @@ func main() {
 
 	url := "https://api.agentmail.to/v0/pods/pod_id/inboxes/inbox_id"
 
-	payload := strings.NewReader("{\n  \"display_name\": \"display_name\"\n}")
+	payload := strings.NewReader("{}")
 
 	req, _ := http.NewRequest("PATCH", url, payload)
 
@@ -38784,7 +39092,7 @@ http.use_ssl = true
 request = Net::HTTP::Patch.new(url)
 request["Authorization"] = 'Bearer <api_key>'
 request["Content-Type"] = 'application/json'
-request.body = "{\n  \"display_name\": \"display_name\"\n}"
+request.body = "{}"
 
 response = http.request(request)
 puts response.read_body
@@ -38797,7 +39105,7 @@ import com.mashape.unirest.http.Unirest;
 HttpResponse<String> response = Unirest.patch("https://api.agentmail.to/v0/pods/pod_id/inboxes/inbox_id")
   .header("Authorization", "Bearer <api_key>")
   .header("Content-Type", "application/json")
-  .body("{\n  \"display_name\": \"display_name\"\n}")
+  .body("{}")
   .asString();
 ```
 
@@ -38808,9 +39116,7 @@ require_once('vendor/autoload.php');
 $client = new \GuzzleHttp\Client();
 
 $response = $client->request('PATCH', 'https://api.agentmail.to/v0/pods/pod_id/inboxes/inbox_id', [
-  'body' => '{
-  "display_name": "display_name"
-}',
+  'body' => '{}',
   'headers' => [
     'Authorization' => 'Bearer <api_key>',
     'Content-Type' => 'application/json',
@@ -38827,7 +39133,7 @@ var client = new RestClient("https://api.agentmail.to/v0/pods/pod_id/inboxes/inb
 var request = new RestRequest(Method.PATCH);
 request.AddHeader("Authorization", "Bearer <api_key>");
 request.AddHeader("Content-Type", "application/json");
-request.AddParameter("application/json", "{\n  \"display_name\": \"display_name\"\n}", ParameterType.RequestBody);
+request.AddParameter("application/json", "{}", ParameterType.RequestBody);
 IRestResponse response = client.Execute(request);
 ```
 
@@ -38838,7 +39144,7 @@ let headers = [
   "Authorization": "Bearer <api_key>",
   "Content-Type": "application/json"
 ]
-let parameters = ["display_name": "display_name"] as [String : Any]
+let parameters = [] as [String : Any]
 
 let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
 
@@ -44405,6 +44711,9 @@ components:
           type: string
           format: date-time
           description: Time at which entry was created.
+        read_only:
+          type: boolean
+          description: Whether the entry is read-only and cannot be deleted via the API.
         pod_id:
           type: string
           description: ID of pod.
@@ -44709,6 +45018,9 @@ components:
           type: string
           format: date-time
           description: Time at which entry was created.
+        read_only:
+          type: boolean
+          description: Whether the entry is read-only and cannot be deleted via the API.
         pod_id:
           type: string
           description: ID of pod.
@@ -45027,6 +45339,9 @@ components:
           type: string
           format: date-time
           description: Time at which entry was created.
+        read_only:
+          type: boolean
+          description: Whether the entry is read-only and cannot be deleted via the API.
         pod_id:
           type: string
           description: ID of pod.