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

# Atualizar webhook

> Atualiza um webhook: qualquer subconjunto de name, url, active (false pausa as entregas sem apagar) e events. events SUBSTITUI a lista completa de assinaturas — lista vazia = não dispara nada; "*" = todos; eventos que o provedor do número não emite são descartados. O número do webhook NÃO pode ser trocado pela API pública (400 NUMBER_RESCOPE_NOT_SUPPORTED) — apague e recrie. 404 se não for visível para a key. O segredo NUNCA é retornado.



## OpenAPI

````yaml openapi.pt.json PATCH /v1/webhooks/{id}
openapi: 3.1.0
info:
  title: API Pilot Status
  version: 1.0.0
  license:
    name: Pilot Status Terms of Service
    url: https://pilotstatus.com.br/terms
  description: >-
    API REST pública do Pilot Status. Autentique com o header `x-api-key:
    ps_...` (ou `x-api-key-id`). Base URL: https://pilotstatus.com.br
servers:
  - url: https://pilotstatus.com.br
security:
  - apiKey: []
  - apiKeyId: []
paths:
  /v1/webhooks/{id}:
    patch:
      tags:
        - Webhooks
      summary: Atualizar webhook
      description: >-
        Atualiza um webhook: qualquer subconjunto de name, url, active (false
        pausa as entregas sem apagar) e events. events SUBSTITUI a lista
        completa de assinaturas — lista vazia = não dispara nada; "*" = todos;
        eventos que o provedor do número não emite são descartados. O número do
        webhook NÃO pode ser trocado pela API pública (400
        NUMBER_RESCOPE_NOT_SUPPORTED) — apague e recrie. 404 se não for visível
        para a key. O segredo NUNCA é retornado.
      operationId: patch_webhooks_id
      parameters:
        - name: id
          in: path
          required: true
          description: Id do webhook.
          schema:
            type: string
          example: wh_01HZX...
        - name: x-whatsapp-number-id
          in: header
          required: false
          description: >-
            Restringe ao contexto de um número (obrigatório em concessões OAuth
            por número).
          schema:
            type: string
          example: num_01HZX...
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: Novo nome de exibição.
                  example: n8n-prod
                url:
                  type: string
                  description: Novo endpoint.
                  example: https://hooks.acme.com/whatsapp-v2
                active:
                  type: boolean
                  description: false pausa as entregas; true retoma.
                  example: 'false'
                events:
                  type: array
                  items:
                    type: string
                  description: Lista COMPLETA de substituição das assinaturas; "*" = todos.
                  example: '["message.received"]'
            example:
              active: false
      responses:
        '200':
          description: Pausar entregas
          content:
            application/json:
              example:
                id: wh_01HZX...
                tenantId: tenant_01HZX...
                name: n8n
                url: https://hooks.acme.com/whatsapp
                environment: LIVE
                active: false
                events:
                  - message.received
                  - message.delivered
                createdAt: '2026-06-01T11:59:00.000Z'
                updatedAt: '2026-07-03T12:05:00.000Z'
        '400':
          description: Payload ou parâmetros inválidos
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Validation error
        '401':
          description: Header `x-api-key` / `x-api-key-id` ausente ou inválido
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Unauthorized
        '429':
          description: Limite de taxa excedido
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Too many requests
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: Sua chave de API ps_
    apiKeyId:
      type: apiKey
      in: header
      name: x-api-key-id
      description: Id da chave de API (alternativa ao x-api-key)

````