> ## Documentation Index
> Fetch the complete documentation index at: https://docs.useanima.sh/llms.txt
> Use this file to discover all available pages before exploring further.

# Patch inboxes



## OpenAPI

````yaml /openapi.json patch /inboxes/{id}
openapi: 3.1.1
info:
  title: Anima API
  version: 0.1.0
  description: >-
    The Anima API provides programmatic access to unified infrastructure for AI
    agents: create and manage agents; send and receive email; place phone calls
    and send/receive SMS and voice; store and retrieve vault credentials; manage
    agent identity; and configure webhooks for real-time events. Authenticate
    using a Bearer token or an API key passed via the X-API-Key header.
  contact:
    name: Anima Labs
    url: https://useanima.sh
    email: support@useanima.sh
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
servers:
  - url: https://api.useanima.sh/v1
    description: Production
security:
  - BearerAuth: []
  - ApiKeyAuth: []
tags:
  - name: Agents
    description: Create and manage AI agents with email and phone capabilities
  - name: Inboxes
    description: Manage email inboxes and their configurations
  - name: Messages
    description: Send, receive, and search email messages
  - name: Webhooks
    description: Register and manage webhook subscriptions for real-time events
  - name: Organizations
    description: Manage organizations and team settings
  - name: Domains
    description: Configure and verify custom email domains
  - name: Phone
    description: Manage phone numbers and SMS/voice capabilities
  - name: Invoices
    description: Track invoices, match receipts, and reconcile payments
  - name: Billing
    description: View usage, tiers, and billing information
  - name: Security
    description: Configure security policies and access controls
  - name: Vault
    description: Store and retrieve encrypted secrets
  - name: API Keys
    description: Create and manage API keys for programmatic access
paths:
  /inboxes/{id}:
    patch:
      operationId: inbox.update
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
            description: Unique inbox identifier
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                displayName:
                  anyOf:
                    - type: string
                      maxLength: 128
                    - type: 'null'
                  description: Updated human-readable display name (set to null to clear)
                agentId:
                  anyOf:
                    - type: string
                      pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
                    - type: 'null'
                  description: Updated agent association (set to null to unlink)
              required: []
              description: Request body for updating an existing inbox
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
                    description: Unique identifier of the inbox
                  email:
                    type: string
                    format: email
                    description: Full email address of the inbox
                  domain:
                    type: string
                    description: Domain portion of the inbox email address
                  localPart:
                    type: string
                    description: Local part (before the @) of the inbox email address
                  displayName:
                    anyOf:
                      - type: string
                      - type: 'null'
                    description: Human-readable display name, or null if not set
                  agentId:
                    anyOf:
                      - type: string
                        pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
                      - type: 'null'
                    description: ID of the associated agent, or null if unassigned
                  createdAt:
                    type: string
                    format: date-time
                    description: Timestamp when the inbox was created
                required:
                  - id
                  - email
                  - domain
                  - localPart
                  - displayName
                  - agentId
                  - createdAt
                description: Inbox resource representation
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        JWT Bearer token obtained from authentication. Pass as: Authorization:
        Bearer <token>
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: 'API key for programmatic access. Pass as: X-API-Key: <your-key>'

````