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

# Atualiza a anotação de um lead

> Adiciona ou substitui a anotação (nota) de um lead existente. É possível concatenar a nova nota com a anterior ou sobrescrevê-la completamente.



## OpenAPI

````yaml /api-reference/zattenapi.json patch /leads/{leadNumber}/notes
openapi: 3.1.0
info:
  title: API de Atendimento e Mensageria
  description: >-
    API para interagir com o sistema de atendimento, permitindo o envio de
    mensagens via template do WhatsApp e a gestão de informações de leads. A
    autenticação é realizada através de uma chave de API (`x-api-key`) enviada
    no cabeçalho de cada requisição. A API também possui um sistema de limite de
    requisições (rate limiting) para garantir a estabilidade.
  version: 1.0.0
servers:
  - url: https://api.zatten.com/api/v1
security:
  - ApiKeyAuth: []
tags:
  - name: Mensagens
    description: Endpoints para envio e consulta de mensagens.
  - name: Leads
    description: Endpoints para gerenciamento de dados de leads.
  - name: Kanban
    description: Endpoints para consulta de estruturas de organização do CRM.
  - name: Tags
    description: Endpoints para consulta de etiquetas (tags) de organização.
paths:
  /leads/{leadNumber}/notes:
    patch:
      tags:
        - Leads
      summary: Atualiza a anotação de um lead
      description: >-
        Adiciona ou substitui a anotação (nota) de um lead existente. É possível
        concatenar a nova nota com a anterior ou sobrescrevê-la completamente.
      parameters:
        - name: leadNumber
          in: path
          description: O número de WhatsApp (WaId) do lead a ser atualizado.
          required: true
          schema:
            type: string
      requestBody:
        description: Conteúdo da anotação a ser adicionada.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateNoteRequest'
      responses:
        '200':
          description: Anotação atualizada com sucesso.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessMessage'
        '400':
          description: Erro de validação no corpo da requisição.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Chave de API (`x-api-key`) ausente ou inválida.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: >-
            Lead com o `leadNumber` especificado não encontrado para este
            atendente.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Limite de requisições excedido.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    UpdateNoteRequest:
      type: object
      required:
        - note
      properties:
        note:
          type: string
          description: O conteúdo da anotação a ser salva.
        delete_previous_note:
          type: boolean
          description: >-
            Se `true`, a anotação antiga será substituída. Se `false`, a nova
            anotação será concatenada à antiga.
          default: false
    SuccessMessage:
      type: object
      properties:
        message:
          type: string
          description: Mensagem de sucesso da operação.
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: string
          description: Descrição do erro ocorrido.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: Chave de API necessária para autenticar todas as requisições.

````