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

# importMailing

> <h2>Importa no lote especificado os prospects contidos no arquivo csv enviado. Os prospects existentes são apagados quando uma nova importação é feita.</h2>

Formato CSV:

```
id_contato_crm;nome_cliente;ddd1;telefone1;ddd2;telefone2;ddd3;telefone3;ddd4;telefone4;ddd5;telefone5

 ```

  
Exemplo CSV (p/ o layout padrão):

```
      682181526;LUIZ OLIVEIRA ANDRADE;11;55678912;11;998345521;;;;;;
      468246710;DANIEL AUGUSTO DA SILVA;11;77635432;11;976883211;11;42336094;;;;

 ```

###### Response:

<table><tbody><tr><td><div>msg</div></td><td><div>Mensagem com o resultado da importação<br /><br />Exemplos:<br /><br />import ok = importação incluída na fila com sucesso<br /><br />import erro = importação não completada com erro<br /><br />cancelado = importação cancelada</div></td></tr><tr><td><div>id</div></td><td><div>Id da importação</div></td></tr></tbody></table>



## OpenAPI

````yaml /openapi.yaml post /ipbox/api/importMailing
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/importMailing:
    post:
      tags:
        - Prospects
      summary: importMailing
      description: >-
        <h2>Importa no lote especificado os prospects contidos no arquivo csv
        enviado. Os prospects existentes são apagados quando uma nova importação
        é feita.</h2>


        Formato CSV:


        ```

        id_contato_crm;nome_cliente;ddd1;telefone1;ddd2;telefone2;ddd3;telefone3;ddd4;telefone4;ddd5;telefone5

         ```

          
        Exemplo CSV (p/ o layout padrão):


        ```
              682181526;LUIZ OLIVEIRA ANDRADE;11;55678912;11;998345521;;;;;;
              468246710;DANIEL AUGUSTO DA SILVA;11;77635432;11;976883211;11;42336094;;;;

         ```

        ###### Response:


        <table><tbody><tr><td><div>msg</div></td><td><div>Mensagem com o
        resultado da importação<br /><br />Exemplos:<br /><br />import ok =
        importação incluída na fila com sucesso<br /><br />import erro =
        importação não completada com erro<br /><br />cancelado = importação
        cancelada</div></td></tr><tr><td><div>id</div></td><td><div>Id da
        importação</div></td></tr></tbody></table>
      parameters:
        - name: Authorization
          in: header
          schema:
            type: string
          example: '{{token}}'
        - name: Content-Type
          in: header
          schema:
            type: string
          example: multipart/form-data
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                arqCsv:
                  type: string
                  description: Arquivo csv em anexo
                  example: null
                lote_id:
                  type: string
                  description: Id do Lote
                  example: lote_id
                higienizar:
                  type: string
                  description: 'Valores possíveis: Y ou N (default: N)'
                  example: higienizar
              required:
                - arqCsv
                - lote_id
      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 `.

````