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

# Update a webhook endpoint

> Changes the fields you send. `status` `active` switches an endpoint on and clears its failure count. Any other value switches it off. Needs the `webhooks:manage` scope.



## OpenAPI

````yaml /openapi/partner.yaml patch /api/v1/partner/webhooks/endpoints/{endpoint_id}/
openapi: 3.1.0
info:
  title: ImpelLabs Partner API
  version: '1'
  description: >-
    The Partner API provisions customer businesses (tenants) and runs their
    channels, conversations and templates from your own product. Call it from
    your server with a partner key. Every path ends with a slash.
servers:
  - url: https://api.impellabs.tech
security:
  - bearer: []
tags:
  - name: Keys
    description: Your partner API keys.
  - name: Tenants
    description: Customer businesses, their channels, conversations and templates.
  - name: Webhooks
    description: Where your tenants' events go.
  - name: WhatsApp sign-up
    description: The settings of the hosted WhatsApp sign-up.
paths:
  /api/v1/partner/webhooks/endpoints/{endpoint_id}/:
    patch:
      tags:
        - Webhooks
      summary: Update a webhook endpoint
      description: >-
        Changes the fields you send. `status` `active` switches an endpoint on
        and clears its failure count. Any other value switches it off. Needs the
        `webhooks:manage` scope.
      operationId: patch_api_v1_partner_webhooks_endpoints_endpoint_id
      parameters:
        - name: endpoint_id
          in: path
          required: true
          schema:
            type: string
          description: The id of the webhook endpoint (UUID).
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                enabled_events:
                  type: array
                  items:
                    type: string
                granted_scopes:
                  type: array
                  items:
                    type: string
                  description: The scopes that decide which events it hears.
                status:
                  type: string
                  enum:
                    - active
                    - disabled
                description:
                  type: string
            example:
              status: active
        required: false
      responses:
        '200':
          description: Success
          content:
            application/json:
              example:
                id: 6e4a2b8c-0000-4000-8000-000000000000
                url: https://example.org/hooks/impel
                description: CRM
                status: active
                api_version: '2026-06-01'
                enabled_events:
                  - message.*
                granted_scopes:
                  - messages:read
                secret_hint: k3Yz
                created_at: '2026-01-15T09:30:00+00:00'
        '400':
          $ref: '#/components/responses/Invalid'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        4XX:
          description: The request is not valid or not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  responses:
    Invalid:
      description: >-
        A field is missing or wrong. The body names each field: {"field": "what
        to fix"}.
    Unauthorized:
      description: The credentials are missing, wrong, expired or revoked.
    Forbidden:
      description: These credentials may not do this.
    NotFound:
      description: There is no such row, or these credentials cannot see it.
  schemas:
    Error:
      type: object
      description: >-
        An error. Most errors carry `detail`. Some carry `error` with `code` and
        `message`.
      properties:
        detail:
          type: string
        code:
          type: string
        field:
          type: string
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
  securitySchemes:
    bearer:
      type: http
      scheme: bearer

````

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