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

# Save a plus alias shortcut

> Requires mailbox settings administration permission. Saving is optional for delivery; aliases share the parent mailbox's permissions and limits.



## OpenAPI

````yaml /openapi/openapi.json post /api/v1/mailboxes/{mailboxId}/aliases
openapi: 3.1.0
info:
  title: Mermail API
  version: 1.0.0
  description: >
    Programmatic Mermail API for scripts, agents, and integrations.


    ## Authentication


    Authorize with an API key from **Settings → API Keys**:


    ```

    x-api-key: sk-proj-…

    ```


    ## Plans


    Each endpoint page shows plan badges (**Public**, **All plans**, or
    **Developer+**). Free can call the core catalog; Developer-gated paths need
    Developer or Enterprise.


    ## Try it


    Every endpoint page includes an interactive playground. Click **Try it**,
    paste your API key into the `x-api-key` field, fill path/query/body fields
    (prefilled from examples), and send a live request to
    `https://console.mermail.app`. You can also copy the generated cURL /
    JavaScript / Python snippet.


    ## Credits


    Credits are workspace API-usage units, not currency amounts.


    | Class | Cost |

    | --- | ---: |

    | read | 1 |

    | write | 2 |

    | email_send | 5 |

    | provision | 10 |

    | ai_light | 15 |

    | ai_heavy | 25 |
  contact:
    name: Mermail
    email: contact@mermail.app
    url: https://mermail.app
servers:
  - url: https://console.mermail.app
    description: Production
security:
  - apiKeyAuth: []
tags:
  - name: Public
    description: No authentication
  - name: Usage
    description: Credits and email quotas
  - name: Workspaces
    description: Workspaces, members, storage
  - name: Domains
    description: Custom email domains (Developer+)
  - name: Mailboxes
    description: Agent inboxes
  - name: Emails
    description: Send, list, search, folders
  - name: Webhooks
    description: Email event subscriptions and delivery history
  - name: AI agent
    description: Mailbox agent chat
  - name: Task triage
    description: Task triagers (all plans)
  - name: RAG
    description: Knowledge documents and recall
  - name: Integrations
    description: Composio, Telegram, push
  - name: Affiliate
    description: Affiliate program
paths:
  /api/v1/mailboxes/{mailboxId}/aliases:
    post:
      summary: Save a plus alias shortcut
      description: >-
        Requires mailbox settings administration permission. Saving is optional
        for delivery; aliases share the parent mailbox's permissions and limits.
      operationId: saveMailboxAlias
      parameters:
        - name: mailboxId
          in: path
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - tag
              additionalProperties: false
              properties:
                tag:
                  type: string
                  minLength: 1
                  maxLength: 32
                  pattern: ^[a-zA-Z0-9](?:[a-zA-Z0-9._-]{0,30}[a-zA-Z0-9])?$
                  description: Plus tag, normalized to lowercase.
                label:
                  type:
                    - string
                    - 'null'
                  maxLength: 80
      responses:
        '201':
          description: Saved alias
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MailboxPlusAlias'
        '400':
          description: Invalid alias or unsupported mailbox
        '403':
          description: Insufficient mailbox permissions
        '404':
          description: Mailbox or alias not found, or feature unavailable
      security:
        - apiKeyAuth: []
components:
  schemas:
    MailboxPlusAlias:
      type: object
      properties:
        id:
          type: string
        tag:
          type: string
          minLength: 1
          maxLength: 32
          pattern: ^[a-zA-Z0-9](?:[a-zA-Z0-9._-]{0,30}[a-zA-Z0-9])?$
          description: Plus tag, normalized to lowercase.
        label:
          type:
            - string
            - 'null'
          maxLength: 80
        saved:
          type: boolean
        blockedAt:
          type:
            - string
            - 'null'
          format: date-time
        address:
          type: string
          format: email
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        API key (`sk-proj-…`) from Settings → API Keys. Required for sold API
        calls outside the Mermail console.

````

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