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

# Criar Lead

> Cria um novo lead para a conta autenticada.



## OpenAPI

````yaml /api-reference/openapi.json post /lead
openapi: 3.0.3
info:
  title: WavUps CRM API
  description: >-
    API pública da plataforma WavUps CRM — gerencie leads, produtos, categorias,
    atendimentos, agendamentos, conversas e pipelines de CRM.
  version: 1.0.0
servers:
  - url: https://crm.wavups.com/api/v1
    description: Servidor de produção
security:
  - Token: []
paths:
  /lead:
    post:
      tags:
        - Leads
      summary: Criar Lead
      description: Cria um novo lead para a conta autenticada.
      operationId: createLead
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateLeadBody'
      responses:
        '201':
          description: Lead criado com sucesso.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Lead'
        '500':
          $ref: '#/components/responses/Error500'
components:
  schemas:
    CreateLeadBody:
      type: object
      required:
        - name
      properties:
        name:
          type: string
          description: Nome do lead.
        email:
          type: string
          description: E-mail do lead.
        phone:
          type: string
          description: >-
            Telefone no formato internacional sem simbolos: 5547999999999 (pais
            + DDD + numero). Outros formatos causarao erros nos disparos via
            WhatsApp.
          example: '5547999999999'
        taxId:
          type: string
          description: CPF ou CNPJ do lead.
          example: '12345678909'
        source:
          type: string
          description: 'Origem do lead (ex: site, instagram, indicacao).'
        leadOwner:
          type: string
          description: ID do usuario responsavel pelo lead.
        profileImage:
          type: string
          description: URL da imagem de perfil do lead.
        zipCode:
          type: string
          description: CEP do endereco.
        state:
          type: string
          description: Estado.
        city:
          type: string
          description: Cidade.
        neighborhood:
          type: string
          description: Bairro.
        streetAddress:
          type: string
          description: Logradouro.
        number:
          type: string
          description: Numero do endereco.
        complement:
          type: string
          description: Complemento do endereco.
        description:
          type: string
          description: Descricao ou observacoes sobre o lead.
        leadType:
          type: string
          description: 'Tipo do lead (ex: PF, PJ).'
        leadTemperature:
          type: integer
          enum:
            - 1
            - 2
            - 3
          description: 'Temperatura do lead: 1 (Frio), 2 (Morno), 3 (Quente).'
        status:
          type: string
          description: 'Status inicial do lead. Padrao: Lead.'
        metadata:
          type: object
          description: Metadados adicionais do lead em formato JSON.
          nullable: true
        utms:
          type: object
          description: Parâmetros UTM associados ao lead em formato JSON.
          nullable: true
          properties:
            utm_source:
              type: string
              description: 'Origem do tráfego (ex: fb, google, instagram).'
              example: fb
            utm_medium:
              type: string
              description: 'Meio do tráfego (ex: paid, cpc, organic, story).'
              example: paid
            utm_campaign:
              type: string
              description: Identificador ou nome da campanha.
              example: '120243645529690704'
            utm_term:
              type: string
              description: Termo de pesquisa ou identificador de público/anúncio.
              example: '120243645529720704'
            utm_content:
              type: string
              description: Conteúdo do anúncio ou identificador do criativo.
              example: '120247590343130704'
    Lead:
      type: object
      properties:
        id:
          type: string
        leadOwner:
          type: string
          nullable: true
        name:
          type: string
        email:
          type: string
          nullable: true
        phone:
          type: string
          nullable: true
          description: >-
            Telefone no formato 5547999999999 (pais + DDD + numero, sem espacos
            ou simbolos).
          example: '5547999999999'
        taxId:
          type: string
          nullable: true
          description: CPF ou CNPJ do lead.
          example: '12345678909'
        source:
          type: string
          nullable: true
        profileImage:
          type: string
          nullable: true
        zipCode:
          type: string
          nullable: true
        state:
          type: string
          nullable: true
        city:
          type: string
          nullable: true
        neighborhood:
          type: string
          nullable: true
        streetAddress:
          type: string
          nullable: true
        number:
          type: string
          nullable: true
        complement:
          type: string
          nullable: true
        description:
          type: string
          nullable: true
        leadType:
          type: string
          nullable: true
        leadTemperature:
          type: number
          nullable: true
          description: 'Temperatura do lead: 1 (Frio), 2 (Morno), 3 (Quente).'
        status:
          type: string
        metadata:
          type: object
          description: Metadados adicionais do lead em formato JSON.
          nullable: true
        utms:
          type: object
          description: Parâmetros UTM associados ao lead em formato JSON.
          nullable: true
          properties:
            utm_source:
              type: string
              description: 'Origem do tráfego (ex: fb, google, instagram).'
              example: fb
            utm_medium:
              type: string
              description: 'Meio do tráfego (ex: paid, cpc, organic, story).'
              example: paid
            utm_campaign:
              type: string
              description: Identificador ou nome da campanha.
              example: '120243645529690704'
            utm_term:
              type: string
              description: Termo de pesquisa ou identificador de público/anúncio.
              example: '120243645529720704'
            utm_content:
              type: string
              description: Conteúdo do anúncio ou identificador do criativo.
              example: '120247590343130704'
        createdAt:
          type: string
          format: date-time
    ErrorMessage:
      type: object
      properties:
        error:
          type: string
          example: Recurso não encontrado.
  responses:
    Error500:
      description: Erro interno no servidor.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorMessage'
  securitySchemes:
    Token:
      type: apiKey
      in: header
      name: Token
      description: Token de autenticacao gerado na plataforma WavUps CRM.

````