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

# Update a webhook endpoint

> Partially update a webhook endpoint. Omitted fields stay unchanged; `channels: null` clears number filters. (Permitted scopes: **fax:all:edit**, **fax:webhook:edit**)

<Note>
  Partial update. Omitted fields stay unchanged. Send `"channels": null` to clear number filters.
</Note>

<RequestExample>
  ```bash cURL theme={null}
  curl -X PATCH https://restapi.fax.plus/v3/webhooks/{endpoint_id} \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer {access-token}' \
    -d '{
      "url": "https://example.com/fax-webhooks",
      "filter_types": ["fax_sent"],
      "channels": null
    }'
  ```

  ```python Python theme={null}
  import requests

  resp = requests.patch(
      "https://restapi.fax.plus/v3/webhooks/{endpoint_id}",
      headers={"Authorization": "Bearer {access-token}", "Content-Type": "application/json"},
      json={"url": "https://example.com/fax-webhooks", "channels": None},
  )
  print(resp.status_code)
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  {}
  ```

  ```json 400 theme={null}
  {
    "error": "bad_request",
    "description": "Invalid phone number: not-a-number"
  }
  ```

  ```json 403 theme={null}
  {
    "error": "plan_not_eligible"
  }
  ```

  ```json 404 theme={null}
  {
    "error": "bad_request",
    "description": "hook_not_found"
  }
  ```

  ```json 500 theme={null}
  {
    "error": "server_error",
    "description": "server_error"
  }
  ```
</ResponseExample>


## OpenAPI

````yaml patch /webhooks/{endpoint_id}
openapi: 3.0.1
info:
  title: Fax.Plus REST API
  description: >-
    This is the Fax.Plus API v3 developed for third party developers and
    organizations. In order to have a better coding experience with this API,
    let's quickly go through some points:<br /><br /> - This API assumes
    **/accounts** as an entry point with the base url of
    **https://restapi.fax.plus/v3**. <br /><br /> - This API treats all date and
    times sent to it in requests as **UTC**. Also, all dates and times returned
    in responses are in **UTC**<br /><br /> - Once you have an access_token, you
    can easily send a request to the resource server with the base url of
    **https://restapi.fax.plus/v3** to access your permitted resources. As an
    example to get the user's profile info you would send a request to
    **https://restapi.fax.plus/v3/accounts/self** when **Authorization** header
    is set to **Bearer YOUR_ACCESS_TOKEN** and custom header of
    **x-fax-clientid** is set to YOUR_CLIENT_ID
  version: 3.5.0
  contact:
    name: Fax.Plus
    email: info@fax.plus
    url: https://github.com/alohi
servers:
  - url: https://restapi.fax.plus/v3
  - url: /v3
security: []
paths:
  /webhooks/{endpoint_id}:
    patch:
      tags:
        - Webhooks
      summary: Update a webhook endpoint
      description: >-
        Partially update a webhook endpoint. Omitted fields stay unchanged;
        `channels: null` clears number filters. (Permitted scopes:
        **fax:all:edit**, **fax:webhook:edit**)
      operationId: updateWebhookEndpoint
      parameters:
        - name: endpoint_id
          in: path
          required: true
          schema:
            type: string
          example: ep_33ZIBDmz66FcPG35FnsbM6Ie4X1
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WebhookEndpointUpdate'
      responses:
        '200':
          description: Endpoint was successfully updated. Body is an empty object.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
              example: {}
        '400':
          $ref: '#/components/responses/Error'
        '403':
          $ref: '#/components/responses/Error'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '500':
          $ref: '#/components/responses/ServerError'
      security:
        - oauth2:
            - all
        - personal_access_token:
            - fax:all:edit
            - fax:webhook:edit
components:
  schemas:
    WebhookEndpointUpdate:
      description: >-
        Partial webhook endpoint update. Omitted fields are unchanged.
        `channels: null` clears number filters.
      type: object
      properties:
        url:
          type: string
        filter_types:
          type: array
          nullable: true
          items:
            $ref: '#/components/schemas/WebhookFilterType'
        channels:
          type: array
          nullable: true
          items:
            type: string
            description: Fax number in E.164 format
        description:
          type: string
        disabled:
          type: boolean
        throttle_rate:
          type: integer
          nullable: true
      additionalProperties: false
    WebhookFilterType:
      description: Webhook event type for /webhooks endpoints
      enum:
        - fax_received
        - fax_sent
        - fax_page_received
      type: string
    Error:
      properties:
        description:
          type: string
        error:
          type: string
      additionalProperties: false
  responses:
    Error:
      description: Error object in case there's a problem with given data
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: invalid_user_id
            description: Invalid user id given
    NotFoundError:
      description: Requested resource was not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: bad_request
            description: Requested resource was not found.
    ServerError:
      description: Error object in case there's a server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: internal_server_error
            description: An unexpected error happened, please contact support
  securitySchemes:
    oauth2:
      type: oauth2
      description: OAuth2 Authorization Grant
      flows:
        authorizationCode:
          authorizationUrl: >-
            https://accounts.fax.plus/login?response_type=code&client_id=YOUR_CLIENT_ID&redirect_uri=http://localhost&scope=all
          tokenUrl: https://accounts.fax.plus/token
          refreshUrl: >-
            https://accounts.fax.plus/token?grant_type=refresh_token&refresh_token=YOUR_REFRESH_TOKEN
          scopes:
            all: >-
              for now when a user grants permission, all grants will be
              permitted
    personal_access_token:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Personal Access Token (PAT) is a Bearer token used for secure API calls.
        For direct API calls, the PAT is used in the Authorization header as
        'Bearer {PAT}'. For MCP usage, configure your PAT in your MCP client
        settings (e.g., in your IDE's MCP server configuration) - authentication
        will be handled automatically.

````