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

# Update pod

> Update a pod's `clientId` or `name`. Only the fields you include are changed.



## OpenAPI

````yaml /api-reference/openapi.json patch /v1/pods/{id}
openapi: 3.0.3
info:
  title: OpenMail API
  description: >-
    Email infrastructure API for AI agents. Create inboxes, send and receive
    email, and get real-time notifications via webhooks.
  version: 1.0.0
  license:
    name: Proprietary
servers:
  - url: https://api.openmail.sh
security:
  - bearerAuth: []
tags:
  - name: pods
    description: Isolated sub-accounts for your end users or tenants
  - name: inboxes
    description: Email inboxes and their webhook configuration
  - name: messages
    description: Sending and listing messages
  - name: threads
    description: Conversation threads and read status
  - name: attachments
    description: Downloading and extracting text from attachments
paths:
  /v1/pods/{id}:
    patch:
      tags:
        - pods
      summary: Update pod
      description: >-
        Update a pod's `clientId` or `name`. Only the fields you include are
        changed.
      operationId: updatePod
      parameters:
        - schema:
            type: string
          in: path
          name: id
          required: true
          description: Pod ID or your own `clientId`
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              properties:
                clientId:
                  type: string
                  maxLength: 255
                  description: Your own identifier for this pod. Set null to clear.
                  nullable: true
                name:
                  type: string
                  maxLength: 255
                  description: Human-readable label. Set null to clear.
                  nullable: true
      responses:
        '200':
          description: Pod updated
          content:
            application/json:
              schema:
                description: Pod updated
                allOf:
                  - $ref: '#/components/schemas/Pod'
        '403':
          description: The authenticating key is pod-scoped and cannot modify pods
          content:
            application/json:
              schema:
                description: The authenticating key is pod-scoped and cannot modify pods
                allOf:
                  - $ref: '#/components/schemas/Error'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                description: Not found
                allOf:
                  - $ref: '#/components/schemas/Error'
        '409':
          description: A pod with the same `clientId` already exists in your account
          content:
            application/json:
              schema:
                description: A pod with the same `clientId` already exists in your account
                allOf:
                  - $ref: '#/components/schemas/Error'
components:
  schemas:
    Pod:
      type: object
      additionalProperties: true
      properties:
        id:
          type: string
          description: OpenMail pod ID
        clientId:
          type: string
          description: Your own identifier for the pod, if set.
          nullable: true
        name:
          type: string
          description: Human-readable label, if set.
          nullable: true
        isDefault:
          type: boolean
          description: >-
            Whether this is the account's default pod. Every account has exactly
            one; it is created automatically and cannot be deleted.
        createdAt:
          type: string
          format: date-time
    Error:
      type: object
      additionalProperties: true
      properties:
        error:
          type: string
        message:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API key

````