> ## 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.

# Update a draft

> The fields you send replace the draft's; the rest is kept. The draft is saved again at the provider, so it gets a **new `draft_id`**.



## OpenAPI

````yaml /api-reference/openapi.yaml patch /drafts/{draft_id}
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.


    **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:
  /drafts/{draft_id}:
    parameters:
      - $ref: '#/components/parameters/draft_id'
      - $ref: '#/components/parameters/draft_account_id'
    patch:
      tags:
        - Drafts
      summary: Update a draft
      description: >-
        The fields you send replace the draft's; the rest is kept. The draft is
        saved again at the provider, so it gets a **new `draft_id`**.
      operationId: updateDraft
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SendInput'
            example:
              subject: Final proposal
      responses:
        '200':
          description: The draft is updated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DraftResult'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/InvalidCredentials'
        '404':
          $ref: '#/components/responses/NotFound'
        '502':
          $ref: '#/components/responses/ProviderError'
components:
  parameters:
    draft_id:
      name: draft_id
      in: path
      required: true
      description: The `drf_…` id from creation, or the synced draft's `email_…` id.
      schema:
        type: string
      example: drf_r-4419383208612875012
    draft_account_id:
      name: account_id
      in: query
      description: >-
        The draft's account. Needed only right after creating it, before it has
        synced.
      schema:
        type: string
  schemas:
    SendInput:
      type: object
      properties:
        account_id:
          type: string
          description: The account to send from (`acc_…`).
        to:
          type: array
          items:
            $ref: '#/components/schemas/Attendee'
        cc:
          type: array
          items:
            $ref: '#/components/schemas/Attendee'
        bcc:
          type: array
          items:
            $ref: '#/components/schemas/Attendee'
        from:
          type: object
          properties:
            display_name:
              type: string
            identifier:
              type: string
          description: Sender name; `identifier` can set a send-as alias.
        reply_to_addresses:
          type: array
          items:
            $ref: '#/components/schemas/Attendee'
        subject:
          type: string
        body:
          type: string
          description: HTML body.
        body_plain:
          type: string
        reply_to:
          type: string
          description: The `email_…` id you answer.
        custom_headers:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              value:
                type: string
          description: X-…, List-Unsubscribe, List-Unsubscribe-Post or Reply-To.
        tracking_options:
          type: object
          properties:
            opens:
              type: boolean
            links:
              type: boolean
            label:
              type: string
            custom_domain:
              type: string
        attachments:
          type: array
          items:
            type: object
            required:
              - content
            properties:
              filename:
                type: string
              content_type:
                type: string
              content:
                type: string
                contentEncoding: base64
    DraftResult:
      type: object
      properties:
        object:
          type: string
          enum:
            - DraftCreated
            - DraftUpdated
        account_id:
          type: string
        draft_id:
          type: string
          description: '`drf_…`'
        previous_draft_id:
          type: string
          description: 'After an update: the old id, which no longer works.'
        message_id:
          type: string
        tracking_id:
          type:
            - string
            - 'null'
    Attendee:
      type: object
      properties:
        display_name:
          type: string
        identifier:
          type: string
          format: email
      required:
        - identifier
    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
    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.