> ## 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 uma propriedade de um lead

> Modifica o valor de uma propriedade customizada associada a um lead. A propriedade (identificada pelo seu `slug`) deve ter sido previamente cadastrada no sistema.



## OpenAPI

````yaml /api-reference/zattenapi.json patch /leads/{leadNumber}/properties
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}/properties:
    patch:
      tags:
        - Leads
      summary: Atualiza uma propriedade de um lead
      description: >-
        Modifica o valor de uma propriedade customizada associada a um lead. A
        propriedade (identificada pelo seu `slug`) deve ter sido previamente
        cadastrada no sistema.
      parameters:
        - name: leadNumber
          in: path
          description: O número de WhatsApp (WaId) do lead a ser atualizado.
          required: true
          schema:
            type: string
      requestBody:
        description: Propriedade e novo valor a serem aplicados ao lead.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdatePropertyRequest'
      responses:
        '200':
          description: Propriedade atualizada com sucesso.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessMessage'
        '400':
          description: >-
            Erro de validação no corpo da requisição ou valor da propriedade já
            é o mesmo.
          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 ou Propriedade não encontrados.
          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:
    UpdatePropertyRequest:
      type: object
      required:
        - property
        - value
      properties:
        property:
          type: string
          description: O `slug` da propriedade a ser atualizada.
        value:
          type: string
          description: O novo valor para a propriedade.
          minLength: 3
          maxLength: 255
    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.

````