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

> ## Agent Instructions
> Responda sempre em português do Brasil, com os nomes de menus e botões exatamente como aparecem no painel do Notfy.
> Use somente o que está documentado aqui. Se a documentação não cobrir a pergunta, diga isso e indique a página mais próxima em vez de inventar.
> Funcionalidades podem depender do plano, do segmento da empresa, das permissões do usuário e de integrações ativas: cite essa condição quando a página a mencionar.
> Nunca peça nem repita senhas, tokens ou dados pessoais de clientes.

# Enviar um lead

> Recebe um lead e o coloca na etapa inicial do funil. É obrigatório informar telefone ou e-mail. O lead é processado logo após o aceite. Se já existir um lead com o mesmo e-mail e telefone, ele é atualizado. Limite de 120 requisições por minuto.



## OpenAPI

````yaml /api-reference/openapi.json post /api/webhooks/leads
openapi: 3.1.0
info:
  title: API de recebimento de leads do Notfy
  version: 1.0.0
  description: >-
    Cria leads no Notfy a partir de formulários, RD Station, Meta Lead Ads ou
    ferramentas de automação. A autenticação usa um token gerado na integração
    Webhook de Leads.
servers:
  - url: https://SEU-DOMINIO
    description: Domínio do seu Notfy
security:
  - bearerAuth: []
paths:
  /api/webhooks/leads:
    post:
      tags:
        - Leads
      summary: Enviar um lead
      description: >-
        Recebe um lead e o coloca na etapa inicial do funil. É obrigatório
        informar telefone ou e-mail. O lead é processado logo após o aceite. Se
        já existir um lead com o mesmo e-mail e telefone, ele é atualizado.
        Limite de 120 requisições por minuto.
      operationId: createLead
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: Informe pelo menos phone ou email.
              properties:
                name:
                  type: string
                  maxLength: 255
                  description: Nome do lead. Sem nome, o lead entra como Novo Lead.
                phone:
                  type: string
                  maxLength: 50
                  description: Telefone. Apenas os números são mantidos.
                email:
                  type: string
                  format: email
                  maxLength: 255
                  description: E-mail do lead.
                source:
                  type: string
                  maxLength: 100
                  description: Origem do lead, por exemplo site ou rd_station.
                notes:
                  type: string
                  description: Observações sobre o lead.
              additionalProperties: true
              example:
                name: Maria Souza
                phone: +55 49 99999-0000
                email: maria@exemplo.com.br
                source: site
                notes: Pediu contato sobre o plano anual
            examples:
              formulario:
                summary: Formulário do site
                value:
                  name: Maria Souza
                  phone: +55 49 99999-0000
                  email: maria@exemplo.com.br
                  source: site
                  notes: Pediu contato sobre o plano anual
              somenteTelefone:
                summary: Apenas telefone
                value:
                  name: João Lima
                  phone: '49999990000'
      responses:
        '202':
          description: Lead aceito para processamento.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    examples:
                      - Lead accepted for processing
        '401':
          description: Token ausente, inválido ou sem permissão para criar leads.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    examples:
                      - Unauthenticated.
        '422':
          description: >-
            Dados inválidos, por exemplo sem telefone e sem e-mail, ou e-mail
            mal formado.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  error:
                    type: string
        '429':
          description: Limite de requisições excedido (120 por minuto).
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Token gerado em Ajustes, Integrações, aba Webhook de Leads, botão Gerar
        Novo Token de Segurança. Envie como Authorization: Bearer SEU_TOKEN.

````

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