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

# Create a folder

> Creates the folder in the user's mailbox (inside `parent_id` when given). `email.folder.create` follows.



## OpenAPI

````yaml /api-reference/openapi.yaml post /{account_id}/folders
openapi: 3.1.0
info:
  title: PigeonPost API
  version: 1.0.0
  description: >
    Connect your users' mailboxes (Gmail with an app password, and any IMAP/SMTP
    provider), read, send and manage their email, and

    receive webhooks when something changes. The API follows Unipile's v2
    conventions (ids, lists,

    events); its own version is v1.


    **Authentication:** every request needs your access token in the `X-API-KEY`
    header. Create

    tokens in your dashboard under **API keys**, or with `POST
    /api/v1/api-keys`.


    **Base URL:** `https://{your DSN}/api/v1`. Your DSN is shown in your
    dashboard.


    **Emails follow Unipile's v2 email API:** the account goes in the path

    (`/api/v1/{account_id}/emails`, `/emails/send`, `/folders`, `/drafts`), with
    separate read,

    unread, modify and thread actions. IMAP only.


    **Ids** carry their type: `acc_…` (account), `email_…`, `att_…`
    (attachment), `fld_…`

    (folder), `drf_…` (draft), `we_…` (webhook endpoint), `evt_…` (event),
    `pk_…` (API key).


    **Lists** are `{ "object": "<Plural>", "data": [...], "has_more": true|false
    }`. Accounts,

    webhook endpoints, conversations and API keys page with `offset` and
    `limit`. Emails, drafts

    and contacts page with a `cursor`: pass the `cursor` of a response back to
    get the next page.


    **Errors** always have the same JSON shape: `status`, `type`, `title`,
    `detail`.
servers:
  - url: https://{dsn}/api/v1
    description: Your workspace's DSN, from your dashboard
    variables:
      dsn:
        default: mail-api.example.com
        description: Your DSN, for example mail-api.example.com
security:
  - apiKey: []
tags:
  - name: Auth
    description: Connect a mailbox from your app (IMAP/SMTP).
  - name: Accounts
    description: The mailboxes connected to your workspace.
  - name: Emails
    description: Read, search, send, change and delete emails.
  - name: Attachments
    description: Download the files attached to an email.
  - name: Drafts
    description: Drafts saved in the user's mailbox.
  - name: Folders
    description: Folders (Gmail labels appear as folders over IMAP).
  - name: Contacts
    description: The people an account has emailed with.
  - name: Webhooks
    description: Get notified when something happens in a mailbox.
  - name: API keys
    description: Access tokens for this API.
paths:
  /{account_id}/folders:
    parameters:
      - $ref: '#/components/parameters/account_id'
    post:
      tags:
        - Folders
      summary: Create a folder
      description: >-
        Creates the folder in the user's mailbox (inside `parent_id` when
        given). `email.folder.create` follows.
      operationId: createFolder
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - name
              properties:
                name:
                  type: string
                parent_id:
                  type: string
                  description: The `fld_…` id of the folder to create it in.
            example:
              name: Customers
      responses:
        '201':
          description: The new folder.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Folder'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/InvalidCredentials'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/ProviderRejected'
        '502':
          $ref: '#/components/responses/ProviderError'
components:
  parameters:
    account_id:
      name: account_id
      in: path
      required: true
      description: The account's `acc_…` id.
      schema:
        type: string
      example: acc_ba1fa6938d8548298e8ce62e4b4b4e99
  schemas:
    Folder:
      type: object
      properties:
        object:
          type: string
          const: Folder
        id:
          type: string
          description: '`fld_…`'
        account_id:
          type: string
        name:
          type: string
        role:
          $ref: '#/components/schemas/Role'
        parent_id:
          type:
            - string
            - 'null'
        total_count:
          type: integer
    Role:
      type: string
      enum:
        - INBOX
        - SENT
        - DRAFTS
        - TRASH
        - SPAM
        - ARCHIVE
        - ALL
        - IMPORTANT
        - STARRED
        - UNKNOWN
    Error:
      type: object
      properties:
        status:
          type: integer
        type:
          type: string
          enum:
            - errors/invalid_parameters
            - errors/unauthorized
            - errors/invalid_credentials
            - errors/not_found
            - errors/already_exists
            - errors/provider_rejected
            - errors/provider_error
            - errors/unexpected_error
        title:
          type: string
        detail:
          type: string
  responses:
    BadRequest:
      description: A parameter is missing or wrong. `detail` says which.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            status: 400
            type: errors/invalid_parameters
            title: Invalid parameters
            detail: limit must be between 1 and 250
    InvalidCredentials:
      description: >-
        `errors/invalid_credentials`: the mail provider rejected the account's
        password or token; reconnect it. (`errors/unauthorized`: a bad access
        token.)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            status: 401
            type: errors/invalid_credentials
            title: Invalid credentials
            detail: 'the mail provider rejected the credentials: invalid_grant'
    NotFound:
      description: Nothing with this id (a malformed or wrong-type id is also not found).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            status: 404
            type: errors/not_found
            title: Not found
            detail: email email_94a0d77db739407e932c3b97fef44aac not found
    ProviderRejected:
      description: The mail provider refused the request. Retrying won't help.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            status: 422
            type: errors/provider_rejected
            title: Rejected by the provider
            detail: Message too large
    ProviderError:
      description: The mail provider failed or didn't answer. Try again later.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            status: 502
            type: errors/provider_error
            title: Mail provider error
            detail: timed out talking to imap.example.com
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-API-KEY
      description: Your access token, from your dashboard under **API keys**.

````

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