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

# Rename or subscribe a mailbox folder

> Requires a read_write mailbox. Special folders (INBOX, Sent, Drafts, Trash, Junk, Archive) and scope folders can't be renamed.



## OpenAPI

````yaml https://inbound.new/openapi.json patch /api/e2/mailboxes/{id}/folders/{folder}
openapi: 3.1.0
info:
  title: Inbound Email API
  description: >+

    # Inbound API


    The Inbound API allows you to manage email infrastructure programmatically -
    domains, email addresses, webhooks, and more.


    ## Authentication


    All API requests require a Bearer token in the Authorization header:


    ```bash

    curl -H "Authorization: Bearer YOUR_API_KEY" \
      https://inbound.new/api/e2/domains
    ```


    ## Base URL


    ```

    https://inbound.new/api/e2

    ```


    ## Quick Start


    1. **Create a domain** - Register your domain with Inbound

    2. **Configure DNS** - Add the provided DNS records to your domain

    3. **Create an email address** - Set up addresses to receive emails

    4. **Create an endpoint** - Configure where emails are delivered (webhook,
    forwarding, etc.)

  version: 2.0.0
servers:
  - url: https://inbound.new
    description: Production API server
security:
  - bearerAuth: []
tags:
  - name: Webhooks
    description: Webhooks sent by Inbound to your configured endpoints when events occur.
  - name: Emails
    description: >-
      Send, list, and manage emails. Supports immediate sending, scheduling,
      replies, and retry functionality.
  - name: Mail
    description: >-
      Inbox and thread views for received emails. Filter by domain, address, or
      search.
  - name: Domains
    description: >-
      Manage domains for sending and receiving emails. Domains must be verified
      via DNS before use.
  - name: Endpoints
    description: >-
      Configure where incoming emails are delivered - webhooks, email
      forwarding, or custom handlers.
  - name: Email Addresses
    description: Create and manage email addresses on your verified domains.
  - name: Attachments
    description: Download email attachments using authenticated requests.
paths:
  /api/e2/mailboxes/{id}/folders/{folder}:
    patch:
      tags:
        - Mailboxes
      summary: Rename or subscribe a mailbox folder
      description: >-
        Requires a read_write mailbox. Special folders (INBOX, Sent, Drafts,
        Trash, Junk, Archive) and scope folders can't be renamed.
      operationId: patchApiE2MailboxesByIdFoldersByFolder
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
        - name: folder
          in: path
          required: true
          schema:
            description: >-
              Folder path, URL-encoded as one segment (for example `INBOX`,
              `Archive`, `Projects%2F2026` or `Scopes%2F*%40example.com`)
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              minProperties: 1
              type: object
              properties:
                path:
                  minLength: 1
                  maxLength: 255
                  description: New path. Subfolders move with the folder.
                  type: string
                subscribed:
                  type: boolean
          application/x-www-form-urlencoded:
            schema:
              minProperties: 1
              type: object
              properties:
                path:
                  minLength: 1
                  maxLength: 255
                  description: New path. Subfolders move with the folder.
                  type: string
                subscribed:
                  type: boolean
          multipart/form-data:
            schema:
              minProperties: 1
              type: object
              properties:
                path:
                  minLength: 1
                  maxLength: 255
                  description: New path. Subfolders move with the folder.
                  type: string
                subscribed:
                  type: boolean
      responses:
        '200':
          description: Response for status 200
          content:
            application/json:
              schema:
                type: object
                properties:
                  path:
                    type: string
                  name:
                    type: string
                  specialUse:
                    nullable: true
                    anyOf:
                      - type: string
                      - type: 'null'
                  scopeId:
                    nullable: true
                    anyOf:
                      - type: string
                      - type: 'null'
                  subscribed:
                    type: boolean
                  uidValidity:
                    type: number
                  uidNext:
                    type: number
                  highestModseq:
                    type: number
                  total:
                    type: number
                  unread:
                    type: number
                required:
                  - path
                  - name
                  - specialUse
                  - scopeId
                  - subscribed
                  - uidValidity
                  - uidNext
                  - highestModseq
                  - total
                  - unread
        '400':
          description: Response for status 400
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
        '401':
          description: Response for status 401
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
        '403':
          description: Response for status 403
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
        '404':
          description: Response for status 404
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
        '409':
          description: Response for status 409
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: >-
        Your Inbound API key. Include it in the Authorization header as: Bearer
        <your-api-key>

````

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