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

# insertProspect

> <h2>Insere um novo prospect no lote especificado.</h2>
<br />
 Ao menos um dos três campos abaixo deve ser informado:<br />
<ul> <li>foneres</li> <li>fonecel</li> <li>fonecom</li> </ul>

<h6 class="label label-success">Response:</h6>
<table class="table table-hover"> <tbody><tr><td>id</td><td>Retorna o Id do Prospect cadastrado</td></tr> </tbody></table>



## OpenAPI

````yaml /openapi.yaml post /ipbox/api/insertProspect
openapi: 3.0.0
info:
  title: IPBoX Api Documentation v1.1
  description: >-
    Nesse documento são descritos os comandos presentes na API Rest do IPBoX. Os
    comandos são executados com chamadas POST e com respostas em formato JSON.
  version: 1.0.0
servers:
  - url: https://{baseUrl}
    description: Dominio (e porta, se houver) do servidor IPBoX do cliente
    variables:
      baseUrl:
        default: cliente.ipboxcloud.com.br:9052
        description: >-
          Substitua pelo dominio real do seu servidor IPBoX. A maioria dos
          servidores usa uma porta especifica - inclua-a junto ao dominio (ex.:
          cliente.ipboxcloud.com.br:9052)
security:
  - ApiToken: []
tags:
  - name: Agente
  - name: Ligações
  - name: Prospects
  - name: Agendamentos
  - name: Listas
  - name: Filas
  - name: Lotes
  - name: Relatórios
  - name: Outros
  - name: Times
  - name: Blacklist
  - name: Áudios
  - name: URAs
paths:
  /ipbox/api/insertProspect:
    post:
      tags:
        - Prospects
      summary: insertProspect
      description: >-
        <h2>Insere um novo prospect no lote especificado.</h2>

        <br />
         Ao menos um dos três campos abaixo deve ser informado:<br />
        <ul> <li>foneres</li> <li>fonecel</li> <li>fonecom</li> </ul>


        <h6 class="label label-success">Response:</h6>

        <table class="table table-hover"> <tbody><tr><td>id</td><td>Retorna o Id
        do Prospect cadastrado</td></tr> </tbody></table>
      parameters:
        - name: Authorization
          in: header
          schema:
            type: string
          example: '{{token}}'
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/x-www-form-urlencoded
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                lote:
                  type: string
                  description: Id do lote.
                  example: loteId
                nome:
                  type: string
                  description: Nome do prospect.
                  example: nome
                foneres:
                  type: string
                  description: >-
                    Telefone residencial no formato DDD+Numero, exemplo:
                    11994744333.
                  example: foneres
                fonecel:
                  type: string
                  description: >-
                    Telefone celular no formato DDD+Numero, exemplo:
                    11994744333.
                  example: fonecel
                fonecom:
                  type: string
                  description: >-
                    Telefone comercial no formato DDD+Numero, exemplo:
                    11994744333.
                  example: fonecom
                codigo:
                  type: string
                  description: >-
                    [Opcional] Codigo do Prospect; se nao for informado, sera
                    gerado um codigo automaticamente
                  example: codigo
                data_retorno:
                  type: string
                  description: >-
                    [Opcional] Data e hora do agendamento no formato DD/MM/AAAA
                    HH:MM
                  example: data_retorno
                usuario_retorno:
                  type: string
                  description: >-
                    [Opcional] Login/username do agente do agendamento (se
                    específico)
                  example: usuario_retorno
                origem:
                  type: string
                  description: '[Opcional] Origem'
                  example: origem
                midia:
                  type: string
                  description: '[Opcional] Mídia'
                  example: midia
                chave:
                  type: string
                  description: '[Opcional] Palavra Chave'
                  example: palavra_chave
                cliente:
                  type: string
                  description: '[Opcional] Já Cliente'
                  example: ja_e_cliente
                cidade:
                  type: string
                  description: '[Opcional] Cidade'
                  example: cidade
                cep:
                  type: string
                  description: '[Opcional] CEP'
                  example: cep
                site:
                  type: string
                  description: '[Opcional] Site'
                  example: site
                email:
                  type: string
                  description: '[Opcional] E-Mail'
                  example: email
                mensagem:
                  type: string
                  description: '[Opcional] Mensagem'
                  example: mensagem
                plano:
                  type: string
                  description: '[Opcional] Plano Escolhido'
                  example: plano
                rodar_lote:
                  type: string
                  description: >-
                    [Opcional] Alterar status do lote para RODANDO (Y ou N) -
                    default: Y
                  example: rodar_lote
              required:
                - lote
                - nome
                - foneres
                - fonecel
                - fonecom
                - codigo
                - data_retorno
                - usuario_retorno
                - origem
                - midia
                - chave
                - cliente
                - cidade
                - cep
                - site
                - email
                - mensagem
                - plano
                - rodar_lote
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
components:
  securitySchemes:
    ApiToken:
      type: apiKey
      in: header
      name: Authorization
      description: >-
        Token gerado em IPBoX > API > Token. Aceita o token puro, ou com prefixo
        `Bearer ` / `Basic `.

````