> ## 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.

# Send a lead

> Receives a lead and places it in the initial stage of the funnel. Either a phone number or an email is required. The lead is processed right after it is accepted. If a lead with the same email and phone already exists, it is updated. Limit of 120 requests per minute.



## OpenAPI

````yaml /en/api-reference/openapi.json post /api/webhooks/leads
openapi: 3.1.0
info:
  title: Notfy lead intake API
  version: 1.0.0
  description: >-
    Creates leads in Notfy from forms, RD Station, Meta Lead Ads or automation
    tools. Authentication uses a token generated in the Lead Webhook
    integration.
servers:
  - url: https://SEU-DOMINIO
    description: Your Notfy domain
security:
  - bearerAuth: []
paths:
  /api/webhooks/leads:
    post:
      tags:
        - Leads
      summary: Send a lead
      description: >-
        Receives a lead and places it in the initial stage of the funnel. Either
        a phone number or an email is required. The lead is processed right
        after it is accepted. If a lead with the same email and phone already
        exists, it is updated. Limit of 120 requests per minute.
      operationId: createLead
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: Provide at least phone or email.
              properties:
                name:
                  type: string
                  maxLength: 255
                  description: Lead name. Without a name, the lead is created as Novo Lead.
                phone:
                  type: string
                  maxLength: 50
                  description: Phone number. Only the digits are kept.
                email:
                  type: string
                  format: email
                  maxLength: 255
                  description: Lead email.
                source:
                  type: string
                  maxLength: 100
                  description: Lead source, for example site or rd_station.
                notes:
                  type: string
                  description: Notes about the lead.
              additionalProperties: true
              example:
                name: Maria Souza
                phone: +55 49 99999-0000
                email: maria@exemplo.com.br
                source: site
                notes: Asked for contact about the annual plan
            examples:
              formulario:
                summary: Website form
                value:
                  name: Maria Souza
                  phone: +55 49 99999-0000
                  email: maria@exemplo.com.br
                  source: site
                  notes: Asked for contact about the annual plan
              somenteTelefone:
                summary: Phone only
                value:
                  name: João Lima
                  phone: '49999990000'
      responses:
        '202':
          description: Lead accepted for processing.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    examples:
                      - Lead accepted for processing
        '401':
          description: Missing or invalid token, or no permission to create leads.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    examples:
                      - Unauthenticated.
        '422':
          description: >-
            Invalid data, for example no phone and no email, or a malformed
            email.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  error:
                    type: string
        '429':
          description: Request limit exceeded (120 per minute).
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Token generated in Settings, Integrations, Lead Webhook tab, Generate
        New Security Token button. Send it as Authorization: Bearer YOUR_TOKEN.

````

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