> ## 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 webhook endpoint

> Send only the fields to change. The endpoint keeps its `id` and `secret`. `enabled` false pauses it (calls waiting to be sent are dropped).



## OpenAPI

````yaml /api-reference/openapi.yaml patch /webhooks/endpoints/{endpoint_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:
  /webhooks/endpoints/{endpoint_id}:
    parameters:
      - name: endpoint_id
        in: path
        required: true
        description: The endpoint's `we_…` id.
        schema:
          type: string
        example: we_e3f1a2b4c5d64e7f8a9b0c1d2e3f4a5b
    patch:
      tags:
        - Webhooks
      summary: Update a webhook endpoint
      description: >-
        Send only the fields to change. The endpoint keeps its `id` and
        `secret`. `enabled` false pauses it (calls waiting to be sent are
        dropped).
      operationId: updateWebhookEndpoint
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                url:
                  type: string
                  format: uri
                trigger_events:
                  type: array
                  items:
                    $ref: '#/components/schemas/Event'
                account_ids:
                  type: array
                  items:
                    type: string
                description:
                  type: string
                headers:
                  type: array
                  items:
                    type: object
                    properties:
                      key:
                        type: string
                      value:
                        type: string
                enabled:
                  type: boolean
            example:
              trigger_events:
                - email.new
              enabled: true
      responses:
        '200':
          description: The updated endpoint.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookEndpoint'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  schemas:
    Event:
      type: string
      enum:
        - email.new
        - email.new.bounce
        - email.update
        - email.delete
        - email.draft.new
        - email.draft.delete
        - email.folder.create
        - email.folder.update
        - email.folder.delete
        - tracking.open
        - tracking.click
        - account.add
        - account.reconnect
        - account.remove
        - account.status.running
        - account.status.errored
        - account.status.disconnected
        - account.initial_sync.running
        - account.initial_sync.completed
        - account.initial_sync.failed
    WebhookEndpoint:
      type: object
      properties:
        object:
          type: string
          const: WebhookEndpoint
        id:
          type: string
          description: '`we_…`'
        url:
          type: string
          format: uri
        description:
          type:
            - string
            - 'null'
        trigger_events:
          type: array
          items:
            $ref: '#/components/schemas/Event'
        account_ids:
          type: array
          items:
            type: string
        headers:
          type: array
          items:
            type: object
            properties:
              key:
                type: string
              value:
                type: string
        secret:
          type: string
          description: Signs the calls (HMAC-SHA256).
        enabled:
          type: boolean
        created_at:
          type: string
          format: date-time
    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
    Unauthorized:
      description: The `X-API-KEY` header is missing, wrong or revoked.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            status: 401
            type: errors/unauthorized
            title: Unauthorized
            detail: missing or invalid API key
    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
  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.