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

# Update mailbox display name or password

> Update the display name and/or set a new password for an owned mailbox. The email address is unchanged. Password changes revoke the previous credential and require mailboxes:write and mailboxes:credentials:write permissions. Omit password to keep it unchanged. Passwords must contain 8–128 characters without whitespace or control characters. The response never includes the password.



## OpenAPI

````yaml /customer-openapi.json patch /mailboxes/{id}
openapi: 3.1.0
info:
  title: WazobiaMail API
  version: 1.0.0
  description: >-
    Customer-facing WazobiaMail API. Base URL
    https://app.wazobiamail.com/api/v1. Every response uses the {success,
    message, data} envelope. This specification covers the integration API:
    API-key and public operations. Sign-in, registration, password reset and
    account settings are supported in the app and are not listed here, although
    a dashboard key can call the account operations. The dashboard key carries
    wildcard permissions; the scoped sending key documented below can only send.
    Customer responses omit internal email providers, tenant/queue routing, raw
    upstream payloads and stored service credentials. See /guides/api-responses
    for the response contract and migration guidance. Download the OpenAPI
    specification at https://wazobiamail.com/openapi.json. API-owned JSON
    response field names use camelCase, including pagination; user-defined data
    and third-party protocol payloads retain their own keys.
  contact:
    name: WazobiaMail Support
    url: https://wazobiamail.com/contact
servers:
  - url: https://app.wazobiamail.com/api/v1
security:
  - apiKey: []
tags:
  - name: Account
    description: >-
      Profile, password, two-factor, notifications and account data. Account
      status, plan, units and health.
  - name: Sending
    description: Sending API keys, messages, domains, SMTP access and engagement.
  - name: Mailboxes
    description: Hosted mailboxes and their credentials.
  - name: Relays
    description: Customer SMTP relay configurations.
  - name: Billing
    description: Plans, subscriptions, invoices, payments and email credits.
  - name: Plans
    description: >-
      Plan catalogue entitlements and the effective limits of the current
      account's plan.
  - name: Support
    description: Support tickets.
paths:
  /mailboxes/{id}:
    patch:
      tags:
        - Mailboxes
      summary: Update mailbox display name or password
      description: >-
        Update the display name and/or set a new password for an owned mailbox.
        The email address is unchanged. Password changes revoke the previous
        credential and require mailboxes:write and mailboxes:credentials:write
        permissions. Omit password to keep it unchanged. Passwords must contain
        8–128 characters without whitespace or control characters. The response
        never includes the password.
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              minProperties: 1
              properties:
                displayName:
                  type: string
                  minLength: 1
                  maxLength: 160
                  example: Example Support
                password:
                  type: string
                  format: password
                  minLength: 8
                  maxLength: 128
                  example: CorrectHorse!Battery9Staple
      responses:
        '200':
          description: Mailbox updated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Envelope'
        '400':
          description: Invalid update.
        '401':
          description: Unauthorized.
        '403':
          description: Missing permission.
        '404':
          description: Mailbox not found for this account.
        '422':
          description: Invalid field length.
      security:
        - apiKey: []
components:
  schemas:
    Envelope:
      type: object
      required:
        - success
        - message
        - data
      properties:
        success:
          type: boolean
          example: true
        message:
          type: string
          example: Done
        data:
          description: Payload; shape depends on the endpoint.
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: >-
        Dashboard API key created at
        https://app.wazobiamail.com/dashboard/smtp-api. Send operations also
        accept a narrower sending key created through POST /sending/api-keys;
        every other operation needs the dashboard key.
      x-default: YOUR_API_KEY

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.